diff --git a/.chloggen/mdatagen-flatten-metric-stability.yaml b/.chloggen/mdatagen-flatten-metric-stability.yaml new file mode 100644 index 00000000000..9e002c41812 --- /dev/null +++ b/.chloggen/mdatagen-flatten-metric-stability.yaml @@ -0,0 +1,25 @@ +# Use this changelog template to create an entry for release notes. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: breaking + +# The name of the component, or a single word describing the area of concern, (e.g. receiver/otlp) +component: cmd/mdatagen + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Flatten the metric stability field + +# One or more tracking issues or pull requests related to the change +issues: [14113] + +# (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: So we better match the weaver schema. Additional deprecation data can be set within the `deprecated` field. + +# 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: [api] diff --git a/cmd/mdatagen/internal/loader_test.go b/cmd/mdatagen/internal/loader_test.go index b84b59c8e55..a74ef3233b9 100644 --- a/cmd/mdatagen/internal/loader_test.go +++ b/cmd/mdatagen/internal/loader_test.go @@ -251,7 +251,7 @@ func TestLoadMetadata(t *testing.T) { Enabled: true, Description: "Monotonic cumulative sum int metric enabled by default.", ExtendedDocumentation: "The metric will be become optional soon.", - Stability: Stability{Level: component.StabilityLevelDevelopment}, + Stability: component.StabilityLevelDevelopment, Warnings: Warnings{ IfEnabledNotSet: "This metric will be disabled by default soon.", }, @@ -268,7 +268,7 @@ func TestLoadMetadata(t *testing.T) { Signal: Signal{ Enabled: true, Description: "Metric for testing spacial reaggregation", - Stability: Stability{Level: component.StabilityLevelBeta}, + Stability: component.StabilityLevelBeta, Attributes: []AttributeName{"string_attr", "boolean_attr"}, }, Unit: strPtr("1"), @@ -279,7 +279,7 @@ func TestLoadMetadata(t *testing.T) { "system.cpu.time": { Signal: Signal{ Enabled: true, - Stability: Stability{Level: component.StabilityLevelBeta}, + Stability: component.StabilityLevelBeta, SemanticConvention: &SemanticConvention{SemanticConventionRef: "https://github.com/open-telemetry/semantic-conventions/blob/v1.38.0/docs/system/system-metrics.md#metric-systemcputime"}, Description: "Monotonic cumulative sum int metric enabled by default.", ExtendedDocumentation: "The metric will be become optional soon.", @@ -295,7 +295,7 @@ func TestLoadMetadata(t *testing.T) { Signal: Signal{ Enabled: false, Description: "[DEPRECATED] Gauge double metric disabled by default.", - Stability: Stability{Level: component.StabilityLevelDeprecated}, + Stability: component.StabilityLevelDeprecated, Warnings: Warnings{ IfConfigured: "This metric is deprecated and will be removed soon.", }, @@ -310,7 +310,7 @@ func TestLoadMetadata(t *testing.T) { Signal: Signal{ Enabled: false, Description: "[DEPRECATED] Gauge double metric disabled by default.", - Stability: Stability{Level: component.StabilityLevelDeprecated}, + Stability: component.StabilityLevelDeprecated, Warnings: Warnings{ IfConfigured: "This metric is deprecated and will be removed soon.", }, @@ -327,7 +327,7 @@ func TestLoadMetadata(t *testing.T) { Enabled: true, Description: "[DEPRECATED] Non-monotonic delta sum double metric enabled by default.", ExtendedDocumentation: "The metric will be removed soon.", - Stability: Stability{Level: component.StabilityLevelDeprecated}, + Stability: component.StabilityLevelDeprecated, Warnings: Warnings{ IfEnabled: "This metric is deprecated and will be removed soon.", }, @@ -343,7 +343,7 @@ func TestLoadMetadata(t *testing.T) { Signal: Signal{ Enabled: true, Description: "Monotonic cumulative sum int metric with string input_type enabled by default.", - Stability: Stability{Level: component.StabilityLevelDevelopment}, + Stability: component.StabilityLevelDevelopment, Attributes: []AttributeName{"string_attr", "overridden_int_attr", "enum_attr", "slice_attr", "map_attr"}, }, Unit: strPtr("s"), @@ -394,7 +394,7 @@ func TestLoadMetadata(t *testing.T) { "batch_size_trigger_send": { Signal: Signal{ Enabled: true, - Stability: Stability{Level: component.StabilityLevelDeprecated, From: "v0.110.0"}, + Stability: component.StabilityLevelDeprecated, Description: "Number of times the batch was sent due to a size trigger", }, Unit: strPtr("{times}"), @@ -406,7 +406,7 @@ func TestLoadMetadata(t *testing.T) { "request_duration": { Signal: Signal{ Enabled: true, - Stability: Stability{Level: component.StabilityLevelAlpha}, + Stability: component.StabilityLevelAlpha, Description: "Duration of request", }, Unit: strPtr("s"), @@ -418,7 +418,7 @@ func TestLoadMetadata(t *testing.T) { "process_runtime_total_alloc_bytes": { Signal: Signal{ Enabled: true, - Stability: Stability{Level: component.StabilityLevelStable}, + Stability: component.StabilityLevelStable, Description: "Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc')", }, Unit: strPtr("By"), @@ -433,7 +433,7 @@ func TestLoadMetadata(t *testing.T) { "queue_length": { Signal: Signal{ Enabled: true, - Stability: Stability{Level: component.StabilityLevelAlpha}, + Stability: component.StabilityLevelAlpha, Description: "This metric is optional and therefore not initialized in NewTelemetryBuilder.", ExtendedDocumentation: "For example this metric only exists if feature A is enabled.", }, @@ -450,7 +450,7 @@ func TestLoadMetadata(t *testing.T) { Signal: Signal{ Enabled: true, Description: "Queue capacity - sync gauge example.", - Stability: Stability{Level: component.StabilityLevelDevelopment}, + Stability: component.StabilityLevelDevelopment, }, Unit: strPtr("{items}"), Gauge: &Gauge{ @@ -552,7 +552,7 @@ func TestLoadMetadata(t *testing.T) { { name: "testdata/invalid_metric_stability.yaml", want: Metadata{}, - wantErr: "decoding failed due to the following error(s):\n\n'metrics[default.metric]' decoding failed due to the following error(s):\n\n'stability' decoding failed due to the following error(s):\n\n'level' unsupported stability level: \"development42\"", + wantErr: "decoding failed due to the following error(s):\n\n'metrics[default.metric]' decoding failed due to the following error(s):\n\n'stability' unsupported stability level: \"development42\"", }, { name: "testdata/invalid_metric_semconvref.yaml", @@ -562,7 +562,7 @@ func TestLoadMetadata(t *testing.T) { { name: "testdata/no_metric_stability.yaml", want: Metadata{}, - wantErr: "decoding failed due to the following error(s):\n\n'metrics[default.metric]' decoding failed due to the following error(s):\n\n'stability' missing required field: `stability.level`", + wantErr: "metric \"default.metric\": missing required field: `stability.level`", }, { name: "testdata/~~this file doesn't exist~~.yaml", diff --git a/cmd/mdatagen/internal/metadata.go b/cmd/mdatagen/internal/metadata.go index f177de89f21..33d94290d75 100644 --- a/cmd/mdatagen/internal/metadata.go +++ b/cmd/mdatagen/internal/metadata.go @@ -11,6 +11,7 @@ import ( "strconv" "strings" + "go.opentelemetry.io/collector/component" "go.opentelemetry.io/collector/filter" "go.opentelemetry.io/collector/pdata/pcommon" ) @@ -528,7 +529,7 @@ type Signal struct { SemanticConvention *SemanticConvention `mapstructure:"semantic_convention"` // The stability level of the signal. - Stability Stability `mapstructure:"stability"` + Stability component.StabilityLevel `mapstructure:"stability"` // Extended documentation of the signal. If specified, this will be appended to the description used in generated documentation. ExtendedDocumentation string `mapstructure:"extended_documentation"` diff --git a/cmd/mdatagen/internal/metric.go b/cmd/mdatagen/internal/metric.go index cdba7d6d2e5..cb0f190ad29 100644 --- a/cmd/mdatagen/internal/metric.go +++ b/cmd/mdatagen/internal/metric.go @@ -50,29 +50,6 @@ type Metric struct { Prefix string `mapstructure:"prefix"` } -type Stability struct { - Level component.StabilityLevel `mapstructure:"level"` - From string `mapstructure:"from"` -} - -func (s Stability) String() string { - if s.Level == component.StabilityLevelUndefined || - s.Level == component.StabilityLevelStable { - return "" - } - if s.From != "" { - return fmt.Sprintf(" [%s since %s]", s.Level.String(), s.From) - } - return fmt.Sprintf(" [%s]", s.Level.String()) -} - -func (s *Stability) Unmarshal(parser *confmap.Conf) error { - if !parser.IsSet("level") { - return errors.New("missing required field: `stability.level`") - } - return parser.Unmarshal(s) -} - func (m *Metric) validate(metricName MetricName, semConvVersion string) error { var errs error if m.Sum == nil && m.Gauge == nil && m.Histogram == nil { @@ -83,6 +60,9 @@ func (m *Metric) validate(metricName MetricName, semConvVersion string) error { errs = errors.Join(errs, errors.New("more than one metric type keys, "+ "only one of the following has to be specified: sum, gauge, histogram")) } + if m.Stability == component.StabilityLevelUndefined { + errs = errors.Join(errs, errors.New("missing required field: `stability.level`")) + } if m.Description == "" { errs = errors.Join(errs, errors.New(`missing metric description`)) } diff --git a/cmd/mdatagen/internal/sampleconnector/metadata.yaml b/cmd/mdatagen/internal/sampleconnector/metadata.yaml index 05b80ccda91..0018a914383 100644 --- a/cmd/mdatagen/internal/sampleconnector/metadata.yaml +++ b/cmd/mdatagen/internal/sampleconnector/metadata.yaml @@ -115,8 +115,7 @@ metrics: enabled: true description: Monotonic cumulative sum int metric enabled by default. extended_documentation: The metric will be become optional soon. - stability: - level: development + stability: development unit: s sum: value_type: int @@ -131,8 +130,7 @@ metrics: enabled: true description: "[DEPRECATED] Non-monotonic delta sum double metric enabled by default." extended_documentation: The metric will be removed soon. - stability: - level: deprecated + stability: deprecated unit: s sum: value_type: double @@ -144,8 +142,7 @@ metrics: metric.input_type: enabled: true description: Monotonic cumulative sum int metric with string input_type enabled by default. - stability: - level: development + stability: development unit: s sum: value_type: int @@ -158,8 +155,7 @@ metrics: optional.metric: enabled: false description: "[DEPRECATED] Gauge double metric disabled by default." - stability: - level: deprecated + stability: deprecated unit: "1" gauge: value_type: double @@ -170,8 +166,7 @@ metrics: optional.metric.empty_unit: enabled: false description: "[DEPRECATED] Gauge double metric disabled by default." - stability: - level: deprecated + stability: deprecated unit: "" gauge: value_type: double @@ -183,8 +178,7 @@ metrics: enabled: true description: Metric for testing spacial reaggregation unit: "1" - stability: - level: beta + stability: beta gauge: - value_type: double + value_type: double attributes: [string_attr, boolean_attr] diff --git a/cmd/mdatagen/internal/samplereceiver/documentation.md b/cmd/mdatagen/internal/samplereceiver/documentation.md index 392823cbc68..e6b9fdf975f 100644 --- a/cmd/mdatagen/internal/samplereceiver/documentation.md +++ b/cmd/mdatagen/internal/samplereceiver/documentation.md @@ -217,7 +217,7 @@ The following telemetry is emitted by this component. ### otelcol_batch_size_trigger_send -Number of times the batch was sent due to a size trigger [Deprecated since v0.110.0] +Number of times the batch was sent due to a size trigger [Deprecated] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | @@ -225,7 +225,7 @@ Number of times the batch was sent due to a size trigger [Deprecated since v0.11 ### otelcol_process_runtime_total_alloc_bytes -Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc') +Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc') [Stable] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | diff --git a/cmd/mdatagen/internal/samplereceiver/internal/metadata/generated_telemetry.go b/cmd/mdatagen/internal/samplereceiver/internal/metadata/generated_telemetry.go index a210d8dbfd1..2e2cf145de2 100644 --- a/cmd/mdatagen/internal/samplereceiver/internal/metadata/generated_telemetry.go +++ b/cmd/mdatagen/internal/samplereceiver/internal/metadata/generated_telemetry.go @@ -106,13 +106,13 @@ func NewTelemetryBuilder(settings component.TelemetrySettings, options ...Teleme var err, errs error builder.BatchSizeTriggerSend, err = builder.meter.Int64Counter( "otelcol_batch_size_trigger_send", - metric.WithDescription("Number of times the batch was sent due to a size trigger [Deprecated since v0.110.0]"), + metric.WithDescription("Number of times the batch was sent due to a size trigger [Deprecated]"), metric.WithUnit("{times}"), ) errs = errors.Join(errs, err) builder.ProcessRuntimeTotalAllocBytes, err = builder.meter.Int64ObservableCounter( "otelcol_process_runtime_total_alloc_bytes", - metric.WithDescription("Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc')"), + metric.WithDescription("Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc') [Stable]"), metric.WithUnit("By"), ) errs = errors.Join(errs, err) diff --git a/cmd/mdatagen/internal/samplereceiver/internal/metadatatest/generated_telemetrytest.go b/cmd/mdatagen/internal/samplereceiver/internal/metadatatest/generated_telemetrytest.go index 361a3643203..81261758c79 100644 --- a/cmd/mdatagen/internal/samplereceiver/internal/metadatatest/generated_telemetrytest.go +++ b/cmd/mdatagen/internal/samplereceiver/internal/metadatatest/generated_telemetrytest.go @@ -25,7 +25,7 @@ func NewSettings(tt *componenttest.Telemetry) receiver.Settings { func AssertEqualBatchSizeTriggerSend(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_batch_size_trigger_send", - Description: "Number of times the batch was sent due to a size trigger [Deprecated since v0.110.0]", + Description: "Number of times the batch was sent due to a size trigger [Deprecated]", Unit: "{times}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -41,7 +41,7 @@ func AssertEqualBatchSizeTriggerSend(t *testing.T, tt *componenttest.Telemetry, func AssertEqualProcessRuntimeTotalAllocBytes(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_process_runtime_total_alloc_bytes", - Description: "Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc')", + Description: "Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc') [Stable]", Unit: "By", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, diff --git a/cmd/mdatagen/internal/samplereceiver/metadata.yaml b/cmd/mdatagen/internal/samplereceiver/metadata.yaml index 77c502160e2..679077cd510 100644 --- a/cmd/mdatagen/internal/samplereceiver/metadata.yaml +++ b/cmd/mdatagen/internal/samplereceiver/metadata.yaml @@ -164,8 +164,7 @@ metrics: enabled: true description: Monotonic cumulative sum int metric enabled by default. extended_documentation: The metric will be become optional soon. - stability: - level: development + stability: development unit: s sum: value_type: int @@ -189,8 +188,7 @@ metrics: enabled: true description: "[DEPRECATED] Non-monotonic delta sum double metric enabled by default." extended_documentation: The metric will be removed soon. - stability: - level: deprecated + stability: deprecated unit: s sum: value_type: double @@ -202,8 +200,7 @@ metrics: metric.input_type: enabled: true description: Monotonic cumulative sum int metric with string input_type enabled by default. - stability: - level: development + stability: development unit: s sum: value_type: int @@ -216,8 +213,7 @@ metrics: optional.metric: enabled: false description: "[DEPRECATED] Gauge double metric disabled by default." - stability: - level: deprecated + stability: deprecated unit: "1" gauge: value_type: double @@ -228,8 +224,7 @@ metrics: optional.metric.empty_unit: enabled: false description: "[DEPRECATED] Gauge double metric disabled by default." - stability: - level: deprecated + stability: deprecated unit: "" gauge: value_type: double @@ -241,16 +236,14 @@ metrics: enabled: true description: Metric for testing spacial reaggregation unit: "1" - stability: - level: beta + stability: beta gauge: - value_type: double + value_type: double attributes: [string_attr, boolean_attr] system.cpu.time: enabled: true - stability: - level: beta + stability: beta description: Monotonic cumulative sum int metric enabled by default. extended_documentation: The metric will be become optional soon. unit: s @@ -265,9 +258,7 @@ telemetry: metrics: batch_size_trigger_send: enabled: true - stability: - level: deprecated - from: v0.110.0 + stability: deprecated description: Number of times the batch was sent due to a size trigger unit: "{times}" sum: @@ -275,8 +266,7 @@ telemetry: monotonic: true process_runtime_total_alloc_bytes: enabled: true - stability: - level: stable + stability: stable description: Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc') unit: By sum: @@ -286,15 +276,13 @@ telemetry: queue_capacity: enabled: true description: Queue capacity - sync gauge example. - stability: - level: development + stability: development unit: "{items}" gauge: value_type: int queue_length: enabled: true - stability: - level: alpha + stability: alpha description: This metric is optional and therefore not initialized in NewTelemetryBuilder. extended_documentation: For example this metric only exists if feature A is enabled. unit: "{items}" @@ -304,8 +292,7 @@ telemetry: value_type: int request_duration: enabled: true - stability: - level: alpha + stability: alpha description: Duration of request unit: s histogram: diff --git a/cmd/mdatagen/internal/samplescraper/metadata.yaml b/cmd/mdatagen/internal/samplescraper/metadata.yaml index 4f73d0f42a9..1d67aeb5795 100644 --- a/cmd/mdatagen/internal/samplescraper/metadata.yaml +++ b/cmd/mdatagen/internal/samplescraper/metadata.yaml @@ -107,8 +107,7 @@ metrics: enabled: true description: Monotonic cumulative sum int metric enabled by default. extended_documentation: The metric will be become optional soon. - stability: - level: development + stability: development unit: s sum: value_type: int @@ -123,8 +122,7 @@ metrics: enabled: true description: "[DEPRECATED] Non-monotonic delta sum double metric enabled by default." extended_documentation: The metric will be removed soon. - stability: - level: deprecated + stability: deprecated unit: s sum: value_type: double @@ -135,8 +133,7 @@ metrics: metric.input_type: enabled: true - stability: - level: development + stability: development description: Monotonic cumulative sum int metric with string input_type enabled by default. unit: s sum: @@ -150,8 +147,7 @@ metrics: optional.metric: enabled: false description: "[DEPRECATED] Gauge double metric disabled by default." - stability: - level: deprecated + stability: deprecated unit: "1" gauge: value_type: double @@ -162,8 +158,7 @@ metrics: optional.metric.empty_unit: enabled: false description: "[DEPRECATED] Gauge double metric disabled by default." - stability: - level: deprecated + stability: deprecated unit: "" gauge: value_type: double @@ -175,16 +170,14 @@ metrics: enabled: true description: Metric for testing spacial reaggregation unit: "1" - stability: - level: beta + stability: beta gauge: - value_type: double + value_type: double attributes: [string_attr, boolean_attr] system.cpu.time: enabled: true - stability: - level: beta + stability: beta description: Monotonic cumulative sum int metric enabled by default. extended_documentation: The metric will be become optional soon. unit: s diff --git a/cmd/mdatagen/internal/templates/documentation.md.tmpl b/cmd/mdatagen/internal/templates/documentation.md.tmpl index 461ab21da47..b582a1b79bb 100644 --- a/cmd/mdatagen/internal/templates/documentation.md.tmpl +++ b/cmd/mdatagen/internal/templates/documentation.md.tmpl @@ -12,12 +12,12 @@ {{- end }} -| Unit | Metric Type | Value Type |{{ if $metric.Data.HasAggregated }} Aggregation Temporality |{{ end }}{{ if $metric.Data.HasMonotonic }} Monotonic |{{ end }}{{ if $metric.Stability.Level }} Stability |{{ end }}{{ if $metric.SemanticConvention }} Semantic Convention |{{ end }} -| ---- | ----------- | ---------- |{{ if $metric.Data.HasAggregated }} ----------------------- |{{ end }}{{ if $metric.Data.HasMonotonic }} --------- |{{ end }}{{ if $metric.Stability.Level }} --------- |{{ end }}{{ if $metric.SemanticConvention }} ------------------- |{{ end }} +| Unit | Metric Type | Value Type |{{ if $metric.Data.HasAggregated }} Aggregation Temporality |{{ end }}{{ if $metric.Data.HasMonotonic }} Monotonic |{{ end }}{{ if $metric.Stability }} Stability |{{ end }}{{ if $metric.SemanticConvention }} Semantic Convention |{{ end }} +| ---- | ----------- | ---------- |{{ if $metric.Data.HasAggregated }} ----------------------- |{{ end }}{{ if $metric.Data.HasMonotonic }} --------- |{{ end }}{{ if $metric.Stability }} --------- |{{ end }}{{ if $metric.SemanticConvention }} ------------------- |{{ end }} | {{ $metric.Unit }} | {{ $metric.Data.Type }} | {{ $metric.Data.MetricValueType }} | {{- if $metric.Data.HasAggregated }} {{ $metric.Data.AggregationTemporality }} |{{ end }} {{- if $metric.Data.HasMonotonic }} {{ $metric.Data.Monotonic }} |{{ end }} -{{- if $metric.Stability.Level }} {{ $metric.Stability.Level }} |{{ end }} +{{- if $metric.Stability }} {{ $metric.Stability }} |{{ end }} {{- if $metric.SemanticConvention }} [{{ $metricName }}]({{ $metric.SemanticConvention.SemanticConventionRef }}) |{{ end }} {{- if $metric.Attributes }} @@ -72,7 +72,7 @@ ### {{ if $metric.Prefix -}}{{ $metric.Prefix }}{{- else -}}otelcol_{{- end -}}{{ $metricName }} -{{ $metric.Description }}{{ $metric.Stability }} +{{ $metric.Description }} [{{ $metric.Stability }}] {{- if $metric.ExtendedDocumentation }} @@ -80,11 +80,11 @@ {{- end }} -| Unit | Metric Type | Value Type |{{ if $metric.Data.HasMonotonic }} Monotonic |{{ end }}{{ if $metric.Stability.Level }} Stability |{{ end }}{{ if $metric.SemanticConvention }} Semantic Convention |{{ end }} -| ---- | ----------- | ---------- |{{ if $metric.Data.HasMonotonic }} --------- |{{ end }}{{ if $metric.Stability.Level }} --------- |{{ end }}{{ if $metric.SemanticConvention }} ------------------- |{{ end }} +| Unit | Metric Type | Value Type |{{ if $metric.Data.HasMonotonic }} Monotonic |{{ end }}{{ if $metric.Stability }} Stability |{{ end }}{{ if $metric.SemanticConvention }} Semantic Convention |{{ end }} +| ---- | ----------- | ---------- |{{ if $metric.Data.HasMonotonic }} --------- |{{ end }}{{ if $metric.Stability }} --------- |{{ end }}{{ if $metric.SemanticConvention }} ------------------- |{{ end }} | {{ $metric.Unit }} | {{ $metric.Data.Type }} | {{ $metric.Data.MetricValueType }} | {{- if $metric.Data.HasMonotonic }} {{ $metric.Data.Monotonic }} |{{ end }} -{{- if $metric.Stability.Level }} {{ $metric.Stability.Level }} |{{ end }} +{{- if $metric.Stability }} {{ $metric.Stability }} |{{ end }} {{- if $metric.SemanticConvention }} [{{ $metricName }}]({{ $metric.SemanticConvention.SemanticConventionRef }}) |{{ end }} {{- if $metric.Attributes }} diff --git a/cmd/mdatagen/internal/templates/telemetry.go.tmpl b/cmd/mdatagen/internal/templates/telemetry.go.tmpl index da4dc276973..0596c6d9c48 100644 --- a/cmd/mdatagen/internal/templates/telemetry.go.tmpl +++ b/cmd/mdatagen/internal/templates/telemetry.go.tmpl @@ -141,7 +141,7 @@ func NewTelemetryBuilder(settings component.TelemetrySettings, options ...Teleme {{ else -}} "otelcol_{{ $name }}", {{ end -}} - metric.WithDescription("{{ $metric.Description }}{{ $metric.Stability }}"), + metric.WithDescription("{{ $metric.Description }} [{{ $metric.Stability }}]"), metric.WithUnit("{{ $metric.Unit }}"), {{ if eq $metric.Data.Type "Histogram" -}} {{- if $metric.Data.Boundaries -}}metric.WithExplicitBucketBoundaries([]float64{ {{- range $metric.Data.Boundaries }} {{.}}, {{- end }} }...),{{- end }} diff --git a/cmd/mdatagen/internal/templates/telemetrytest.go.tmpl b/cmd/mdatagen/internal/templates/telemetrytest.go.tmpl index 62a371545b2..5b6a402a641 100644 --- a/cmd/mdatagen/internal/templates/telemetrytest.go.tmpl +++ b/cmd/mdatagen/internal/templates/telemetrytest.go.tmpl @@ -37,7 +37,7 @@ func AssertEqual{{ $name.Render }}(t *testing.T, tt *componenttest.Telemetry, dp {{ else -}} Name: "otelcol_{{ $name }}", {{ end -}} - Description: "{{ $metric.Description }}{{ $metric.Stability }}", + Description: "{{ $metric.Description }} [{{ $metric.Stability }}]", Unit: "{{ $metric.Unit }}", Data: metricdata.{{ $metric.Data.Type }}[{{ $metric.Data.BasicType }}]{ {{- if $metric.Data.HasAggregated }} diff --git a/cmd/mdatagen/internal/testdata/async_metric.yaml b/cmd/mdatagen/internal/testdata/async_metric.yaml index 0ab62684090..48bba1e958c 100644 --- a/cmd/mdatagen/internal/testdata/async_metric.yaml +++ b/cmd/mdatagen/internal/testdata/async_metric.yaml @@ -13,8 +13,7 @@ metrics: metric: enabled: true description: Description. - stability: - level: development + stability: development unit: s gauge: value_type: double diff --git a/cmd/mdatagen/internal/testdata/invalid_aggregation.yaml b/cmd/mdatagen/internal/testdata/invalid_aggregation.yaml index c86c2d62662..7c798965c6d 100644 --- a/cmd/mdatagen/internal/testdata/invalid_aggregation.yaml +++ b/cmd/mdatagen/internal/testdata/invalid_aggregation.yaml @@ -15,8 +15,7 @@ metrics: enabled: true description: Monotonic cumulative sum int metric enabled by default. extended_documentation: The metric will be become optional soon. - stability: - level: development + stability: development unit: s sum: value_type: int diff --git a/cmd/mdatagen/internal/testdata/invalid_input_type.yaml b/cmd/mdatagen/internal/testdata/invalid_input_type.yaml index 5651abe9b4f..3ecbe5cfa64 100644 --- a/cmd/mdatagen/internal/testdata/invalid_input_type.yaml +++ b/cmd/mdatagen/internal/testdata/invalid_input_type.yaml @@ -11,8 +11,7 @@ metrics: system.cpu.time: enabled: true description: Total CPU seconds broken down by different states. - stability: - level: development + stability: development unit: s sum: value_type: double diff --git a/cmd/mdatagen/internal/testdata/invalid_metric_semconvref.yaml b/cmd/mdatagen/internal/testdata/invalid_metric_semconvref.yaml index cccf15e5524..0f431e8deae 100644 --- a/cmd/mdatagen/internal/testdata/invalid_metric_semconvref.yaml +++ b/cmd/mdatagen/internal/testdata/invalid_metric_semconvref.yaml @@ -17,8 +17,7 @@ metrics: enabled: true description: Monotonic cumulative sum int metric enabled by default. extended_documentation: The metric will be become optional soon. - stability: - level: development + stability: development semantic_convention: ref: https://github.com/open-telemetry/semantic-conventions/blob/v1.38.0/docs/system/system-metrics.md#metric-systemcputime unit: s diff --git a/cmd/mdatagen/internal/testdata/invalid_metric_stability.yaml b/cmd/mdatagen/internal/testdata/invalid_metric_stability.yaml index 0906a5720b4..44d900a7820 100644 --- a/cmd/mdatagen/internal/testdata/invalid_metric_stability.yaml +++ b/cmd/mdatagen/internal/testdata/invalid_metric_stability.yaml @@ -15,8 +15,7 @@ metrics: enabled: true description: Monotonic cumulative sum int metric enabled by default. extended_documentation: The metric will be become optional soon. - stability: - level: development42 + stability: development42 unit: s sum: value_type: int diff --git a/cmd/mdatagen/internal/testdata/metrics_and_type.yaml b/cmd/mdatagen/internal/testdata/metrics_and_type.yaml index e2591e04f6e..537a56335ee 100644 --- a/cmd/mdatagen/internal/testdata/metrics_and_type.yaml +++ b/cmd/mdatagen/internal/testdata/metrics_and_type.yaml @@ -13,8 +13,7 @@ metrics: metric: enabled: true description: Description. - stability: - level: development + stability: development unit: s gauge: value_type: double diff --git a/cmd/mdatagen/internal/testdata/no_aggregation.yaml b/cmd/mdatagen/internal/testdata/no_aggregation.yaml index f9425fa6df7..fb19f85ed16 100644 --- a/cmd/mdatagen/internal/testdata/no_aggregation.yaml +++ b/cmd/mdatagen/internal/testdata/no_aggregation.yaml @@ -16,9 +16,8 @@ metrics: enabled: true description: Monotonic cumulative sum int metric enabled by default. extended_documentation: The metric will be become optional soon. - stability: - level: development + stability: development unit: s sum: value_type: int - monotonic: false \ No newline at end of file + monotonic: false diff --git a/cmd/mdatagen/internal/testdata/no_description_attr.yaml b/cmd/mdatagen/internal/testdata/no_description_attr.yaml index 6d4744ca86e..63d60cc3c49 100644 --- a/cmd/mdatagen/internal/testdata/no_description_attr.yaml +++ b/cmd/mdatagen/internal/testdata/no_description_attr.yaml @@ -23,8 +23,7 @@ metrics: enabled: true description: Monotonic cumulative sum int metric enabled by default. extended_documentation: The metric will be become optional soon. - stability: - level: development + stability: development unit: s sum: value_type: int diff --git a/cmd/mdatagen/internal/testdata/no_enabled.yaml b/cmd/mdatagen/internal/testdata/no_enabled.yaml index c993152f3f9..2b4a278091d 100644 --- a/cmd/mdatagen/internal/testdata/no_enabled.yaml +++ b/cmd/mdatagen/internal/testdata/no_enabled.yaml @@ -6,12 +6,11 @@ status: development: [logs] beta: [traces] stable: [metrics] - + metrics: system.cpu.time: description: Total CPU seconds broken down by different states. - stability: - level: development + stability: development unit: s sum: value_type: double diff --git a/cmd/mdatagen/internal/testdata/no_metric_description.yaml b/cmd/mdatagen/internal/testdata/no_metric_description.yaml index 0ef5dc10d9f..aa14a70c28f 100644 --- a/cmd/mdatagen/internal/testdata/no_metric_description.yaml +++ b/cmd/mdatagen/internal/testdata/no_metric_description.yaml @@ -15,8 +15,7 @@ metrics: default.metric: enabled: true extended_documentation: The metric will be become optional soon. - stability: - level: development + stability: development unit: s sum: value_type: int diff --git a/cmd/mdatagen/internal/testdata/no_metric_type.yaml b/cmd/mdatagen/internal/testdata/no_metric_type.yaml index 792e88ecefc..bb6b0c26fdd 100644 --- a/cmd/mdatagen/internal/testdata/no_metric_type.yaml +++ b/cmd/mdatagen/internal/testdata/no_metric_type.yaml @@ -9,7 +9,6 @@ metrics: system.cpu.time: enabled: true description: Total CPU seconds broken down by different states. - stability: - level: development + stability: development unit: s attributes: diff --git a/cmd/mdatagen/internal/testdata/no_metric_unit.yaml b/cmd/mdatagen/internal/testdata/no_metric_unit.yaml index 9f55e10cf13..394d3e677b6 100644 --- a/cmd/mdatagen/internal/testdata/no_metric_unit.yaml +++ b/cmd/mdatagen/internal/testdata/no_metric_unit.yaml @@ -16,8 +16,7 @@ metrics: enabled: true description: Monotonic cumulative sum int metric enabled by default. extended_documentation: The metric will be become optional soon. - stability: - level: development + stability: development sum: value_type: int monotonic: true diff --git a/cmd/mdatagen/internal/testdata/no_monotonic.yaml b/cmd/mdatagen/internal/testdata/no_monotonic.yaml index 9d2cf74de9a..cda807c497b 100644 --- a/cmd/mdatagen/internal/testdata/no_monotonic.yaml +++ b/cmd/mdatagen/internal/testdata/no_monotonic.yaml @@ -16,8 +16,7 @@ metrics: enabled: true description: Monotonic cumulative sum int metric enabled by default. extended_documentation: The metric will be become optional soon. - stability: - level: development + stability: development unit: s sum: value_type: int diff --git a/cmd/mdatagen/internal/testdata/no_type_attr.yaml b/cmd/mdatagen/internal/testdata/no_type_attr.yaml index 0cc5f8e56f5..9bf9f672ce4 100644 --- a/cmd/mdatagen/internal/testdata/no_type_attr.yaml +++ b/cmd/mdatagen/internal/testdata/no_type_attr.yaml @@ -17,8 +17,7 @@ metrics: metric: enabled: true description: Metric. - stability: - level: development + stability: development unit: "1" gauge: value_type: double diff --git a/cmd/mdatagen/internal/testdata/no_value_type.yaml b/cmd/mdatagen/internal/testdata/no_value_type.yaml index cdc2412d47d..eaab6d45086 100644 --- a/cmd/mdatagen/internal/testdata/no_value_type.yaml +++ b/cmd/mdatagen/internal/testdata/no_value_type.yaml @@ -15,8 +15,7 @@ metrics: system.cpu.time: enabled: true description: Total CPU seconds broken down by different states. - stability: - level: development + stability: development unit: s sum: monotonic: true diff --git a/cmd/mdatagen/internal/testdata/two_metric_types.yaml b/cmd/mdatagen/internal/testdata/two_metric_types.yaml index b6b48fd2aae..2476aff426e 100644 --- a/cmd/mdatagen/internal/testdata/two_metric_types.yaml +++ b/cmd/mdatagen/internal/testdata/two_metric_types.yaml @@ -11,8 +11,7 @@ metrics: system.cpu.time: enabled: true description: Total CPU seconds broken down by different states. - stability: - level: development + stability: development unit: s gauge: value_type: double diff --git a/cmd/mdatagen/internal/testdata/unknown_metric_attribute.yaml b/cmd/mdatagen/internal/testdata/unknown_metric_attribute.yaml index 6e4bad5e281..8f27faab13b 100644 --- a/cmd/mdatagen/internal/testdata/unknown_metric_attribute.yaml +++ b/cmd/mdatagen/internal/testdata/unknown_metric_attribute.yaml @@ -6,13 +6,12 @@ status: development: [logs] beta: [traces] stable: [metrics] - + metrics: system.cpu.time: enabled: true description: Total CPU seconds broken down by different states. - stability: - level: development + stability: development unit: s sum: value_type: double diff --git a/cmd/mdatagen/internal/testdata/unknown_value_type.yaml b/cmd/mdatagen/internal/testdata/unknown_value_type.yaml index 1231e7282ac..eab669a95b0 100644 --- a/cmd/mdatagen/internal/testdata/unknown_value_type.yaml +++ b/cmd/mdatagen/internal/testdata/unknown_value_type.yaml @@ -11,8 +11,7 @@ metrics: system.cpu.time: enabled: true description: Total CPU seconds broken down by different states. - stability: - level: development + stability: development unit: s sum: value_type: unknown diff --git a/cmd/mdatagen/internal/testdata/unused_attribute.yaml b/cmd/mdatagen/internal/testdata/unused_attribute.yaml index 4d07147fa10..a7daa3dd2c3 100644 --- a/cmd/mdatagen/internal/testdata/unused_attribute.yaml +++ b/cmd/mdatagen/internal/testdata/unused_attribute.yaml @@ -26,8 +26,7 @@ metrics: metric: enabled: true description: Metric. - stability: - level: development + stability: development unit: "1" gauge: value_type: double @@ -38,9 +37,8 @@ telemetry: metric: enabled: true description: Metric. - stability: - level: development + stability: development unit: "1" gauge: value_type: double - attributes: [used_attr_in_telemetry_section] \ No newline at end of file + attributes: [used_attr_in_telemetry_section] diff --git a/cmd/mdatagen/internal/testdata/with_conditional_attribute.yaml b/cmd/mdatagen/internal/testdata/with_conditional_attribute.yaml index d3f4af8e07d..0246020710d 100644 --- a/cmd/mdatagen/internal/testdata/with_conditional_attribute.yaml +++ b/cmd/mdatagen/internal/testdata/with_conditional_attribute.yaml @@ -12,7 +12,7 @@ attributes: description: Conditional int attr. type: string requirement_level: conditionally_required - + opt_in_string_attr: description: Opt-in string attr. type: string @@ -22,8 +22,7 @@ metrics: metric: enabled: true description: Metric. - stability: - level: development + stability: development unit: "1" gauge: value_type: double diff --git a/cmd/mdatagen/internal/testdata/with_telemetry.yaml b/cmd/mdatagen/internal/testdata/with_telemetry.yaml index 6d203ac9875..212511683d9 100644 --- a/cmd/mdatagen/internal/testdata/with_telemetry.yaml +++ b/cmd/mdatagen/internal/testdata/with_telemetry.yaml @@ -14,8 +14,7 @@ telemetry: description: Latency (in microseconds) of a given sampling policy unit: µs enabled: true - stability: - level: alpha + stability: alpha histogram: value_type: int attributes: [name] diff --git a/cmd/mdatagen/metadata-schema.yaml b/cmd/mdatagen/metadata-schema.yaml index 8659966fb06..df5cd866d54 100644 --- a/cmd/mdatagen/metadata-schema.yaml +++ b/cmd/mdatagen/metadata-schema.yaml @@ -146,11 +146,7 @@ metrics: # Optional: array of attributes that were defined in the attributes section that are emitted by this metric. attributes: [string] # Required: the metric stability - stability: - # Required: the level of stability - level: - # Optional: the version current stability was introduced - from: + stability: # Optional: the reference to a semantic convention semantic_convention: ref: diff --git a/exporter/exporterhelper/metadata.yaml b/exporter/exporterhelper/metadata.yaml index baa606a08fc..5928cde0826 100644 --- a/exporter/exporterhelper/metadata.yaml +++ b/exporter/exporterhelper/metadata.yaml @@ -15,8 +15,7 @@ telemetry: metrics: exporter_enqueue_failed_log_records: enabled: true - stability: - level: alpha + stability: alpha description: Number of log records failed to be added to the sending queue. unit: "{records}" sum: @@ -25,8 +24,7 @@ telemetry: exporter_enqueue_failed_metric_points: enabled: true - stability: - level: alpha + stability: alpha description: Number of metric points failed to be added to the sending queue. unit: "{datapoints}" sum: @@ -35,8 +33,7 @@ telemetry: exporter_enqueue_failed_spans: enabled: true - stability: - level: alpha + stability: alpha description: Number of spans failed to be added to the sending queue. unit: "{spans}" sum: @@ -46,8 +43,7 @@ telemetry: exporter_queue_batch_send_size: enabled: true description: Number of units in the batch - stability: - level: development + stability: development unit: "{units}" histogram: value_type: int @@ -80,8 +76,7 @@ telemetry: exporter_queue_batch_send_size_bytes: enabled: true description: Number of bytes in batch that was sent. Only available on detailed level. - stability: - level: development + stability: development unit: By histogram: value_type: int @@ -105,8 +100,7 @@ telemetry: exporter_queue_capacity: enabled: true - stability: - level: alpha + stability: alpha description: Fixed capacity of the retry queue (in batches). unit: "{batches}" gauge: @@ -115,8 +109,7 @@ telemetry: exporter_queue_size: enabled: true - stability: - level: alpha + stability: alpha description: Current size of the retry queue (in batches). unit: "{batches}" gauge: @@ -125,8 +118,7 @@ telemetry: exporter_send_failed_log_records: enabled: true - stability: - level: alpha + stability: alpha description: Number of log records in failed attempts to send to destination. unit: "{records}" sum: @@ -135,8 +127,7 @@ telemetry: exporter_send_failed_metric_points: enabled: true - stability: - level: alpha + stability: alpha description: Number of metric points in failed attempts to send to destination. unit: "{datapoints}" sum: @@ -145,8 +136,7 @@ telemetry: exporter_send_failed_spans: enabled: true - stability: - level: alpha + stability: alpha description: Number of spans in failed attempts to send to destination. unit: "{spans}" sum: @@ -155,8 +145,7 @@ telemetry: exporter_sent_log_records: enabled: true - stability: - level: alpha + stability: alpha description: Number of log record successfully sent to destination. unit: "{records}" sum: @@ -165,8 +154,7 @@ telemetry: exporter_sent_metric_points: enabled: true - stability: - level: alpha + stability: alpha description: Number of metric points successfully sent to destination. unit: "{datapoints}" sum: @@ -175,8 +163,7 @@ telemetry: exporter_sent_spans: enabled: true - stability: - level: alpha + stability: alpha description: Number of spans successfully sent to destination. unit: "{spans}" sum: diff --git a/processor/batchprocessor/metadata.yaml b/processor/batchprocessor/metadata.yaml index a843bfb18d4..2c845b3530f 100644 --- a/processor/batchprocessor/metadata.yaml +++ b/processor/batchprocessor/metadata.yaml @@ -14,8 +14,7 @@ telemetry: metrics: processor_batch_batch_send_size: enabled: true - stability: - level: development + stability: development description: Number of units in the batch unit: "{units}" histogram: @@ -47,8 +46,7 @@ telemetry: ] processor_batch_batch_send_size_bytes: enabled: true - stability: - level: development + stability: development description: Number of bytes in batch that was sent. Only available on detailed level. unit: By histogram: @@ -97,8 +95,7 @@ telemetry: ] processor_batch_batch_size_trigger_send: enabled: true - stability: - level: development + stability: development description: Number of times the batch was sent due to a size trigger unit: "{times}" sum: @@ -106,8 +103,7 @@ telemetry: monotonic: true processor_batch_metadata_cardinality: enabled: true - stability: - level: development + stability: development description: Number of distinct metadata value combinations being processed unit: "{combinations}" sum: @@ -115,8 +111,7 @@ telemetry: async: true processor_batch_timeout_trigger_send: enabled: true - stability: - level: development + stability: development description: Number of times the batch was sent due to a timeout trigger unit: "{times}" sum: diff --git a/processor/memorylimiterprocessor/documentation.md b/processor/memorylimiterprocessor/documentation.md index 62fb21f99cb..35764496685 100644 --- a/processor/memorylimiterprocessor/documentation.md +++ b/processor/memorylimiterprocessor/documentation.md @@ -8,7 +8,7 @@ The following telemetry is emitted by this component. ### otelcol_processor_accepted_log_records -Number of log records successfully pushed into the next component in the pipeline. [Deprecated since v0.110.0] +Number of log records successfully pushed into the next component in the pipeline. [Deprecated] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | @@ -16,7 +16,7 @@ Number of log records successfully pushed into the next component in the pipelin ### otelcol_processor_accepted_metric_points -Number of metric points successfully pushed into the next component in the pipeline. [Deprecated since v0.110.0] +Number of metric points successfully pushed into the next component in the pipeline. [Deprecated] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | @@ -24,7 +24,7 @@ Number of metric points successfully pushed into the next component in the pipel ### otelcol_processor_accepted_spans -Number of spans successfully pushed into the next component in the pipeline. [Deprecated since v0.110.0] +Number of spans successfully pushed into the next component in the pipeline. [Deprecated] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | @@ -32,7 +32,7 @@ Number of spans successfully pushed into the next component in the pipeline. [De ### otelcol_processor_refused_log_records -Number of log records that were rejected by the next component in the pipeline. [Deprecated since v0.110.0] +Number of log records that were rejected by the next component in the pipeline. [Deprecated] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | @@ -40,7 +40,7 @@ Number of log records that were rejected by the next component in the pipeline. ### otelcol_processor_refused_metric_points -Number of metric points that were rejected by the next component in the pipeline. [Deprecated since v0.110.0] +Number of metric points that were rejected by the next component in the pipeline. [Deprecated] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | @@ -48,7 +48,7 @@ Number of metric points that were rejected by the next component in the pipeline ### otelcol_processor_refused_spans -Number of spans that were rejected by the next component in the pipeline. [Deprecated since v0.110.0] +Number of spans that were rejected by the next component in the pipeline. [Deprecated] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | diff --git a/processor/memorylimiterprocessor/internal/metadata/generated_telemetry.go b/processor/memorylimiterprocessor/internal/metadata/generated_telemetry.go index 176b5f1d864..a5941fe440a 100644 --- a/processor/memorylimiterprocessor/internal/metadata/generated_telemetry.go +++ b/processor/memorylimiterprocessor/internal/metadata/generated_telemetry.go @@ -65,37 +65,37 @@ func NewTelemetryBuilder(settings component.TelemetrySettings, options ...Teleme var err, errs error builder.ProcessorAcceptedLogRecords, err = builder.meter.Int64Counter( "otelcol_processor_accepted_log_records", - metric.WithDescription("Number of log records successfully pushed into the next component in the pipeline. [Deprecated since v0.110.0]"), + metric.WithDescription("Number of log records successfully pushed into the next component in the pipeline. [Deprecated]"), metric.WithUnit("{records}"), ) errs = errors.Join(errs, err) builder.ProcessorAcceptedMetricPoints, err = builder.meter.Int64Counter( "otelcol_processor_accepted_metric_points", - metric.WithDescription("Number of metric points successfully pushed into the next component in the pipeline. [Deprecated since v0.110.0]"), + metric.WithDescription("Number of metric points successfully pushed into the next component in the pipeline. [Deprecated]"), metric.WithUnit("{datapoints}"), ) errs = errors.Join(errs, err) builder.ProcessorAcceptedSpans, err = builder.meter.Int64Counter( "otelcol_processor_accepted_spans", - metric.WithDescription("Number of spans successfully pushed into the next component in the pipeline. [Deprecated since v0.110.0]"), + metric.WithDescription("Number of spans successfully pushed into the next component in the pipeline. [Deprecated]"), metric.WithUnit("{spans}"), ) errs = errors.Join(errs, err) builder.ProcessorRefusedLogRecords, err = builder.meter.Int64Counter( "otelcol_processor_refused_log_records", - metric.WithDescription("Number of log records that were rejected by the next component in the pipeline. [Deprecated since v0.110.0]"), + metric.WithDescription("Number of log records that were rejected by the next component in the pipeline. [Deprecated]"), metric.WithUnit("{records}"), ) errs = errors.Join(errs, err) builder.ProcessorRefusedMetricPoints, err = builder.meter.Int64Counter( "otelcol_processor_refused_metric_points", - metric.WithDescription("Number of metric points that were rejected by the next component in the pipeline. [Deprecated since v0.110.0]"), + metric.WithDescription("Number of metric points that were rejected by the next component in the pipeline. [Deprecated]"), metric.WithUnit("{datapoints}"), ) errs = errors.Join(errs, err) builder.ProcessorRefusedSpans, err = builder.meter.Int64Counter( "otelcol_processor_refused_spans", - metric.WithDescription("Number of spans that were rejected by the next component in the pipeline. [Deprecated since v0.110.0]"), + metric.WithDescription("Number of spans that were rejected by the next component in the pipeline. [Deprecated]"), metric.WithUnit("{spans}"), ) errs = errors.Join(errs, err) diff --git a/processor/memorylimiterprocessor/internal/metadatatest/generated_telemetrytest.go b/processor/memorylimiterprocessor/internal/metadatatest/generated_telemetrytest.go index 0f931acdd80..c4a34915d0f 100644 --- a/processor/memorylimiterprocessor/internal/metadatatest/generated_telemetrytest.go +++ b/processor/memorylimiterprocessor/internal/metadatatest/generated_telemetrytest.go @@ -25,7 +25,7 @@ func NewSettings(tt *componenttest.Telemetry) processor.Settings { func AssertEqualProcessorAcceptedLogRecords(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_processor_accepted_log_records", - Description: "Number of log records successfully pushed into the next component in the pipeline. [Deprecated since v0.110.0]", + Description: "Number of log records successfully pushed into the next component in the pipeline. [Deprecated]", Unit: "{records}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -41,7 +41,7 @@ func AssertEqualProcessorAcceptedLogRecords(t *testing.T, tt *componenttest.Tele func AssertEqualProcessorAcceptedMetricPoints(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_processor_accepted_metric_points", - Description: "Number of metric points successfully pushed into the next component in the pipeline. [Deprecated since v0.110.0]", + Description: "Number of metric points successfully pushed into the next component in the pipeline. [Deprecated]", Unit: "{datapoints}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -57,7 +57,7 @@ func AssertEqualProcessorAcceptedMetricPoints(t *testing.T, tt *componenttest.Te func AssertEqualProcessorAcceptedSpans(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_processor_accepted_spans", - Description: "Number of spans successfully pushed into the next component in the pipeline. [Deprecated since v0.110.0]", + Description: "Number of spans successfully pushed into the next component in the pipeline. [Deprecated]", Unit: "{spans}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -73,7 +73,7 @@ func AssertEqualProcessorAcceptedSpans(t *testing.T, tt *componenttest.Telemetry func AssertEqualProcessorRefusedLogRecords(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_processor_refused_log_records", - Description: "Number of log records that were rejected by the next component in the pipeline. [Deprecated since v0.110.0]", + Description: "Number of log records that were rejected by the next component in the pipeline. [Deprecated]", Unit: "{records}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -89,7 +89,7 @@ func AssertEqualProcessorRefusedLogRecords(t *testing.T, tt *componenttest.Telem func AssertEqualProcessorRefusedMetricPoints(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_processor_refused_metric_points", - Description: "Number of metric points that were rejected by the next component in the pipeline. [Deprecated since v0.110.0]", + Description: "Number of metric points that were rejected by the next component in the pipeline. [Deprecated]", Unit: "{datapoints}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -105,7 +105,7 @@ func AssertEqualProcessorRefusedMetricPoints(t *testing.T, tt *componenttest.Tel func AssertEqualProcessorRefusedSpans(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_processor_refused_spans", - Description: "Number of spans that were rejected by the next component in the pipeline. [Deprecated since v0.110.0]", + Description: "Number of spans that were rejected by the next component in the pipeline. [Deprecated]", Unit: "{spans}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, diff --git a/processor/memorylimiterprocessor/metadata.yaml b/processor/memorylimiterprocessor/metadata.yaml index aa8813f1eaf..13bbfa753f5 100644 --- a/processor/memorylimiterprocessor/metadata.yaml +++ b/processor/memorylimiterprocessor/metadata.yaml @@ -20,9 +20,7 @@ telemetry: processor_accepted_log_records: enabled: true description: Number of log records successfully pushed into the next component in the pipeline. - stability: - level: deprecated - from: v0.110.0 + stability: deprecated unit: "{records}" sum: value_type: int @@ -31,9 +29,7 @@ telemetry: processor_accepted_metric_points: enabled: true description: Number of metric points successfully pushed into the next component in the pipeline. - stability: - level: deprecated - from: v0.110.0 + stability: deprecated unit: "{datapoints}" sum: value_type: int @@ -42,9 +38,7 @@ telemetry: processor_accepted_spans: enabled: true description: Number of spans successfully pushed into the next component in the pipeline. - stability: - level: deprecated - from: v0.110.0 + stability: deprecated unit: "{spans}" sum: value_type: int @@ -53,9 +47,7 @@ telemetry: processor_refused_log_records: enabled: true description: Number of log records that were rejected by the next component in the pipeline. - stability: - level: deprecated - from: v0.110.0 + stability: deprecated unit: "{records}" sum: value_type: int @@ -64,9 +56,7 @@ telemetry: processor_refused_metric_points: enabled: true description: Number of metric points that were rejected by the next component in the pipeline. - stability: - level: deprecated - from: v0.110.0 + stability: deprecated unit: "{datapoints}" sum: value_type: int @@ -75,9 +65,7 @@ telemetry: processor_refused_spans: enabled: true description: Number of spans that were rejected by the next component in the pipeline. - stability: - level: deprecated - from: v0.110.0 + stability: deprecated unit: "{spans}" sum: value_type: int diff --git a/processor/processorhelper/metadata.yaml b/processor/processorhelper/metadata.yaml index 97b9e594a1c..4c1bc56e1b4 100644 --- a/processor/processorhelper/metadata.yaml +++ b/processor/processorhelper/metadata.yaml @@ -11,8 +11,7 @@ telemetry: metrics: processor_incoming_items: enabled: true - stability: - level: alpha + stability: alpha description: Number of items passed to the processor. unit: "{items}" sum: @@ -21,8 +20,7 @@ telemetry: processor_internal_duration: enabled: true - stability: - level: alpha + stability: alpha description: Duration of time taken to process a batch of telemetry data through the processor. unit: s histogram: @@ -31,8 +29,7 @@ telemetry: processor_outgoing_items: enabled: true - stability: - level: alpha + stability: alpha description: Number of items emitted from the processor. unit: "{items}" sum: diff --git a/receiver/receiverhelper/metadata.yaml b/receiver/receiverhelper/metadata.yaml index e5854f996b5..0404ab797ec 100644 --- a/receiver/receiverhelper/metadata.yaml +++ b/receiver/receiverhelper/metadata.yaml @@ -9,16 +9,14 @@ telemetry: metrics: receiver_accepted_log_records: enabled: true - stability: - level: alpha + stability: alpha description: Number of log records successfully pushed into the pipeline. unit: "{records}" sum: value_type: int monotonic: true receiver_accepted_metric_points: - stability: - level: alpha + stability: alpha enabled: true description: Number of metric points successfully pushed into the pipeline. unit: "{datapoints}" @@ -27,8 +25,7 @@ telemetry: monotonic: true receiver_accepted_spans: enabled: true - stability: - level: alpha + stability: alpha description: Number of spans successfully pushed into the pipeline. unit: "{spans}" sum: @@ -36,8 +33,7 @@ telemetry: monotonic: true receiver_failed_log_records: enabled: true - stability: - level: alpha + stability: alpha description: The number of log records that failed to be processed by the receiver due to internal errors. unit: "{records}" sum: @@ -45,8 +41,7 @@ telemetry: monotonic: true receiver_failed_metric_points: enabled: true - stability: - level: alpha + stability: alpha description: The number of metric points that failed to be processed by the receiver due to internal errors. unit: "{datapoints}" sum: @@ -54,8 +49,7 @@ telemetry: monotonic: true receiver_failed_spans: enabled: true - stability: - level: alpha + stability: alpha description: The number of spans that failed to be processed by the receiver due to internal errors. unit: "{spans}" sum: @@ -63,8 +57,7 @@ telemetry: monotonic: true receiver_refused_log_records: enabled: true - stability: - level: alpha + stability: alpha description: Number of log records that could not be pushed into the pipeline. unit: "{records}" sum: @@ -72,8 +65,7 @@ telemetry: monotonic: true receiver_refused_metric_points: enabled: true - stability: - level: alpha + stability: alpha description: Number of metric points that could not be pushed into the pipeline. unit: "{datapoints}" sum: @@ -81,8 +73,7 @@ telemetry: monotonic: true receiver_refused_spans: enabled: true - stability: - level: alpha + stability: alpha description: Number of spans that could not be pushed into the pipeline. unit: "{spans}" sum: @@ -90,8 +81,7 @@ telemetry: monotonic: true receiver_requests: enabled: true - stability: - level: alpha + stability: alpha description: The number of requests performed. unit: "{requests}" sum: diff --git a/scraper/scraperhelper/metadata.yaml b/scraper/scraperhelper/metadata.yaml index 6963d5751d6..ea8010188d9 100644 --- a/scraper/scraperhelper/metadata.yaml +++ b/scraper/scraperhelper/metadata.yaml @@ -11,8 +11,7 @@ telemetry: metrics: scraper_errored_log_records: enabled: true - stability: - level: alpha + stability: alpha description: Number of log records that were unable to be scraped. unit: "{datapoints}" sum: @@ -21,8 +20,7 @@ telemetry: scraper_errored_metric_points: enabled: true - stability: - level: alpha + stability: alpha description: Number of metric points that were unable to be scraped. unit: "{datapoints}" sum: @@ -31,8 +29,7 @@ telemetry: scraper_scraped_log_records: enabled: true - stability: - level: alpha + stability: alpha description: Number of log records successfully scraped. unit: "{datapoints}" sum: @@ -41,8 +38,7 @@ telemetry: scraper_scraped_metric_points: enabled: true - stability: - level: alpha + stability: alpha description: Number of metric points successfully scraped. unit: "{datapoints}" sum: diff --git a/scraper/scraperhelper/xscraperhelper/metadata.yaml b/scraper/scraperhelper/xscraperhelper/metadata.yaml index fd53acbbf49..c6b353b5ca1 100644 --- a/scraper/scraperhelper/xscraperhelper/metadata.yaml +++ b/scraper/scraperhelper/xscraperhelper/metadata.yaml @@ -14,8 +14,7 @@ telemetry: metrics: scraper_errored_profile_records: enabled: true - stability: - level: alpha + stability: alpha description: Number of profile records that were unable to be scraped. unit: "{datapoints}" sum: @@ -24,8 +23,7 @@ telemetry: scraper_scraped_profile_records: enabled: true - stability: - level: alpha + stability: alpha description: Number of profile records successfully scraped. unit: "{datapoints}" sum: diff --git a/service/metadata.yaml b/service/metadata.yaml index 5f59e270e25..721f2531222 100644 --- a/service/metadata.yaml +++ b/service/metadata.yaml @@ -13,8 +13,7 @@ telemetry: connector.consumed.items: prefix: otelcol. enabled: true - stability: - level: development + stability: development description: Number of items passed to the connector. unit: "{item}" sum: @@ -24,8 +23,7 @@ telemetry: connector.consumed.size: prefix: otelcol. enabled: false - stability: - level: development + stability: development description: Size of items passed to the connector, based on ProtoMarshaler.Sizer. unit: "{item}" sum: @@ -35,8 +33,7 @@ telemetry: connector.produced.items: prefix: otelcol. enabled: true - stability: - level: development + stability: development description: Number of items emitted from the connector. unit: "{item}" sum: @@ -46,8 +43,7 @@ telemetry: connector.produced.size: prefix: otelcol. enabled: false - stability: - level: development + stability: development description: Size of items emitted from the connector, based on ProtoMarshaler.Sizer. unit: "{item}" sum: @@ -57,8 +53,7 @@ telemetry: exporter.consumed.items: prefix: otelcol. enabled: true - stability: - level: development + stability: development description: Number of items passed to the exporter. unit: "{item}" sum: @@ -68,8 +63,7 @@ telemetry: exporter.consumed.size: prefix: otelcol. enabled: false - stability: - level: development + stability: development description: Size of items passed to the exporter, based on ProtoMarshaler.Sizer. unit: "{item}" sum: @@ -78,8 +72,7 @@ telemetry: process_cpu_seconds: enabled: true - stability: - level: alpha + stability: alpha description: Total CPU user and system time in seconds unit: s sum: @@ -89,8 +82,7 @@ telemetry: process_memory_rss: enabled: true - stability: - level: alpha + stability: alpha description: Total physical memory (resident set size) unit: By gauge: @@ -99,8 +91,7 @@ telemetry: process_runtime_heap_alloc_bytes: enabled: true - stability: - level: alpha + stability: alpha description: Bytes of allocated heap objects (see 'go doc runtime.MemStats.HeapAlloc') unit: By gauge: @@ -109,8 +100,7 @@ telemetry: process_runtime_total_alloc_bytes: enabled: true - stability: - level: alpha + stability: alpha description: Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc') unit: By sum: @@ -120,8 +110,7 @@ telemetry: process_runtime_total_sys_memory_bytes: enabled: true - stability: - level: alpha + stability: alpha description: Total bytes of memory obtained from the OS (see 'go doc runtime.MemStats.Sys') unit: By gauge: @@ -130,8 +119,7 @@ telemetry: process_uptime: enabled: true - stability: - level: alpha + stability: alpha description: Uptime of the process unit: s sum: @@ -142,8 +130,7 @@ telemetry: processor.consumed.items: prefix: otelcol. enabled: true - stability: - level: development + stability: development description: Number of items passed to the processor. unit: "{item}" sum: @@ -153,8 +140,7 @@ telemetry: processor.consumed.size: prefix: otelcol. enabled: false - stability: - level: development + stability: development description: Size of items passed to the processor, based on ProtoMarshaler.Sizer. unit: "{item}" sum: @@ -164,8 +150,7 @@ telemetry: processor.produced.items: prefix: otelcol. enabled: true - stability: - level: development + stability: development description: Number of items emitted from the processor. unit: "{item}" sum: @@ -175,8 +160,7 @@ telemetry: processor.produced.size: prefix: otelcol. enabled: false - stability: - level: development + stability: development description: Size of items emitted from the processor, based on ProtoMarshaler.Sizer. unit: "{item}" sum: @@ -186,8 +170,7 @@ telemetry: receiver.produced.items: prefix: otelcol. enabled: true - stability: - level: development + stability: development description: Number of items emitted from the receiver. unit: "{item}" sum: @@ -197,8 +180,7 @@ telemetry: receiver.produced.size: prefix: otelcol. enabled: false - stability: - level: development + stability: development description: Size of items emitted from the receiver, based on ProtoMarshaler.Sizer. unit: "{item}" sum: