Merge pull request #202 from dynatrace-oss-contrib/feat/add_display_name

Add display_name field

crates/weaver_forge/src/registry.rs

@@ -98,10 +98,12 @@ pub struct ResolvedGroup {
     /// The name of the event. If not specified, the prefix is used.
     /// If prefix is empty (or unspecified), name is required.
     pub name: Option<String>,
-
     /// The lineage of the group.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub lineage: Option<GroupLineage>,
+    /// The readable name for attribute groups used when generating registry tables.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub display_name: Option<String>,
 }
 
 impl ResolvedGroup {
@@ -153,6 +155,7 @@ impl ResolvedGroup {
             unit: group.unit.clone(),
             name: group.name.clone(),
             lineage,
+            display_name: group.display_name.clone(),
         })
     }
 }
@@ -211,6 +214,7 @@ impl ResolvedRegistry {
                     unit: group.unit.clone(),
                     name: group.name.clone(),
                     lineage,
+                    display_name: group.display_name.clone(),
                 }
             })
             .collect();

crates/weaver_resolved_schema/src/registry.rs

@@ -120,10 +120,12 @@ pub struct Group {
     /// If prefix is empty (or unspecified), name is required.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub name: Option<String>,
-
     /// The lineage of the group.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub lineage: Option<GroupLineage>,
+    /// The readable name for attribute groups used when generating registry tables.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub display_name: Option<String>,
 }
 
 /// Common statistics for a group.

crates/weaver_resolver/src/registry.rs

@@ -264,6 +264,7 @@ fn group_from_spec(group: GroupSpecWithProvenance) -> UnresolvedGroup {
             unit: group.spec.unit,
             name: group.spec.name,
             lineage: Some(GroupLineage::new(&group.provenance)),
+            display_name: group.spec.display_name,
         },
         attributes: attrs,
         provenance: group.provenance,

crates/weaver_semconv/data/faas-common.yaml

@@ -2,6 +2,7 @@ groups:
   - id: attributes.faas.common
     type: attribute_group
     brief: "Describes FaaS attributes."
+    display_name: "FaaS Attributes"
     prefix: faas
     attributes:
       - id: trigger

crates/weaver_semconv/src/group.rs

@@ -84,6 +84,8 @@ pub struct GroupSpec {
     /// The name of the event. If not specified, the prefix is used.
     /// If prefix is empty (or unspecified), name is required.
     pub name: Option<String>,
+    /// The readable name for attribute groups used when generating registry tables.
+    pub display_name: Option<String>,
 }
 
 impl GroupSpec {
@@ -331,6 +333,7 @@ mod tests {
             instrument: None,
             unit: None,
             name: None,
+            display_name: None,
         };
         assert!(group.validate("<test>").is_ok());
 
@@ -430,6 +433,7 @@ mod tests {
             instrument: None,
             unit: None,
             name: None,
+            display_name: None,
         };
         assert!(group.validate("<test>").is_ok());
 

crates/weaver_semconv/src/registry.rs

@@ -260,6 +260,7 @@ mod tests {
                         deprecated: None,
                         events: vec![],
                         name: None,
+                        display_name: Some("Group 1".to_owned()),
                     }],
                 },
             ),
@@ -283,6 +284,7 @@ mod tests {
                         deprecated: None,
                         events: vec![],
                         name: None,
+                        display_name: Some("Group 2".to_owned()),
                     }],
                 },
             ),