[cmd/mdatagen] Expose resource_attributes option in user settings (o…

…pen-telemetry#17967)

Change constructor of MetricsBuilder from MetricsSettings to MetricsBuilderConfig, and wrap MetricsSettings and ResourceAttributesSettings with such.

This change exposes resource_attributes option in the user config which can be used to enable/disable particular resource_attributes.

Co-authored-by: Dmitrii Anoshin <[email protected]>

.chloggen/metrics_builder_constructor_ms_to_mbc.yaml

@@ -0,0 +1,20 @@
+# 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: mdatagen
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Turn on the ability to enable/disable resource attributes by embedding MetricsSettings and ResourceAttributesSettings into all scraping receivers as MetricsBuilderConfig
+
+# One or more tracking issues related to the change
+issues: [16373]
+
+# (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: |
+ Currently, the only way to add configurative functionality to mdatagen is by using a bunch of WithResourceAttributesSettings options to the constructor.
+ This PR changes the first argument to the NewMetricsBuilder constructor to be of type MetricsBuilderConfig,
+ which is a new class that wraps both MetricsSettings and ResourceAttributesSettings, and may be (hopefully) easily extended with more
+ configuration in the future.

cmd/mdatagen/internal/metadata/testdata/config.yaml

@@ -1,15 +1,31 @@
 default:
-all_metrics:
- default.metric:
- enabled: true
- default.metric.to_be_removed:
- enabled: true
- optional.metric:
- enabled: true
-no_metrics:
- default.metric:
- enabled: false
- default.metric.to_be_removed:
- enabled: false
- optional.metric:
- enabled: false
+all_set:
+ metrics:
+ default.metric:
+ enabled: true
+ default.metric.to_be_removed:
+ enabled: true
+ optional.metric:
+ enabled: true
+ resource_attributes:
+ optional.resource.attr:
+ enabled: true
+ string.enum.resource.attr:
+ enabled: true
+ string.resource.attr:
+ enabled: true
+none_set:
+ metrics:
+ default.metric:
+ enabled: false
+ default.metric.to_be_removed:
+ enabled: false
+ optional.metric:
+ enabled: false
+ resource_attributes:
+ optional.resource.attr:
+ enabled: false
+ string.enum.resource.attr:
+ enabled: false
+ string.resource.attr:
+ enabled: false

cmd/mdatagen/main_test.go

@@ -100,7 +100,7 @@ func Test_run(t *testing.T) {
 
 // TestGenerated verifies that the internal/metadata API is generated correctly.
 func TestGenerated(t *testing.T) {
- mb := md.NewMetricsBuilder(md.DefaultMetricsSettings(), receivertest.NewNopCreateSettings())
+ mb := md.NewMetricsBuilder(md.DefaultMetricsBuilderConfig(), receivertest.NewNopCreateSettings())
  m := mb.Emit()
  require.Equal(t, 0, m.ResourceMetrics().Len())
 }

cmd/mdatagen/templates/metrics.go.tmpl

@@ -58,21 +58,8 @@ func DefaultMetricsSettings() MetricsSettings {
 // ResourceAttributeSettings provides common settings for a particular metric.
 type ResourceAttributeSettings struct {
  Enabled bool `mapstructure:"enabled"`
-
- enabledProvidedByUser bool
 }
 
-func (ras *ResourceAttributeSettings) Unmarshal(parser *confmap.Conf) error {
- if parser == nil {
- return nil
- }
- err := parser.Unmarshal(ras, confmap.WithErrorUnused())
- if err != nil {
- return err
- }
- ras.enabledProvidedByUser = parser.IsSet("enabled")
- return nil
-}
 
 // ResourceAttributesSettings provides settings for {{ .Name }} metrics.
 type ResourceAttributesSettings struct {
@@ -193,6 +180,12 @@ func newMetric{{ $name.Render }}(settings MetricSettings) metric{{ $name.Render
 
 {{ end -}}
 
+// MetricsBuilderConfig is a structural subset of an otherwise 1-1 copy of metadata.yaml
+type MetricsBuilderConfig struct {
+ Metrics MetricsSettings `mapstructure:"metrics"`
+ ResourceAttributes ResourceAttributesSettings `mapstructure:"resource_attributes"`
+}
+
 // MetricsBuilder provides an interface for scrapers to report metrics while taking care of all the transformations
 // required to produce metric representation defined in metadata and user settings.
 type MetricsBuilder struct {
@@ -216,27 +209,35 @@ func WithStartTime(startTime pcommon.Timestamp) metricBuilderOption {
  mb.startTime = startTime
  }
 }
-// WithResourceAttributesSettings sets ResourceAttributeSettings on the metrics builder.
-func WithResourceAttributesSettings(ras ResourceAttributesSettings) metricBuilderOption {
- return func(mb *MetricsBuilder) {
- mb.resourceAttributesSettings = ras
+
+func DefaultMetricsBuilderConfig() MetricsBuilderConfig {
+ return MetricsBuilderConfig {
+ Metrics: DefaultMetricsSettings(),
+ ResourceAttributes: DefaultResourceAttributesSettings(),
+ }
+}
+
+func NewMetricsBuilderConfig(ms MetricsSettings, ras ResourceAttributesSettings) MetricsBuilderConfig {
+ return MetricsBuilderConfig {
+ Metrics: ms,
+ ResourceAttributes: ras,
  }
 }
 
-func NewMetricsBuilder(ms MetricsSettings, settings receiver.CreateSettings, options ...metricBuilderOption) *MetricsBuilder {
+func NewMetricsBuilder(mbc MetricsBuilderConfig, settings receiver.CreateSettings, options ...metricBuilderOption) *MetricsBuilder {
  {{- range $name, $metric := .Metrics }}
  {{- if $metric.Warnings.IfEnabled }}
- if ms.{{ $name.Render }}.Enabled {
+ if mbc.Metrics.{{ $name.Render }}.Enabled {
  settings.Logger.Warn("[WARNING] `{{ $name }}` should not be enabled: {{ $metric.Warnings.IfEnabled }}")
  }
  {{- end }}
  {{- if $metric.Warnings.IfEnabledNotSet }}
- if !ms.{{ $name.Render }}.enabledSetByUser {
+ if !mbc.Metrics.{{ $name.Render }}.enabledSetByUser {
  settings.Logger.Warn("[WARNING] Please set `enabled` field explicitly for `{{ $name }}`: {{ $metric.Warnings.IfEnabledNotSet }}")
  }
  {{- end }}
  {{- if $metric.Warnings.IfConfigured }}
- if ms.{{ $name.Render }}.enabledSetByUser {
+ if mbc.Metrics.{{ $name.Render }}.enabledSetByUser {
  settings.Logger.Warn("[WARNING] `{{ $name }}` should not be configured: {{ $metric.Warnings.IfConfigured }}")
  }
  {{- end }}
@@ -245,9 +246,9 @@ func NewMetricsBuilder(ms MetricsSettings, settings receiver.CreateSettings, opt
  startTime: pcommon.NewTimestampFromTime(time.Now()),
  metricsBuffer: pmetric.NewMetrics(),
  buildInfo: settings.BuildInfo,
- resourceAttributesSettings: DefaultResourceAttributesSettings(),
+ resourceAttributesSettings: mbc.ResourceAttributes,
  {{- range $name, $metric := .Metrics }}
- metric{{ $name.Render }}: newMetric{{ $name.Render }}(ms.{{ $name.Render }}),
+ metric{{ $name.Render }}: newMetric{{ $name.Render }}(mbc.Metrics.{{ $name.Render }}),
  {{- end }}
  }
  for _, op := range options {