Clarify purpose of boolean_attr2

open-telemetry · Sep 16, 2024 · 4d9f1d6 · 4d9f1d6
1 parent 08f8486
commit 4d9f1d6
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/cmd/mdatagen/internal/samplereceiver/documentation.md b/cmd/mdatagen/internal/samplereceiver/documentation.md
@@ -84,7 +84,7 @@ metrics:
 | ---- | ----------- | ------ |
 | string_attr | Attribute with any string value. | Any Str |
 | boolean_attr | Attribute with a boolean value. | Any Bool |
-| boolean_attr2 | Another boolean attribute, with a different test value. | Any Bool |
+| boolean_attr2 | Another attribute with a boolean value. | Any Bool |
 
 ### optional.metric.empty_unit
 

diff --git a/cmd/mdatagen/internal/samplereceiver/metadata.yaml b/cmd/mdatagen/internal/samplereceiver/metadata.yaml
@@ -86,8 +86,10 @@ attributes:
     description: Attribute with a boolean value.
     type: bool
 
+  # This 2nd boolean attribute allows us to test both values for boolean attributes,
+  # as test values are based on the parity of the attribute name length.
   boolean_attr2:
-    description: Another boolean attribute, with a different test value.
+    description: Another attribute with a boolean value.
     type: bool
 
   slice_attr:

diff --git a/cmd/mdatagen/loader_test.go b/cmd/mdatagen/loader_test.go
@@ -150,7 +150,7 @@ func TestLoadMetadata(t *testing.T) {
 						FullName: "boolean_attr",
 					},
 					"boolean_attr2": {
-						Description: "Another boolean attribute, with a different test value.",
+						Description: "Another attribute with a boolean value.",
 						Type: ValueType{
 							ValueType: pcommon.ValueTypeBool,
 						},