Rename _metadata to metadata for elastic purposes (#138)

Rename _metadata to metadata for elastic purposes Co-authored-by: Russ Cam <[email protected]>
elastic · Jun 1, 2021 · 4bec7e6 · 4bec7e6
1 parent a944863
commit 4bec7e6
Show file tree

Hide file tree

Showing 8 changed files with 9 additions and 9 deletions.
diff --git a/examples/aspnetcore-with-serilog/README.md b/examples/aspnetcore-with-serilog/README.md
@@ -63,7 +63,7 @@ On run, the console will show various events written in ECS format, an example g
   "@timestamp": "2020-03-13T14:17:18.4976763+11:00",
   "log.level": "Information",
   "message": "Request finished in 353.60360000000003ms 200 application/json; charset=utf-8",
-  "_metadata": {
+  "metadata": {
     "message_template": "{HostingRequestFinishedLog:l}",
     "elapsed_milliseconds": 353.60360000000003,
     "status_code": 200,

diff --git a/src/Elastic.CommonSchema.NLog/README.md b/src/Elastic.CommonSchema.NLog/README.md
@@ -101,7 +101,7 @@ An example of the output is given below:
    "@timestamp":"2020-02-20T16:07:06.7109766+11:00",
    "log.level":"Info",
    "message":"Info \"X\" 2.2",
-   "_metadata":{
+   "metadata":{
       "value_x":"X",
       "some_y":2.2
    },

diff --git a/src/Elastic.CommonSchema/README.md b/src/Elastic.CommonSchema/README.md
@@ -181,7 +181,7 @@ The C# `Base` type includes a property called `Metadata` with the signature:
 /// <summary>
 /// Container for additional metadata against this event.
 /// </summary>
-[DataMember(Name = "_metadata")]
+[DataMember(Name = "metadata")]
 public IDictionary<string, object> Metadata { get; set; }
 ```
 

diff --git a/src/Elastic.CommonSchema/Serialization/BaseJsonFormatter.Generated.cs b/src/Elastic.CommonSchema/Serialization/BaseJsonFormatter.Generated.cs
@@ -32,7 +32,7 @@ ref string loglevel
 				"@timestamp" => ReadDateTime(ref reader, ref @timestamp),
 				"log.level" => ReadString(ref reader, ref loglevel),
 				"message" => ReadProp<string>(ref reader, "message", ecsEvent, (b, v) => b.Message = v),
-				"_metadata" => ReadProp<IDictionary<string, object>>(ref reader, "_metadata", ecsEvent, (b, v) => b.Metadata = v),
+				"metadata" => ReadProp<IDictionary<string, object>>(ref reader, "metadata", ecsEvent, (b, v) => b.Metadata = v),
 				"tags" => ReadProp<string[]>(ref reader, "tags", ecsEvent, (b, v) => b.Tags = v),
 				"labels" => ReadProp<IDictionary<string, object>>(ref reader, "labels", ecsEvent, (b, v) => b.Labels = v),
 				"trace" => ReadProp<Trace>(ref reader, "trace", ecsEvent, (b, v) => b.Trace = v),
@@ -98,7 +98,7 @@ public override void Write(Utf8JsonWriter writer, TBase value, JsonSerializerOpt
 			WriteTimestamp(writer, value);
 			WriteLogLevel(writer, value);
 			WriteMessage(writer, value);
-			WriteProp(writer, "_metadata", value.Metadata);
+			WriteProp(writer, "metadata", value.Metadata);
 			WriteProp(writer, "tags", value.Tags);
 			WriteProp(writer, "labels", value.Labels);
 			// Complex types

diff --git a/src/Elastic.CommonSchema/Types.Generated.cs b/src/Elastic.CommonSchema/Types.Generated.cs
@@ -41,7 +41,7 @@ public partial class Base
 		/// <summary>
 		/// Container for additional metadata against this event.
 		/// </summary>
-		[DataMember(Name = "_metadata")]
+		[DataMember(Name = "metadata")]
 		public IDictionary<string, object> Metadata { get; set; }
 
 		/// <summary>

diff --git a/src/Generator/Schema/YamlSpecification.cs b/src/Generator/Schema/YamlSpecification.cs
@@ -57,7 +57,7 @@ public IEnumerable<Tuple<string, Field>> BaseFieldsOrdered
 					// HACK in the log.level
 					Tuple.Create("WriteLogLevel", new Field { Name = LogLevelFieldName, Schema = baseRootObject, FlatName = LogLevelFieldName }),
 					Tuple.Create("WriteMessage", baseRootObject.Fields.Single(f => f.Key == MessageFieldName).Value),
-					Tuple.Create("WriteProp", new Field { Name = "_metadata", Schema = baseRootObject, FlatName = "_metadata" })
+					Tuple.Create("WriteProp", new Field { Name = "metadata", Schema = baseRootObject, FlatName = "metadata" })
 				};
 
 				list.AddRange(baseRootObject.GetFieldsFlat()

diff --git a/src/Generator/SchemaExtensionMethods.cs b/src/Generator/SchemaExtensionMethods.cs
@@ -51,7 +51,7 @@ public static string ClrType(this Field value)
 			if (value.FlatName == "labels") return "IDictionary<string, object>";
 
 			// C# custom property
-			if (value.Name == "_metadata") return "IDictionary<string, object>";
+			if (value.Name == "metadata") return "IDictionary<string, object>";
 
 			var tipe = "";
 			switch (value.Type)

diff --git a/src/Generator/Views/Types.Generated.cshtml b/src/Generator/Views/Types.Generated.cshtml
@@ -47,7 +47,7 @@ namespace Elastic.CommonSchema
 		/// <summary>
 		/// Container for additional metadata against this event.
 		/// </summary>
-		[DataMember(Name = "_metadata")]
+		[DataMember(Name = "metadata")]
 		public @Raw("IDictionary<string, object>") Metadata { get; set; }
 
 @foreach (var schema in Model.NonBaseYamlSchemas())