[mdatagen] Add support of enum field in resource attributes (open-tel…

…emetry#16464)
shalper2 · Dec 6, 2022 · 0d8dfca · 0d8dfca
1 parent 0285e87
commit 0d8dfca
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 21 deletions.
diff --git a/.chloggen/mdatagen-enum-resource-attrs.yaml b/.chloggen/mdatagen-enum-resource-attrs.yaml
@@ -0,0 +1,17 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: cmd/mdatagen
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Add support for `resource_attributes::enum` field
+
+# One or more tracking issues related to the change
+issues: [16464]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext: |
+  `resource_attributes::enum` values in metadata.yaml are now properly supported in metrics builder developer interface.
diff --git a/cmd/mdatagen/metrics.tmpl b/cmd/mdatagen/metrics.tmpl
@@ -213,6 +213,12 @@ func (mb *MetricsBuilder) updateCapacity(rm pmetric.ResourceMetrics) {
 type ResourceMetricsOption func(pmetric.ResourceMetrics)
 
 {{- range $name, $attr := .ResourceAttributes }}
+{{- range $attr.Enum }}
+// With{{ $name.Render }}{{ . | publicVar }} sets "{{ $name }}={{ . }}" attribute for current resource.
+func With{{ $name.Render }}{{ . | publicVar }}(rm pmetric.ResourceMetrics) {
+	rm.Resource().Attributes().PutStr("{{ attributeKey $name}}", "{{ . }}")
+}
+{{- else }}
 // With{{ $name.Render }} sets provided value as "{{ $name }}" attribute for current resource.
 func With{{ $name.Render }}(val {{ $attr.Type.Primitive }}) ResourceMetricsOption {
 	return func(rm pmetric.ResourceMetrics) {
@@ -223,6 +229,7 @@ func With{{ $name.Render }}(val {{ $attr.Type.Primitive }}) ResourceMetricsOptio
 		{{- end }}
 	}
 }
+{{- end }}
 {{ end }}
 
 // WithStartTimeOverride overrides start time for all the resource metrics data points.

diff --git a/cmd/mdatagen/metrics_test.tmpl b/cmd/mdatagen/metrics_test.tmpl
@@ -58,11 +58,12 @@ func TestAllMetrics(t *testing.T) {
 	{{- end }}
 
 	metrics := mb.Emit(
-	{{- $sep := "" }}
-	{{- range $name, $info := .ResourceAttributes -}}
-	{{ $sep }}With{{ $name.Render }}({{- if $info.Enum }}Attribute{{ $name.Render }}(1){{ else }}{{ $info.Type.TestValue }}{{ end }})
-	{{- $sep = ", " }}
-	{{- end -}}
+		{{- $sep := "" }}
+		{{- range $name, $info := .ResourceAttributes -}}
+			{{- $sep }}With{{ $name.Render }}
+			{{- if $info.Enum }}{{ index $info.Enum 0 | publicVar }}{{ else }}({{- $info.Type.TestValue }}){{ end }}
+			{{- $sep = ", " }}
+		{{- end -}}
 	)
 
 	assert.Equal(t, 1, metrics.ResourceMetrics().Len())

diff --git a/receiver/flinkmetricsreceiver/internal/metadata/generated_metrics.go b/receiver/flinkmetricsreceiver/internal/metadata/generated_metrics.go
diff --git a/receiver/flinkmetricsreceiver/internal/metadata/generated_metrics_test.go b/receiver/flinkmetricsreceiver/internal/metadata/generated_metrics_test.go
diff --git a/receiver/flinkmetricsreceiver/metadata.yaml b/receiver/flinkmetricsreceiver/metadata.yaml
@@ -20,8 +20,7 @@ resource_attributes:
   flink.resource.type:
     description: The flink scope type in which a metric belongs to.
     type: string
-    # TODO: Add enum support to resource attributes
-    # enum: [ jobmanager, taskmanager ]
+    enum: [ jobmanager, taskmanager ]
 
 attributes:
   operator_name:

diff --git a/receiver/flinkmetricsreceiver/process.go b/receiver/flinkmetricsreceiver/process.go
@@ -76,7 +76,7 @@ func (s *flinkmetricsScraper) processJobmanagerMetrics(now pcommon.Timestamp, jo
 	}
 	s.mb.EmitForResource(
 		metadata.WithHostName(jobmanagerMetrics.Host),
-		metadata.WithFlinkResourceType("jobmanager"),
+		metadata.WithFlinkResourceTypeJobmanager,
 	)
 }
 
@@ -135,7 +135,7 @@ func (s *flinkmetricsScraper) processTaskmanagerMetrics(now pcommon.Timestamp, t
 		s.mb.EmitForResource(
 			metadata.WithHostName(taskmanagerMetrics.Host),
 			metadata.WithFlinkTaskmanagerID(taskmanagerMetrics.TaskmanagerID),
-			metadata.WithFlinkResourceType("taskmanager"),
+			metadata.WithFlinkResourceTypeTaskmanager,
 		)
 	}
 }

diff --git a/receiver/nsxtreceiver/metadata.yaml b/receiver/nsxtreceiver/metadata.yaml
@@ -10,11 +10,6 @@ resource_attributes:
   nsxt.node.type:
     description: The type of NSX Node.
     type: string
-    # TODO: Add support for enum in resource attributes
-    # enum:
-    #   - manager
-    #   - host
-    #   - edge
   device.id:
     description: The name of the network interface.
     type: string