[cmd/mdatagen] add field for configuring individual metric interval

.chloggen/configure-interval-on-metric-level.yaml

@@ -0,0 +1,26 @@
+# Use this changelog template to create an entry for release notes.
+
+# 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. otlpreceiver)
+component: cmd/mdatagen
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: add option to specify the scrape interval for individual metrics. 
+
+# One or more tracking issues or pull requests related to the change
+issues: [12317]
+
+# (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: |
+  This is mainly useful for database related receivers. Metrics for databases are mainly retrieved via sql queries and some could be resource-intensive.
+
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: []

cmd/mdatagen/internal/loader_test.go

@@ -239,6 +239,19 @@ func TestLoadMetadata(t *testing.T) {
 						},
 						Attributes: []AttributeName{"string_attr", "overridden_int_attr", "enum_attr", "slice_attr", "map_attr"},
 					},
+					"metric.with_interval": {
+						Enabled:     true,
+						Interval:    15,
+						Description: "Monotonic cumulative sum int metric with string input_type enabled by default and contains a customized interval of 15 seconds.",
+						Unit:        strPtr("s"),
+						Sum: &Sum{
+							MetricValueType:        MetricValueType{pmetric.NumberDataPointValueTypeInt},
+							MetricInputType:        MetricInputType{InputType: "string"},
+							AggregationTemporality: AggregationTemporality{Aggregation: pmetric.AggregationTemporalityCumulative},
+							Mono:                   Mono{Monotonic: true},
+						},
+						Attributes: []AttributeName{"string_attr", "overridden_int_attr", "enum_attr", "slice_attr", "map_attr"},
+					},
 				},
 				Telemetry: Telemetry{
 					Metrics: map[MetricName]Metric{

cmd/mdatagen/internal/metric.go

@@ -59,6 +59,8 @@ type Metric struct {
 
 	// Attributes is the list of attributes that the metric emits.
 	Attributes []AttributeName `mapstructure:"attributes"`
+
+	Interval uint64 `mapstructure:"interval"`
 }
 
 type Stability struct {

cmd/mdatagen/internal/samplereceiver/documentation.md

@@ -60,6 +60,24 @@ Monotonic cumulative sum int metric with string input_type enabled by default.
 | slice_attr | Attribute with a slice value. | Any Slice |
 | map_attr | Attribute with a map value. | Any Map |
 
+### metric.with_interval
+
+Monotonic cumulative sum int metric with string input_type enabled by default and contains a customized interval of 15 seconds.
+
+| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
+| ---- | ----------- | ---------- | ----------------------- | --------- |
+| s | Sum | Int | Cumulative | true |
+
+#### Attributes
+
+| Name | Description | Values |
+| ---- | ----------- | ------ |
+| string_attr | Attribute with any string value. | Any Str |
+| state | Integer attribute with overridden name. | Any Int |
+| enum_attr | Attribute with a known set of string values. | Str: ``red``, ``green``, ``blue`` |
+| slice_attr | Attribute with a slice value. | Any Slice |
+| map_attr | Attribute with a map value. | Any Map |
+
 ## Optional Metrics
 
 The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration:

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

@@ -7,6 +7,9 @@ all_set:
       enabled: true
     metric.input_type:
       enabled: true
+    metric.with_interval:
+      enabled: true
+      interval: 15
     optional.metric:
       enabled: true
     optional.metric.empty_unit:
@@ -36,6 +39,8 @@ none_set:
       enabled: false
     metric.input_type:
       enabled: false
+    metric.with_interval:
+      enabled: false
     optional.metric:
       enabled: false
     optional.metric.empty_unit:

cmd/mdatagen/internal/samplereceiver/metadata.yaml

@@ -157,6 +157,17 @@ metrics:
       aggregation_temporality: cumulative
     attributes: [ string_attr, overridden_int_attr, enum_attr, slice_attr, map_attr ]
 
+  metric.with_interval:
+    enabled: true
+    description: Monotonic cumulative sum int metric with string input_type enabled by default and contains a customized interval of 15 seconds.
+    unit: s
+    interval: 15
+    sum:
+      value_type: int
+      input_type: string
+      monotonic: true
+      aggregation_temporality: cumulative
+    attributes: [ string_attr, overridden_int_attr, enum_attr, slice_attr, map_attr ]
 telemetry:
   metrics:
     batch_size_trigger_send:

cmd/mdatagen/internal/templates/config.go.tmpl

@@ -13,7 +13,12 @@ import (
 // MetricConfig provides common config for a particular metric.
 type MetricConfig struct {
 	Enabled bool `mapstructure:"enabled"`
-
+	{{- range $_, $metric := .Metrics }}
+	{{- if ne $metric.Interval 0 }}
+	Interval uint64 `mapstructure:"interval"`
+	{{- break }}
+	{{- end }}
+	{{- end }}
 	enabledSetByUser bool
 }
 
@@ -41,6 +46,9 @@ func DefaultMetricsConfig() MetricsConfig {
 		{{- range $name, $metric := .Metrics }}
 		{{ $name.Render }}: MetricConfig{
 			Enabled: {{ $metric.Enabled }},
+			{{- if ne $metric.Interval  0 }}
+			Interval: {{ $metric.Interval }},
+			{{- end }}
 		},
 		{{- end }}
 	}

cmd/mdatagen/internal/templates/config_test.go.tmpl

@@ -26,8 +26,12 @@ func TestMetricsBuilderConfig(t *testing.T) {
 			name: "all_set",
 			want: MetricsBuilderConfig{
 				Metrics: MetricsConfig{
-					{{- range $name, $_ := .Metrics }}
-					{{ $name.Render }}: MetricConfig{Enabled: true},
+					{{- range $name, $metric := .Metrics }}
+                    {{- if ne $metric.Interval 0 }}
+					{{ $name.Render }}: MetricConfig{Enabled: true, Interval: {{ $metric.Interval }} },
+					{{- else }}
+                    {{ $name.Render }}: MetricConfig{Enabled: true},
+					{{- end }}
 					{{- end }}
 				},
 				{{- if .ResourceAttributes }}
@@ -43,8 +47,12 @@ func TestMetricsBuilderConfig(t *testing.T) {
 			name: "none_set",
 			want: MetricsBuilderConfig{
 				Metrics: MetricsConfig{
-					{{- range $name, $_ := .Metrics }}
-					{{ $name.Render }}: MetricConfig{Enabled: false},
+					{{- range $name, $metric := .Metrics }}
+                    {{- if ne $metric.Interval 0 }}
+					{{ $name.Render }}: MetricConfig{Enabled: false, Interval: {{ $metric.Interval }} },
+					{{- else }}
+                    {{ $name.Render }}: MetricConfig{Enabled: false},
+					{{- end }}
 					{{- end }}
 				},
 				{{- if .ResourceAttributes }}

cmd/mdatagen/internal/templates/testdata/config.yaml.tmpl

@@ -2,9 +2,12 @@ default:
 all_set:
   {{- if .Metrics }}
   metrics:
-    {{- range $name, $_ := .Metrics }}
+    {{- range $name, $v := .Metrics }}
     {{ $name }}:
       enabled: true
+    {{- if $v.Interval }}
+      interval: {{ $v.Interval }}
+    {{- end }}
     {{- end }}
   {{- end }}
   {{- if .ResourceAttributes }}