diff --git a/.chloggen/make_stability_level_required.yaml b/.chloggen/make_stability_level_required.yaml new file mode 100644 index 00000000000..6581b0718b3 --- /dev/null +++ b/.chloggen/make_stability_level_required.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. otlpreceiver) +component: cmd/mdatagen + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Make stability.level a required field for metrics + +# One or more tracking issues or pull requests related to the change +issues: [14070] + +# (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: + +# 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: [user] diff --git a/cmd/mdatagen/internal/loader_test.go b/cmd/mdatagen/internal/loader_test.go index d80801ad248..0f97b51d0eb 100644 --- a/cmd/mdatagen/internal/loader_test.go +++ b/cmd/mdatagen/internal/loader_test.go @@ -248,6 +248,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}, Warnings: Warnings{ IfEnabledNotSet: "This metric will be disabled by default soon.", }, @@ -264,6 +265,7 @@ func TestLoadMetadata(t *testing.T) { Signal: Signal{ Enabled: false, Description: "[DEPRECATED] Gauge double metric disabled by default.", + Stability: Stability{Level: component.StabilityLevelDeprecated}, Warnings: Warnings{ IfConfigured: "This metric is deprecated and will be removed soon.", }, @@ -278,6 +280,7 @@ func TestLoadMetadata(t *testing.T) { Signal: Signal{ Enabled: false, Description: "[DEPRECATED] Gauge double metric disabled by default.", + Stability: Stability{Level: component.StabilityLevelDeprecated}, Warnings: Warnings{ IfConfigured: "This metric is deprecated and will be removed soon.", }, @@ -294,6 +297,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}, Warnings: Warnings{ IfEnabled: "This metric is deprecated and will be removed soon.", }, @@ -309,6 +313,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}, Attributes: []AttributeName{"string_attr", "overridden_int_attr", "enum_attr", "slice_attr", "map_attr"}, }, Unit: strPtr("s"), @@ -359,7 +364,7 @@ func TestLoadMetadata(t *testing.T) { "batch_size_trigger_send": { Signal: Signal{ Enabled: true, - Stability: Stability{Level: "deprecated", From: "v0.110.0"}, + Stability: Stability{Level: component.StabilityLevelDeprecated, From: "v0.110.0"}, Description: "Number of times the batch was sent due to a size trigger", }, Unit: strPtr("{times}"), @@ -371,7 +376,7 @@ func TestLoadMetadata(t *testing.T) { "request_duration": { Signal: Signal{ Enabled: true, - Stability: Stability{Level: "alpha"}, + Stability: Stability{Level: component.StabilityLevelAlpha}, Description: "Duration of request", }, Unit: strPtr("s"), @@ -383,7 +388,7 @@ func TestLoadMetadata(t *testing.T) { "process_runtime_total_alloc_bytes": { Signal: Signal{ Enabled: true, - Stability: Stability{Level: "stable"}, + Stability: Stability{Level: component.StabilityLevelStable}, Description: "Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc')", }, Unit: strPtr("By"), @@ -398,7 +403,7 @@ func TestLoadMetadata(t *testing.T) { "queue_length": { Signal: Signal{ Enabled: true, - Stability: Stability{Level: "alpha"}, + Stability: Stability{Level: 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.", }, @@ -415,6 +420,7 @@ func TestLoadMetadata(t *testing.T) { Signal: Signal{ Enabled: true, Description: "Queue capacity - sync gauge example.", + Stability: Stability{Level: component.StabilityLevelDevelopment}, }, Unit: strPtr("{items}"), Gauge: &Gauge{ @@ -513,6 +519,16 @@ func TestLoadMetadata(t *testing.T) { want: Metadata{}, wantErr: "decoding failed due to the following error(s):\n\n'attributes[used_attr].type' invalid type: \"invalidtype\"", }, + { + 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\"", + }, + { + 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`", + }, { name: "testdata/~~this file doesn't exist~~.yaml", wantErr: "unable to read the file file:testdata/~~this file doesn't exist~~.yaml", diff --git a/cmd/mdatagen/internal/metric.go b/cmd/mdatagen/internal/metric.go index feb40872b28..8b64d2ba07a 100644 --- a/cmd/mdatagen/internal/metric.go +++ b/cmd/mdatagen/internal/metric.go @@ -6,7 +6,6 @@ package internal // import "go.opentelemetry.io/collector/cmd/mdatagen/internal" import ( "errors" "fmt" - "strings" "golang.org/x/text/cases" "golang.org/x/text/language" @@ -48,18 +47,26 @@ type Metric struct { } type Stability struct { - Level string `mapstructure:"level"` - From string `mapstructure:"from"` + Level component.StabilityLevel `mapstructure:"level"` + From string `mapstructure:"from"` } func (s Stability) String() string { - if s.Level == "" || strings.EqualFold(s.Level, component.StabilityLevelStable.String()) { + if s.Level == component.StabilityLevelUndefined || + s.Level == component.StabilityLevelStable { return "" } if s.From != "" { - return fmt.Sprintf(" [%s since %s]", s.Level, s.From) + return fmt.Sprintf(" [%s since %s]", s.Level.String(), s.From) } - return fmt.Sprintf(" [%s]", s.Level) + 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() error { @@ -91,6 +98,9 @@ func (m *Metric) Unmarshal(parser *confmap.Conf) error { if !parser.IsSet("enabled") { return errors.New("missing required field: `enabled`") } + if !parser.IsSet("stability") { + return errors.New("missing required field: `stability`") + } return parser.Unmarshal(m) } diff --git a/cmd/mdatagen/internal/sampleconnector/documentation.md b/cmd/mdatagen/internal/sampleconnector/documentation.md index 2dc456c5416..24fd43e6aea 100644 --- a/cmd/mdatagen/internal/sampleconnector/documentation.md +++ b/cmd/mdatagen/internal/sampleconnector/documentation.md @@ -18,9 +18,9 @@ Monotonic cumulative sum int metric enabled by default. The metric will be become optional soon. -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Int | Cumulative | true | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability | +| ---- | ----------- | ---------- | ----------------------- | --------- | --------- | +| s | Sum | Int | Cumulative | true | Development | #### Attributes @@ -38,17 +38,17 @@ The metric will be become optional soon. The metric will be removed soon. -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Double | Delta | false | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability | +| ---- | ----------- | ---------- | ----------------------- | --------- | --------- | +| s | Sum | Double | Delta | false | Deprecated | ### metric.input_type Monotonic cumulative sum int metric with string input_type enabled by default. -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Int | Cumulative | true | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability | +| ---- | ----------- | ---------- | ----------------------- | --------- | --------- | +| s | Sum | Int | Cumulative | true | Development | #### Attributes @@ -74,9 +74,9 @@ metrics: [DEPRECATED] Gauge double metric disabled by default. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| 1 | Gauge | Double | Deprecated | #### Attributes @@ -90,9 +90,9 @@ metrics: [DEPRECATED] Gauge double metric disabled by default. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| | Gauge | Double | Deprecated | #### Attributes diff --git a/cmd/mdatagen/internal/sampleconnector/metadata.yaml b/cmd/mdatagen/internal/sampleconnector/metadata.yaml index e5a666023cc..7f58fe2c9de 100644 --- a/cmd/mdatagen/internal/sampleconnector/metadata.yaml +++ b/cmd/mdatagen/internal/sampleconnector/metadata.yaml @@ -103,6 +103,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 unit: s sum: value_type: int @@ -117,6 +119,8 @@ 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 unit: s sum: value_type: double @@ -128,6 +132,8 @@ metrics: metric.input_type: enabled: true description: Monotonic cumulative sum int metric with string input_type enabled by default. + stability: + level: development unit: s sum: value_type: int @@ -140,6 +146,8 @@ metrics: optional.metric: enabled: false description: "[DEPRECATED] Gauge double metric disabled by default." + stability: + level: deprecated unit: "1" gauge: value_type: double @@ -150,6 +158,8 @@ metrics: optional.metric.empty_unit: enabled: false description: "[DEPRECATED] Gauge double metric disabled by default." + stability: + level: deprecated unit: "" gauge: value_type: double diff --git a/cmd/mdatagen/internal/samplefactoryreceiver/internal/metadata/generated_telemetry.go b/cmd/mdatagen/internal/samplefactoryreceiver/internal/metadata/generated_telemetry.go index 474c3b3cad9..09003ec668b 100644 --- a/cmd/mdatagen/internal/samplefactoryreceiver/internal/metadata/generated_telemetry.go +++ b/cmd/mdatagen/internal/samplefactoryreceiver/internal/metadata/generated_telemetry.go @@ -124,13 +124,13 @@ func NewTelemetryBuilder(settings component.TelemetrySettings, options ...Teleme errs = errors.Join(errs, err) builder.QueueLength, err = builder.meter.Int64ObservableGauge( "otelcol_queue_length", - metric.WithDescription("This metric is optional and therefore not initialized in NewTelemetryBuilder. [alpha]"), + metric.WithDescription("This metric is optional and therefore not initialized in NewTelemetryBuilder. [Alpha]"), metric.WithUnit("{items}"), ) errs = errors.Join(errs, err) builder.RequestDuration, err = builder.meter.Float64Histogram( "otelcol_request_duration", - metric.WithDescription("Duration of request [alpha]"), + metric.WithDescription("Duration of request [Alpha]"), metric.WithUnit("s"), metric.WithExplicitBucketBoundaries([]float64{1, 10, 100}...), ) diff --git a/cmd/mdatagen/internal/samplereceiver/documentation.md b/cmd/mdatagen/internal/samplereceiver/documentation.md index 34e8d6c08ef..2cbfd50e789 100644 --- a/cmd/mdatagen/internal/samplereceiver/documentation.md +++ b/cmd/mdatagen/internal/samplereceiver/documentation.md @@ -18,9 +18,9 @@ Monotonic cumulative sum int metric enabled by default. The metric will be become optional soon. -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Int | Cumulative | true | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability | +| ---- | ----------- | ---------- | ----------------------- | --------- | --------- | +| s | Sum | Int | Cumulative | true | Development | #### Attributes @@ -41,17 +41,17 @@ The metric will be become optional soon. The metric will be removed soon. -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Double | Delta | false | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability | +| ---- | ----------- | ---------- | ----------------------- | --------- | --------- | +| s | Sum | Double | Delta | false | Deprecated | ### metric.input_type Monotonic cumulative sum int metric with string input_type enabled by default. -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Int | Cumulative | true | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability | +| ---- | ----------- | ---------- | ----------------------- | --------- | --------- | +| s | Sum | Int | Cumulative | true | Development | #### Attributes @@ -77,9 +77,9 @@ metrics: [DEPRECATED] Gauge double metric disabled by default. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| 1 | Gauge | Double | Deprecated | #### Attributes @@ -94,9 +94,9 @@ metrics: [DEPRECATED] Gauge double metric disabled by default. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| | Gauge | Double | Deprecated | #### Attributes @@ -192,11 +192,11 @@ 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 since v0.110.0] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {times} | Sum | Int | true | deprecated | +| {times} | Sum | Int | true | Deprecated | ### otelcol_process_runtime_total_alloc_bytes @@ -204,30 +204,30 @@ Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalA | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| By | Sum | Int | true | stable | +| By | Sum | Int | true | Stable | ### otelcol_queue_capacity -Queue capacity - sync gauge example. +Queue capacity - sync gauge example. [Development] -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {items} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {items} | Gauge | Int | Development | ### otelcol_queue_length -This metric is optional and therefore not initialized in NewTelemetryBuilder. [alpha] +This metric is optional and therefore not initialized in NewTelemetryBuilder. [Alpha] For example this metric only exists if feature A is enabled. | Unit | Metric Type | Value Type | Stability | | ---- | ----------- | ---------- | --------- | -| {items} | Gauge | Int | alpha | +| {items} | Gauge | Int | Alpha | ### otelcol_request_duration -Duration of request [alpha] +Duration of request [Alpha] | Unit | Metric Type | Value Type | Stability | | ---- | ----------- | ---------- | --------- | -| s | Histogram | Double | alpha | +| s | Histogram | Double | Alpha | diff --git a/cmd/mdatagen/internal/samplereceiver/internal/metadata/generated_telemetry.go b/cmd/mdatagen/internal/samplereceiver/internal/metadata/generated_telemetry.go index a1a52cc2c18..a210d8dbfd1 100644 --- a/cmd/mdatagen/internal/samplereceiver/internal/metadata/generated_telemetry.go +++ b/cmd/mdatagen/internal/samplereceiver/internal/metadata/generated_telemetry.go @@ -106,7 +106,7 @@ 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 since v0.110.0]"), metric.WithUnit("{times}"), ) errs = errors.Join(errs, err) @@ -118,19 +118,19 @@ func NewTelemetryBuilder(settings component.TelemetrySettings, options ...Teleme errs = errors.Join(errs, err) builder.QueueCapacity, err = builder.meter.Int64Gauge( "otelcol_queue_capacity", - metric.WithDescription("Queue capacity - sync gauge example."), + metric.WithDescription("Queue capacity - sync gauge example. [Development]"), metric.WithUnit("{items}"), ) errs = errors.Join(errs, err) builder.QueueLength, err = builder.meter.Int64ObservableGauge( "otelcol_queue_length", - metric.WithDescription("This metric is optional and therefore not initialized in NewTelemetryBuilder. [alpha]"), + metric.WithDescription("This metric is optional and therefore not initialized in NewTelemetryBuilder. [Alpha]"), metric.WithUnit("{items}"), ) errs = errors.Join(errs, err) builder.RequestDuration, err = builder.meter.Float64Histogram( "otelcol_request_duration", - metric.WithDescription("Duration of request [alpha]"), + metric.WithDescription("Duration of request [Alpha]"), metric.WithUnit("s"), metric.WithExplicitBucketBoundaries([]float64{1, 10, 100}...), ) diff --git a/cmd/mdatagen/internal/samplereceiver/internal/metadatatest/generated_telemetrytest.go b/cmd/mdatagen/internal/samplereceiver/internal/metadatatest/generated_telemetrytest.go index c89f21ad043..361a3643203 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 since v0.110.0]", Unit: "{times}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -57,7 +57,7 @@ func AssertEqualProcessRuntimeTotalAllocBytes(t *testing.T, tt *componenttest.Te func AssertEqualQueueCapacity(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_queue_capacity", - Description: "Queue capacity - sync gauge example.", + Description: "Queue capacity - sync gauge example. [Development]", Unit: "{items}", Data: metricdata.Gauge[int64]{ DataPoints: dps, @@ -71,7 +71,7 @@ func AssertEqualQueueCapacity(t *testing.T, tt *componenttest.Telemetry, dps []m func AssertEqualQueueLength(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_queue_length", - Description: "This metric is optional and therefore not initialized in NewTelemetryBuilder. [alpha]", + Description: "This metric is optional and therefore not initialized in NewTelemetryBuilder. [Alpha]", Unit: "{items}", Data: metricdata.Gauge[int64]{ DataPoints: dps, @@ -85,7 +85,7 @@ func AssertEqualQueueLength(t *testing.T, tt *componenttest.Telemetry, dps []met func AssertEqualRequestDuration(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.HistogramDataPoint[float64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_request_duration", - Description: "Duration of request [alpha]", + Description: "Duration of request [Alpha]", Unit: "s", Data: metricdata.Histogram[float64]{ Temporality: metricdata.CumulativeTemporality, diff --git a/cmd/mdatagen/internal/samplereceiver/metadata.yaml b/cmd/mdatagen/internal/samplereceiver/metadata.yaml index 4cc36fadaf9..b6a05b0df58 100644 --- a/cmd/mdatagen/internal/samplereceiver/metadata.yaml +++ b/cmd/mdatagen/internal/samplereceiver/metadata.yaml @@ -161,6 +161,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 unit: s sum: value_type: int @@ -184,6 +186,8 @@ 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 unit: s sum: value_type: double @@ -195,6 +199,8 @@ metrics: metric.input_type: enabled: true description: Monotonic cumulative sum int metric with string input_type enabled by default. + stability: + level: development unit: s sum: value_type: int @@ -207,6 +213,8 @@ metrics: optional.metric: enabled: false description: "[DEPRECATED] Gauge double metric disabled by default." + stability: + level: deprecated unit: "1" gauge: value_type: double @@ -217,6 +225,8 @@ metrics: optional.metric.empty_unit: enabled: false description: "[DEPRECATED] Gauge double metric disabled by default." + stability: + level: deprecated unit: "" gauge: value_type: double @@ -249,6 +259,8 @@ telemetry: queue_capacity: enabled: true description: Queue capacity - sync gauge example. + stability: + level: development unit: "{items}" gauge: value_type: int diff --git a/cmd/mdatagen/internal/samplescraper/documentation.md b/cmd/mdatagen/internal/samplescraper/documentation.md index 8334b4ba491..24fd43e6aea 100644 --- a/cmd/mdatagen/internal/samplescraper/documentation.md +++ b/cmd/mdatagen/internal/samplescraper/documentation.md @@ -18,9 +18,9 @@ Monotonic cumulative sum int metric enabled by default. The metric will be become optional soon. -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Int | Cumulative | true | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability | +| ---- | ----------- | ---------- | ----------------------- | --------- | --------- | +| s | Sum | Int | Cumulative | true | Development | #### Attributes @@ -38,9 +38,9 @@ The metric will be become optional soon. The metric will be removed soon. -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Double | Delta | false | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability | +| ---- | ----------- | ---------- | ----------------------- | --------- | --------- | +| s | Sum | Double | Delta | false | Deprecated | ### metric.input_type @@ -48,7 +48,7 @@ Monotonic cumulative sum int metric with string input_type enabled by default. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability | | ---- | ----------- | ---------- | ----------------------- | --------- | --------- | -| s | Sum | Int | Cumulative | true | beta | +| s | Sum | Int | Cumulative | true | Development | #### Attributes @@ -74,9 +74,9 @@ metrics: [DEPRECATED] Gauge double metric disabled by default. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| 1 | Gauge | Double | Deprecated | #### Attributes @@ -90,9 +90,9 @@ metrics: [DEPRECATED] Gauge double metric disabled by default. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| | Gauge | Double | Deprecated | #### Attributes diff --git a/cmd/mdatagen/internal/samplescraper/metadata.yaml b/cmd/mdatagen/internal/samplescraper/metadata.yaml index 6f9b4c95772..b1db0614716 100644 --- a/cmd/mdatagen/internal/samplescraper/metadata.yaml +++ b/cmd/mdatagen/internal/samplescraper/metadata.yaml @@ -104,6 +104,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 unit: s sum: value_type: int @@ -118,6 +120,8 @@ 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 unit: s sum: value_type: double @@ -129,7 +133,7 @@ metrics: metric.input_type: enabled: true stability: - level: beta + level: development description: Monotonic cumulative sum int metric with string input_type enabled by default. unit: s sum: @@ -143,6 +147,8 @@ metrics: optional.metric: enabled: false description: "[DEPRECATED] Gauge double metric disabled by default." + stability: + level: deprecated unit: "1" gauge: value_type: double @@ -153,6 +159,8 @@ metrics: optional.metric.empty_unit: enabled: false description: "[DEPRECATED] Gauge double metric disabled by default." + stability: + level: deprecated unit: "" gauge: value_type: double diff --git a/cmd/mdatagen/internal/testdata/async_metric.yaml b/cmd/mdatagen/internal/testdata/async_metric.yaml index 5d6949f28bf..0ab62684090 100644 --- a/cmd/mdatagen/internal/testdata/async_metric.yaml +++ b/cmd/mdatagen/internal/testdata/async_metric.yaml @@ -13,6 +13,8 @@ metrics: metric: enabled: true description: Description. + stability: + level: 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 3165d1a7101..c86c2d62662 100644 --- a/cmd/mdatagen/internal/testdata/invalid_aggregation.yaml +++ b/cmd/mdatagen/internal/testdata/invalid_aggregation.yaml @@ -15,6 +15,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 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 9e28b42120d..5651abe9b4f 100644 --- a/cmd/mdatagen/internal/testdata/invalid_input_type.yaml +++ b/cmd/mdatagen/internal/testdata/invalid_input_type.yaml @@ -11,6 +11,8 @@ metrics: system.cpu.time: enabled: true description: Total CPU seconds broken down by different states. + stability: + level: development unit: s sum: value_type: double diff --git a/cmd/mdatagen/internal/testdata/invalid_metric_stability.yaml b/cmd/mdatagen/internal/testdata/invalid_metric_stability.yaml new file mode 100644 index 00000000000..0906a5720b4 --- /dev/null +++ b/cmd/mdatagen/internal/testdata/invalid_metric_stability.yaml @@ -0,0 +1,24 @@ +type: metricreceiver + +status: + class: receiver + stability: + development: [logs] + beta: [traces] + stable: [metrics] + distributions: [contrib] + warnings: + - Any additional information that should be brought to the consumer's attention + +metrics: + default.metric: + enabled: true + description: Monotonic cumulative sum int metric enabled by default. + extended_documentation: The metric will be become optional soon. + stability: + level: development42 + unit: s + sum: + value_type: int + monotonic: true + aggregation_temporality: cumulative diff --git a/cmd/mdatagen/internal/testdata/metrics_and_type.yaml b/cmd/mdatagen/internal/testdata/metrics_and_type.yaml index 951f93f7d0a..e2591e04f6e 100644 --- a/cmd/mdatagen/internal/testdata/metrics_and_type.yaml +++ b/cmd/mdatagen/internal/testdata/metrics_and_type.yaml @@ -13,6 +13,8 @@ metrics: metric: enabled: true description: Description. + stability: + level: 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 02c14b6b1e7..f9425fa6df7 100644 --- a/cmd/mdatagen/internal/testdata/no_aggregation.yaml +++ b/cmd/mdatagen/internal/testdata/no_aggregation.yaml @@ -16,6 +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 unit: s sum: value_type: int diff --git a/cmd/mdatagen/internal/testdata/no_description_attr.yaml b/cmd/mdatagen/internal/testdata/no_description_attr.yaml index 1942f74e111..6d4744ca86e 100644 --- a/cmd/mdatagen/internal/testdata/no_description_attr.yaml +++ b/cmd/mdatagen/internal/testdata/no_description_attr.yaml @@ -23,6 +23,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 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 ab1dfafed32..c993152f3f9 100644 --- a/cmd/mdatagen/internal/testdata/no_enabled.yaml +++ b/cmd/mdatagen/internal/testdata/no_enabled.yaml @@ -10,6 +10,8 @@ status: metrics: system.cpu.time: description: Total CPU seconds broken down by different states. + stability: + level: 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 de9cbd42087..0ef5dc10d9f 100644 --- a/cmd/mdatagen/internal/testdata/no_metric_description.yaml +++ b/cmd/mdatagen/internal/testdata/no_metric_description.yaml @@ -15,6 +15,8 @@ metrics: default.metric: enabled: true extended_documentation: The metric will be become optional soon. + stability: + level: development unit: s sum: value_type: int diff --git a/cmd/mdatagen/internal/testdata/no_metric_stability.yaml b/cmd/mdatagen/internal/testdata/no_metric_stability.yaml new file mode 100644 index 00000000000..eaf427370e3 --- /dev/null +++ b/cmd/mdatagen/internal/testdata/no_metric_stability.yaml @@ -0,0 +1,23 @@ +type: metricreceiver + +status: + class: receiver + stability: + development: [logs] + beta: [traces] + stable: [metrics] + distributions: [contrib] + warnings: + - Any additional information that should be brought to the consumer's attention + +metrics: + default.metric: + enabled: true + description: Monotonic cumulative sum int metric enabled by default. + extended_documentation: The metric will be become optional soon. + stability: ~ + unit: s + sum: + value_type: int + monotonic: true + aggregation_temporality: cumulative diff --git a/cmd/mdatagen/internal/testdata/no_metric_type.yaml b/cmd/mdatagen/internal/testdata/no_metric_type.yaml index 1f0e0283f2a..792e88ecefc 100644 --- a/cmd/mdatagen/internal/testdata/no_metric_type.yaml +++ b/cmd/mdatagen/internal/testdata/no_metric_type.yaml @@ -9,5 +9,7 @@ metrics: system.cpu.time: enabled: true description: Total CPU seconds broken down by different states. + stability: + level: 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 cc5c49a7c9a..9f55e10cf13 100644 --- a/cmd/mdatagen/internal/testdata/no_metric_unit.yaml +++ b/cmd/mdatagen/internal/testdata/no_metric_unit.yaml @@ -16,6 +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 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 2f99cecab58..9d2cf74de9a 100644 --- a/cmd/mdatagen/internal/testdata/no_monotonic.yaml +++ b/cmd/mdatagen/internal/testdata/no_monotonic.yaml @@ -16,6 +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 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 c267d218e75..0cc5f8e56f5 100644 --- a/cmd/mdatagen/internal/testdata/no_type_attr.yaml +++ b/cmd/mdatagen/internal/testdata/no_type_attr.yaml @@ -17,6 +17,8 @@ metrics: metric: enabled: true description: Metric. + stability: + level: 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 046f457b510..cdc2412d47d 100644 --- a/cmd/mdatagen/internal/testdata/no_value_type.yaml +++ b/cmd/mdatagen/internal/testdata/no_value_type.yaml @@ -15,6 +15,8 @@ metrics: system.cpu.time: enabled: true description: Total CPU seconds broken down by different states. + stability: + level: 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 572eab2f3bc..b6b48fd2aae 100644 --- a/cmd/mdatagen/internal/testdata/two_metric_types.yaml +++ b/cmd/mdatagen/internal/testdata/two_metric_types.yaml @@ -11,6 +11,8 @@ metrics: system.cpu.time: enabled: true description: Total CPU seconds broken down by different states. + stability: + level: 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 d86b5afe401..6e4bad5e281 100644 --- a/cmd/mdatagen/internal/testdata/unknown_metric_attribute.yaml +++ b/cmd/mdatagen/internal/testdata/unknown_metric_attribute.yaml @@ -11,6 +11,8 @@ metrics: system.cpu.time: enabled: true description: Total CPU seconds broken down by different states. + stability: + level: 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 1a4890045d8..1231e7282ac 100644 --- a/cmd/mdatagen/internal/testdata/unknown_value_type.yaml +++ b/cmd/mdatagen/internal/testdata/unknown_value_type.yaml @@ -11,6 +11,8 @@ metrics: system.cpu.time: enabled: true description: Total CPU seconds broken down by different states. + stability: + level: 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 a3348712f8b..4d07147fa10 100644 --- a/cmd/mdatagen/internal/testdata/unused_attribute.yaml +++ b/cmd/mdatagen/internal/testdata/unused_attribute.yaml @@ -26,6 +26,8 @@ metrics: metric: enabled: true description: Metric. + stability: + level: development unit: "1" gauge: value_type: double @@ -36,6 +38,8 @@ telemetry: metric: enabled: true description: Metric. + stability: + level: development unit: "1" gauge: value_type: double diff --git a/cmd/mdatagen/internal/testdata/with_conditional_attribute.yaml b/cmd/mdatagen/internal/testdata/with_conditional_attribute.yaml index 728177542a2..d3f4af8e07d 100644 --- a/cmd/mdatagen/internal/testdata/with_conditional_attribute.yaml +++ b/cmd/mdatagen/internal/testdata/with_conditional_attribute.yaml @@ -22,6 +22,8 @@ metrics: metric: enabled: true description: Metric. + stability: + level: development unit: "1" gauge: value_type: double diff --git a/cmd/mdatagen/metadata-schema.yaml b/cmd/mdatagen/metadata-schema.yaml index bab81a9a18c..b62ec056217 100644 --- a/cmd/mdatagen/metadata-schema.yaml +++ b/cmd/mdatagen/metadata-schema.yaml @@ -122,9 +122,9 @@ metrics: input_type: string # Optional: array of attributes that were defined in the attributes section that are emitted by this metric. attributes: [string] - # Optional: the metric stability + # Required: the metric stability stability: - # Optional: the level of stability + # Required: the level of stability level: # Optional: the version current stability was introduced from: diff --git a/exporter/exporterhelper/documentation.md b/exporter/exporterhelper/documentation.md index 9b00977f9dc..095309bed21 100644 --- a/exporter/exporterhelper/documentation.md +++ b/exporter/exporterhelper/documentation.md @@ -8,104 +8,104 @@ The following telemetry is emitted by this component. ### otelcol_exporter_enqueue_failed_log_records -Number of log records failed to be added to the sending queue. [alpha] +Number of log records failed to be added to the sending queue. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {records} | Sum | Int | true | alpha | +| {records} | Sum | Int | true | Alpha | ### otelcol_exporter_enqueue_failed_metric_points -Number of metric points failed to be added to the sending queue. [alpha] +Number of metric points failed to be added to the sending queue. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {datapoints} | Sum | Int | true | alpha | +| {datapoints} | Sum | Int | true | Alpha | ### otelcol_exporter_enqueue_failed_spans -Number of spans failed to be added to the sending queue. [alpha] +Number of spans failed to be added to the sending queue. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {spans} | Sum | Int | true | alpha | +| {spans} | Sum | Int | true | Alpha | ### otelcol_exporter_queue_batch_send_size -Number of units in the batch +Number of units in the batch [Development] -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {units} | Histogram | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {units} | Histogram | Int | Development | ### otelcol_exporter_queue_batch_send_size_bytes -Number of bytes in batch that was sent. Only available on detailed level. +Number of bytes in batch that was sent. Only available on detailed level. [Development] -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Histogram | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| By | Histogram | Int | Development | ### otelcol_exporter_queue_capacity -Fixed capacity of the retry queue (in batches). [alpha] +Fixed capacity of the retry queue (in batches). [Alpha] | Unit | Metric Type | Value Type | Stability | | ---- | ----------- | ---------- | --------- | -| {batches} | Gauge | Int | alpha | +| {batches} | Gauge | Int | Alpha | ### otelcol_exporter_queue_size -Current size of the retry queue (in batches). [alpha] +Current size of the retry queue (in batches). [Alpha] | Unit | Metric Type | Value Type | Stability | | ---- | ----------- | ---------- | --------- | -| {batches} | Gauge | Int | alpha | +| {batches} | Gauge | Int | Alpha | ### otelcol_exporter_send_failed_log_records -Number of log records in failed attempts to send to destination. [alpha] +Number of log records in failed attempts to send to destination. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {records} | Sum | Int | true | alpha | +| {records} | Sum | Int | true | Alpha | ### otelcol_exporter_send_failed_metric_points -Number of metric points in failed attempts to send to destination. [alpha] +Number of metric points in failed attempts to send to destination. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {datapoints} | Sum | Int | true | alpha | +| {datapoints} | Sum | Int | true | Alpha | ### otelcol_exporter_send_failed_spans -Number of spans in failed attempts to send to destination. [alpha] +Number of spans in failed attempts to send to destination. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {spans} | Sum | Int | true | alpha | +| {spans} | Sum | Int | true | Alpha | ### otelcol_exporter_sent_log_records -Number of log record successfully sent to destination. [alpha] +Number of log record successfully sent to destination. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {records} | Sum | Int | true | alpha | +| {records} | Sum | Int | true | Alpha | ### otelcol_exporter_sent_metric_points -Number of metric points successfully sent to destination. [alpha] +Number of metric points successfully sent to destination. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {datapoints} | Sum | Int | true | alpha | +| {datapoints} | Sum | Int | true | Alpha | ### otelcol_exporter_sent_spans -Number of spans successfully sent to destination. [alpha] +Number of spans successfully sent to destination. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {spans} | Sum | Int | true | alpha | +| {spans} | Sum | Int | true | Alpha | diff --git a/exporter/exporterhelper/internal/metadata/generated_telemetry.go b/exporter/exporterhelper/internal/metadata/generated_telemetry.go index 66114dd2d3c..510cb29002d 100644 --- a/exporter/exporterhelper/internal/metadata/generated_telemetry.go +++ b/exporter/exporterhelper/internal/metadata/generated_telemetry.go @@ -114,81 +114,81 @@ func NewTelemetryBuilder(settings component.TelemetrySettings, options ...Teleme var err, errs error builder.ExporterEnqueueFailedLogRecords, err = builder.meter.Int64Counter( "otelcol_exporter_enqueue_failed_log_records", - metric.WithDescription("Number of log records failed to be added to the sending queue. [alpha]"), + metric.WithDescription("Number of log records failed to be added to the sending queue. [Alpha]"), metric.WithUnit("{records}"), ) errs = errors.Join(errs, err) builder.ExporterEnqueueFailedMetricPoints, err = builder.meter.Int64Counter( "otelcol_exporter_enqueue_failed_metric_points", - metric.WithDescription("Number of metric points failed to be added to the sending queue. [alpha]"), + metric.WithDescription("Number of metric points failed to be added to the sending queue. [Alpha]"), metric.WithUnit("{datapoints}"), ) errs = errors.Join(errs, err) builder.ExporterEnqueueFailedSpans, err = builder.meter.Int64Counter( "otelcol_exporter_enqueue_failed_spans", - metric.WithDescription("Number of spans failed to be added to the sending queue. [alpha]"), + metric.WithDescription("Number of spans failed to be added to the sending queue. [Alpha]"), metric.WithUnit("{spans}"), ) errs = errors.Join(errs, err) builder.ExporterQueueBatchSendSize, err = builder.meter.Int64Histogram( "otelcol_exporter_queue_batch_send_size", - metric.WithDescription("Number of units in the batch"), + metric.WithDescription("Number of units in the batch [Development]"), metric.WithUnit("{units}"), metric.WithExplicitBucketBoundaries([]float64{10, 25, 50, 75, 100, 250, 500, 750, 1000, 2000, 3000, 4000, 5000, 6000, 7000, 8000, 9000, 10000, 20000, 30000, 50000, 100000}...), ) errs = errors.Join(errs, err) builder.ExporterQueueBatchSendSizeBytes, err = builder.meter.Int64Histogram( "otelcol_exporter_queue_batch_send_size_bytes", - metric.WithDescription("Number of bytes in batch that was sent. Only available on detailed level."), + metric.WithDescription("Number of bytes in batch that was sent. Only available on detailed level. [Development]"), metric.WithUnit("By"), metric.WithExplicitBucketBoundaries([]float64{10, 25, 50, 75, 100, 250, 500, 750, 1000, 2000, 3000, 4000, 5000, 6000}...), ) errs = errors.Join(errs, err) builder.ExporterQueueCapacity, err = builder.meter.Int64ObservableGauge( "otelcol_exporter_queue_capacity", - metric.WithDescription("Fixed capacity of the retry queue (in batches). [alpha]"), + metric.WithDescription("Fixed capacity of the retry queue (in batches). [Alpha]"), metric.WithUnit("{batches}"), ) errs = errors.Join(errs, err) builder.ExporterQueueSize, err = builder.meter.Int64ObservableGauge( "otelcol_exporter_queue_size", - metric.WithDescription("Current size of the retry queue (in batches). [alpha]"), + metric.WithDescription("Current size of the retry queue (in batches). [Alpha]"), metric.WithUnit("{batches}"), ) errs = errors.Join(errs, err) builder.ExporterSendFailedLogRecords, err = builder.meter.Int64Counter( "otelcol_exporter_send_failed_log_records", - metric.WithDescription("Number of log records in failed attempts to send to destination. [alpha]"), + metric.WithDescription("Number of log records in failed attempts to send to destination. [Alpha]"), metric.WithUnit("{records}"), ) errs = errors.Join(errs, err) builder.ExporterSendFailedMetricPoints, err = builder.meter.Int64Counter( "otelcol_exporter_send_failed_metric_points", - metric.WithDescription("Number of metric points in failed attempts to send to destination. [alpha]"), + metric.WithDescription("Number of metric points in failed attempts to send to destination. [Alpha]"), metric.WithUnit("{datapoints}"), ) errs = errors.Join(errs, err) builder.ExporterSendFailedSpans, err = builder.meter.Int64Counter( "otelcol_exporter_send_failed_spans", - metric.WithDescription("Number of spans in failed attempts to send to destination. [alpha]"), + metric.WithDescription("Number of spans in failed attempts to send to destination. [Alpha]"), metric.WithUnit("{spans}"), ) errs = errors.Join(errs, err) builder.ExporterSentLogRecords, err = builder.meter.Int64Counter( "otelcol_exporter_sent_log_records", - metric.WithDescription("Number of log record successfully sent to destination. [alpha]"), + metric.WithDescription("Number of log record successfully sent to destination. [Alpha]"), metric.WithUnit("{records}"), ) errs = errors.Join(errs, err) builder.ExporterSentMetricPoints, err = builder.meter.Int64Counter( "otelcol_exporter_sent_metric_points", - metric.WithDescription("Number of metric points successfully sent to destination. [alpha]"), + metric.WithDescription("Number of metric points successfully sent to destination. [Alpha]"), metric.WithUnit("{datapoints}"), ) errs = errors.Join(errs, err) builder.ExporterSentSpans, err = builder.meter.Int64Counter( "otelcol_exporter_sent_spans", - metric.WithDescription("Number of spans successfully sent to destination. [alpha]"), + metric.WithDescription("Number of spans successfully sent to destination. [Alpha]"), metric.WithUnit("{spans}"), ) errs = errors.Join(errs, err) diff --git a/exporter/exporterhelper/internal/metadatatest/generated_telemetrytest.go b/exporter/exporterhelper/internal/metadatatest/generated_telemetrytest.go index 71d1763ce5d..7096bc471f7 100644 --- a/exporter/exporterhelper/internal/metadatatest/generated_telemetrytest.go +++ b/exporter/exporterhelper/internal/metadatatest/generated_telemetrytest.go @@ -15,7 +15,7 @@ import ( func AssertEqualExporterEnqueueFailedLogRecords(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_exporter_enqueue_failed_log_records", - Description: "Number of log records failed to be added to the sending queue. [alpha]", + Description: "Number of log records failed to be added to the sending queue. [Alpha]", Unit: "{records}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -31,7 +31,7 @@ func AssertEqualExporterEnqueueFailedLogRecords(t *testing.T, tt *componenttest. func AssertEqualExporterEnqueueFailedMetricPoints(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_exporter_enqueue_failed_metric_points", - Description: "Number of metric points failed to be added to the sending queue. [alpha]", + Description: "Number of metric points failed to be added to the sending queue. [Alpha]", Unit: "{datapoints}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -47,7 +47,7 @@ func AssertEqualExporterEnqueueFailedMetricPoints(t *testing.T, tt *componenttes func AssertEqualExporterEnqueueFailedSpans(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_exporter_enqueue_failed_spans", - Description: "Number of spans failed to be added to the sending queue. [alpha]", + Description: "Number of spans failed to be added to the sending queue. [Alpha]", Unit: "{spans}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -63,7 +63,7 @@ func AssertEqualExporterEnqueueFailedSpans(t *testing.T, tt *componenttest.Telem func AssertEqualExporterQueueBatchSendSize(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.HistogramDataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_exporter_queue_batch_send_size", - Description: "Number of units in the batch", + Description: "Number of units in the batch [Development]", Unit: "{units}", Data: metricdata.Histogram[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -78,7 +78,7 @@ func AssertEqualExporterQueueBatchSendSize(t *testing.T, tt *componenttest.Telem func AssertEqualExporterQueueBatchSendSizeBytes(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.HistogramDataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_exporter_queue_batch_send_size_bytes", - Description: "Number of bytes in batch that was sent. Only available on detailed level.", + Description: "Number of bytes in batch that was sent. Only available on detailed level. [Development]", Unit: "By", Data: metricdata.Histogram[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -93,7 +93,7 @@ func AssertEqualExporterQueueBatchSendSizeBytes(t *testing.T, tt *componenttest. func AssertEqualExporterQueueCapacity(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_exporter_queue_capacity", - Description: "Fixed capacity of the retry queue (in batches). [alpha]", + Description: "Fixed capacity of the retry queue (in batches). [Alpha]", Unit: "{batches}", Data: metricdata.Gauge[int64]{ DataPoints: dps, @@ -107,7 +107,7 @@ func AssertEqualExporterQueueCapacity(t *testing.T, tt *componenttest.Telemetry, func AssertEqualExporterQueueSize(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_exporter_queue_size", - Description: "Current size of the retry queue (in batches). [alpha]", + Description: "Current size of the retry queue (in batches). [Alpha]", Unit: "{batches}", Data: metricdata.Gauge[int64]{ DataPoints: dps, @@ -121,7 +121,7 @@ func AssertEqualExporterQueueSize(t *testing.T, tt *componenttest.Telemetry, dps func AssertEqualExporterSendFailedLogRecords(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_exporter_send_failed_log_records", - Description: "Number of log records in failed attempts to send to destination. [alpha]", + Description: "Number of log records in failed attempts to send to destination. [Alpha]", Unit: "{records}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -137,7 +137,7 @@ func AssertEqualExporterSendFailedLogRecords(t *testing.T, tt *componenttest.Tel func AssertEqualExporterSendFailedMetricPoints(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_exporter_send_failed_metric_points", - Description: "Number of metric points in failed attempts to send to destination. [alpha]", + Description: "Number of metric points in failed attempts to send to destination. [Alpha]", Unit: "{datapoints}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -153,7 +153,7 @@ func AssertEqualExporterSendFailedMetricPoints(t *testing.T, tt *componenttest.T func AssertEqualExporterSendFailedSpans(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_exporter_send_failed_spans", - Description: "Number of spans in failed attempts to send to destination. [alpha]", + Description: "Number of spans in failed attempts to send to destination. [Alpha]", Unit: "{spans}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -169,7 +169,7 @@ func AssertEqualExporterSendFailedSpans(t *testing.T, tt *componenttest.Telemetr func AssertEqualExporterSentLogRecords(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_exporter_sent_log_records", - Description: "Number of log record successfully sent to destination. [alpha]", + Description: "Number of log record successfully sent to destination. [Alpha]", Unit: "{records}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -185,7 +185,7 @@ func AssertEqualExporterSentLogRecords(t *testing.T, tt *componenttest.Telemetry func AssertEqualExporterSentMetricPoints(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_exporter_sent_metric_points", - Description: "Number of metric points successfully sent to destination. [alpha]", + Description: "Number of metric points successfully sent to destination. [Alpha]", Unit: "{datapoints}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -201,7 +201,7 @@ func AssertEqualExporterSentMetricPoints(t *testing.T, tt *componenttest.Telemet func AssertEqualExporterSentSpans(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_exporter_sent_spans", - Description: "Number of spans successfully sent to destination. [alpha]", + Description: "Number of spans successfully sent to destination. [Alpha]", Unit: "{spans}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, diff --git a/exporter/exporterhelper/metadata.yaml b/exporter/exporterhelper/metadata.yaml index 9212c3ec221..baa606a08fc 100644 --- a/exporter/exporterhelper/metadata.yaml +++ b/exporter/exporterhelper/metadata.yaml @@ -46,6 +46,8 @@ telemetry: exporter_queue_batch_send_size: enabled: true description: Number of units in the batch + stability: + level: development unit: "{units}" histogram: value_type: int @@ -78,6 +80,8 @@ 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 unit: By histogram: value_type: int diff --git a/processor/batchprocessor/documentation.md b/processor/batchprocessor/documentation.md index f7d372be72c..90eb7a38914 100644 --- a/processor/batchprocessor/documentation.md +++ b/processor/batchprocessor/documentation.md @@ -8,40 +8,40 @@ The following telemetry is emitted by this component. ### otelcol_processor_batch_batch_send_size -Number of units in the batch +Number of units in the batch [Development] -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {units} | Histogram | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {units} | Histogram | Int | Development | ### otelcol_processor_batch_batch_send_size_bytes -Number of bytes in batch that was sent. Only available on detailed level. +Number of bytes in batch that was sent. Only available on detailed level. [Development] -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Histogram | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| By | Histogram | Int | Development | ### otelcol_processor_batch_batch_size_trigger_send -Number of times the batch was sent due to a size trigger +Number of times the batch was sent due to a size trigger [Development] -| Unit | Metric Type | Value Type | Monotonic | -| ---- | ----------- | ---------- | --------- | -| {times} | Sum | Int | true | +| Unit | Metric Type | Value Type | Monotonic | Stability | +| ---- | ----------- | ---------- | --------- | --------- | +| {times} | Sum | Int | true | Development | ### otelcol_processor_batch_metadata_cardinality -Number of distinct metadata value combinations being processed +Number of distinct metadata value combinations being processed [Development] -| Unit | Metric Type | Value Type | Monotonic | -| ---- | ----------- | ---------- | --------- | -| {combinations} | Sum | Int | false | +| Unit | Metric Type | Value Type | Monotonic | Stability | +| ---- | ----------- | ---------- | --------- | --------- | +| {combinations} | Sum | Int | false | Development | ### otelcol_processor_batch_timeout_trigger_send -Number of times the batch was sent due to a timeout trigger +Number of times the batch was sent due to a timeout trigger [Development] -| Unit | Metric Type | Value Type | Monotonic | -| ---- | ----------- | ---------- | --------- | -| {times} | Sum | Int | true | +| Unit | Metric Type | Value Type | Monotonic | Stability | +| ---- | ----------- | ---------- | --------- | --------- | +| {times} | Sum | Int | true | Development | diff --git a/processor/batchprocessor/internal/metadata/generated_telemetry.go b/processor/batchprocessor/internal/metadata/generated_telemetry.go index 49bd4e75d60..eecfe3fd23b 100644 --- a/processor/batchprocessor/internal/metadata/generated_telemetry.go +++ b/processor/batchprocessor/internal/metadata/generated_telemetry.go @@ -91,33 +91,33 @@ func NewTelemetryBuilder(settings component.TelemetrySettings, options ...Teleme var err, errs error builder.ProcessorBatchBatchSendSize, err = builder.meter.Int64Histogram( "otelcol_processor_batch_batch_send_size", - metric.WithDescription("Number of units in the batch"), + metric.WithDescription("Number of units in the batch [Development]"), metric.WithUnit("{units}"), metric.WithExplicitBucketBoundaries([]float64{10, 25, 50, 75, 100, 250, 500, 750, 1000, 2000, 3000, 4000, 5000, 6000, 7000, 8000, 9000, 10000, 20000, 30000, 50000, 100000}...), ) errs = errors.Join(errs, err) builder.ProcessorBatchBatchSendSizeBytes, err = builder.meter.Int64Histogram( "otelcol_processor_batch_batch_send_size_bytes", - metric.WithDescription("Number of bytes in batch that was sent. Only available on detailed level."), + metric.WithDescription("Number of bytes in batch that was sent. Only available on detailed level. [Development]"), metric.WithUnit("By"), metric.WithExplicitBucketBoundaries([]float64{10, 25, 50, 75, 100, 250, 500, 750, 1000, 2000, 3000, 4000, 5000, 6000, 7000, 8000, 9000, 10000, 20000, 30000, 50000, 100000, 200000, 300000, 400000, 500000, 600000, 700000, 800000, 900000, 1e+06, 2e+06, 3e+06, 4e+06, 5e+06, 6e+06, 7e+06, 8e+06, 9e+06}...), ) errs = errors.Join(errs, err) builder.ProcessorBatchBatchSizeTriggerSend, err = builder.meter.Int64Counter( "otelcol_processor_batch_batch_size_trigger_send", - metric.WithDescription("Number of times the batch was sent due to a size trigger"), + metric.WithDescription("Number of times the batch was sent due to a size trigger [Development]"), metric.WithUnit("{times}"), ) errs = errors.Join(errs, err) builder.ProcessorBatchMetadataCardinality, err = builder.meter.Int64ObservableUpDownCounter( "otelcol_processor_batch_metadata_cardinality", - metric.WithDescription("Number of distinct metadata value combinations being processed"), + metric.WithDescription("Number of distinct metadata value combinations being processed [Development]"), metric.WithUnit("{combinations}"), ) errs = errors.Join(errs, err) builder.ProcessorBatchTimeoutTriggerSend, err = builder.meter.Int64Counter( "otelcol_processor_batch_timeout_trigger_send", - metric.WithDescription("Number of times the batch was sent due to a timeout trigger"), + metric.WithDescription("Number of times the batch was sent due to a timeout trigger [Development]"), metric.WithUnit("{times}"), ) errs = errors.Join(errs, err) diff --git a/processor/batchprocessor/internal/metadatatest/generated_telemetrytest.go b/processor/batchprocessor/internal/metadatatest/generated_telemetrytest.go index 335bb0006a5..925d5ec4e4c 100644 --- a/processor/batchprocessor/internal/metadatatest/generated_telemetrytest.go +++ b/processor/batchprocessor/internal/metadatatest/generated_telemetrytest.go @@ -25,7 +25,7 @@ func NewSettings(tt *componenttest.Telemetry) processor.Settings { func AssertEqualProcessorBatchBatchSendSize(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.HistogramDataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_processor_batch_batch_send_size", - Description: "Number of units in the batch", + Description: "Number of units in the batch [Development]", Unit: "{units}", Data: metricdata.Histogram[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -40,7 +40,7 @@ func AssertEqualProcessorBatchBatchSendSize(t *testing.T, tt *componenttest.Tele func AssertEqualProcessorBatchBatchSendSizeBytes(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.HistogramDataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_processor_batch_batch_send_size_bytes", - Description: "Number of bytes in batch that was sent. Only available on detailed level.", + Description: "Number of bytes in batch that was sent. Only available on detailed level. [Development]", Unit: "By", Data: metricdata.Histogram[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -55,7 +55,7 @@ func AssertEqualProcessorBatchBatchSendSizeBytes(t *testing.T, tt *componenttest func AssertEqualProcessorBatchBatchSizeTriggerSend(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_processor_batch_batch_size_trigger_send", - Description: "Number of times the batch was sent due to a size trigger", + Description: "Number of times the batch was sent due to a size trigger [Development]", Unit: "{times}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -71,7 +71,7 @@ func AssertEqualProcessorBatchBatchSizeTriggerSend(t *testing.T, tt *componentte func AssertEqualProcessorBatchMetadataCardinality(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_processor_batch_metadata_cardinality", - Description: "Number of distinct metadata value combinations being processed", + Description: "Number of distinct metadata value combinations being processed [Development]", Unit: "{combinations}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -87,7 +87,7 @@ func AssertEqualProcessorBatchMetadataCardinality(t *testing.T, tt *componenttes func AssertEqualProcessorBatchTimeoutTriggerSend(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_processor_batch_timeout_trigger_send", - Description: "Number of times the batch was sent due to a timeout trigger", + Description: "Number of times the batch was sent due to a timeout trigger [Development]", Unit: "{times}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, diff --git a/processor/batchprocessor/metadata.yaml b/processor/batchprocessor/metadata.yaml index 12732231005..a843bfb18d4 100644 --- a/processor/batchprocessor/metadata.yaml +++ b/processor/batchprocessor/metadata.yaml @@ -14,6 +14,8 @@ telemetry: metrics: processor_batch_batch_send_size: enabled: true + stability: + level: development description: Number of units in the batch unit: "{units}" histogram: @@ -45,6 +47,8 @@ telemetry: ] processor_batch_batch_send_size_bytes: enabled: true + stability: + level: development description: Number of bytes in batch that was sent. Only available on detailed level. unit: By histogram: @@ -93,6 +97,8 @@ telemetry: ] processor_batch_batch_size_trigger_send: enabled: true + stability: + level: development description: Number of times the batch was sent due to a size trigger unit: "{times}" sum: @@ -100,6 +106,8 @@ telemetry: monotonic: true processor_batch_metadata_cardinality: enabled: true + stability: + level: development description: Number of distinct metadata value combinations being processed unit: "{combinations}" sum: @@ -107,6 +115,8 @@ telemetry: async: true processor_batch_timeout_trigger_send: enabled: true + stability: + level: 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 097eb98977a..62fb21f99cb 100644 --- a/processor/memorylimiterprocessor/documentation.md +++ b/processor/memorylimiterprocessor/documentation.md @@ -8,48 +8,48 @@ 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 since v0.110.0] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {records} | Sum | Int | true | deprecated | +| {records} | Sum | Int | true | Deprecated | ### 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 since v0.110.0] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {datapoints} | Sum | Int | true | deprecated | +| {datapoints} | Sum | Int | true | Deprecated | ### 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 since v0.110.0] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {spans} | Sum | Int | true | deprecated | +| {spans} | Sum | Int | true | Deprecated | ### 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 since v0.110.0] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {records} | Sum | Int | true | deprecated | +| {records} | Sum | Int | true | Deprecated | ### 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 since v0.110.0] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {datapoints} | Sum | Int | true | deprecated | +| {datapoints} | Sum | Int | true | Deprecated | ### 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 since v0.110.0] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {spans} | Sum | Int | true | deprecated | +| {spans} | Sum | Int | true | Deprecated | diff --git a/processor/memorylimiterprocessor/internal/metadata/generated_telemetry.go b/processor/memorylimiterprocessor/internal/metadata/generated_telemetry.go index a7fd18a058b..176b5f1d864 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 since v0.110.0]"), 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 since v0.110.0]"), 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 since v0.110.0]"), 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 since v0.110.0]"), 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 since v0.110.0]"), 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 since v0.110.0]"), 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 e595cbef6c6..0f931acdd80 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 since v0.110.0]", 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 since v0.110.0]", 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 since v0.110.0]", 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 since v0.110.0]", 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 since v0.110.0]", 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 since v0.110.0]", Unit: "{spans}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, diff --git a/processor/processorhelper/documentation.md b/processor/processorhelper/documentation.md index 2fe9c273109..780f1312a32 100644 --- a/processor/processorhelper/documentation.md +++ b/processor/processorhelper/documentation.md @@ -8,24 +8,24 @@ The following telemetry is emitted by this component. ### otelcol_processor_incoming_items -Number of items passed to the processor. [alpha] +Number of items passed to the processor. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {items} | Sum | Int | true | alpha | +| {items} | Sum | Int | true | Alpha | ### otelcol_processor_internal_duration -Duration of time taken to process a batch of telemetry data through the processor. [alpha] +Duration of time taken to process a batch of telemetry data through the processor. [Alpha] | Unit | Metric Type | Value Type | Stability | | ---- | ----------- | ---------- | --------- | -| s | Histogram | Double | alpha | +| s | Histogram | Double | Alpha | ### otelcol_processor_outgoing_items -Number of items emitted from the processor. [alpha] +Number of items emitted from the processor. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {items} | Sum | Int | true | alpha | +| {items} | Sum | Int | true | Alpha | diff --git a/processor/processorhelper/internal/metadata/generated_telemetry.go b/processor/processorhelper/internal/metadata/generated_telemetry.go index 7ea57e264cc..44247cf128f 100644 --- a/processor/processorhelper/internal/metadata/generated_telemetry.go +++ b/processor/processorhelper/internal/metadata/generated_telemetry.go @@ -62,19 +62,19 @@ func NewTelemetryBuilder(settings component.TelemetrySettings, options ...Teleme var err, errs error builder.ProcessorIncomingItems, err = builder.meter.Int64Counter( "otelcol_processor_incoming_items", - metric.WithDescription("Number of items passed to the processor. [alpha]"), + metric.WithDescription("Number of items passed to the processor. [Alpha]"), metric.WithUnit("{items}"), ) errs = errors.Join(errs, err) builder.ProcessorInternalDuration, err = builder.meter.Float64Histogram( "otelcol_processor_internal_duration", - metric.WithDescription("Duration of time taken to process a batch of telemetry data through the processor. [alpha]"), + metric.WithDescription("Duration of time taken to process a batch of telemetry data through the processor. [Alpha]"), metric.WithUnit("s"), ) errs = errors.Join(errs, err) builder.ProcessorOutgoingItems, err = builder.meter.Int64Counter( "otelcol_processor_outgoing_items", - metric.WithDescription("Number of items emitted from the processor. [alpha]"), + metric.WithDescription("Number of items emitted from the processor. [Alpha]"), metric.WithUnit("{items}"), ) errs = errors.Join(errs, err) diff --git a/processor/processorhelper/internal/metadatatest/generated_telemetrytest.go b/processor/processorhelper/internal/metadatatest/generated_telemetrytest.go index 77ec5636f2e..cf5012f4080 100644 --- a/processor/processorhelper/internal/metadatatest/generated_telemetrytest.go +++ b/processor/processorhelper/internal/metadatatest/generated_telemetrytest.go @@ -15,7 +15,7 @@ import ( func AssertEqualProcessorIncomingItems(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_processor_incoming_items", - Description: "Number of items passed to the processor. [alpha]", + Description: "Number of items passed to the processor. [Alpha]", Unit: "{items}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -31,7 +31,7 @@ func AssertEqualProcessorIncomingItems(t *testing.T, tt *componenttest.Telemetry func AssertEqualProcessorInternalDuration(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.HistogramDataPoint[float64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_processor_internal_duration", - Description: "Duration of time taken to process a batch of telemetry data through the processor. [alpha]", + Description: "Duration of time taken to process a batch of telemetry data through the processor. [Alpha]", Unit: "s", Data: metricdata.Histogram[float64]{ Temporality: metricdata.CumulativeTemporality, @@ -46,7 +46,7 @@ func AssertEqualProcessorInternalDuration(t *testing.T, tt *componenttest.Teleme func AssertEqualProcessorOutgoingItems(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_processor_outgoing_items", - Description: "Number of items emitted from the processor. [alpha]", + Description: "Number of items emitted from the processor. [Alpha]", Unit: "{items}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, diff --git a/receiver/otlpreceiver/otlp_test.go b/receiver/otlpreceiver/otlp_test.go index 7e7e3deb8f4..16e53c7b44e 100644 --- a/receiver/otlpreceiver/otlp_test.go +++ b/receiver/otlpreceiver/otlp_test.go @@ -1322,7 +1322,7 @@ func assertReceiverTraces(t *testing.T, tt *componenttest.Telemetry, id componen metricdatatest.AssertEqual(t, metricdata.Metrics{ Name: "otelcol_receiver_failed_spans", - Description: "The number of spans that failed to be processed by the receiver due to internal errors. [alpha]", + Description: "The number of spans that failed to be processed by the receiver due to internal errors. [Alpha]", Unit: "{spans}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -1343,7 +1343,7 @@ func assertReceiverTraces(t *testing.T, tt *componenttest.Telemetry, id componen metricdatatest.AssertEqual(t, metricdata.Metrics{ Name: "otelcol_receiver_accepted_spans", - Description: "Number of spans successfully pushed into the pipeline. [alpha]", + Description: "Number of spans successfully pushed into the pipeline. [Alpha]", Unit: "{spans}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -1364,7 +1364,7 @@ func assertReceiverTraces(t *testing.T, tt *componenttest.Telemetry, id componen metricdatatest.AssertEqual(t, metricdata.Metrics{ Name: "otelcol_receiver_refused_spans", - Description: "Number of spans that could not be pushed into the pipeline. [alpha]", + Description: "Number of spans that could not be pushed into the pipeline. [Alpha]", Unit: "{spans}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -1441,7 +1441,7 @@ func assertReceiverMetrics(t *testing.T, tt *componenttest.Telemetry, id compone metricdatatest.AssertEqual(t, metricdata.Metrics{ Name: "otelcol_receiver_failed_metric_points", - Description: "The number of metric points that failed to be processed by the receiver due to internal errors. [alpha]", + Description: "The number of metric points that failed to be processed by the receiver due to internal errors. [Alpha]", Unit: "{datapoints}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -1462,7 +1462,7 @@ func assertReceiverMetrics(t *testing.T, tt *componenttest.Telemetry, id compone metricdatatest.AssertEqual(t, metricdata.Metrics{ Name: "otelcol_receiver_accepted_metric_points", - Description: "Number of metric points successfully pushed into the pipeline. [alpha]", + Description: "Number of metric points successfully pushed into the pipeline. [Alpha]", Unit: "{datapoints}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -1483,7 +1483,7 @@ func assertReceiverMetrics(t *testing.T, tt *componenttest.Telemetry, id compone metricdatatest.AssertEqual(t, metricdata.Metrics{ Name: "otelcol_receiver_refused_metric_points", - Description: "Number of metric points that could not be pushed into the pipeline. [alpha]", + Description: "Number of metric points that could not be pushed into the pipeline. [Alpha]", Unit: "{datapoints}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, diff --git a/receiver/receiverhelper/documentation.md b/receiver/receiverhelper/documentation.md index ed266fae300..e25eb5b9219 100644 --- a/receiver/receiverhelper/documentation.md +++ b/receiver/receiverhelper/documentation.md @@ -8,83 +8,83 @@ The following telemetry is emitted by this component. ### otelcol_receiver_accepted_log_records -Number of log records successfully pushed into the pipeline. [alpha] +Number of log records successfully pushed into the pipeline. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {records} | Sum | Int | true | alpha | +| {records} | Sum | Int | true | Alpha | ### otelcol_receiver_accepted_metric_points -Number of metric points successfully pushed into the pipeline. [alpha] +Number of metric points successfully pushed into the pipeline. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {datapoints} | Sum | Int | true | alpha | +| {datapoints} | Sum | Int | true | Alpha | ### otelcol_receiver_accepted_spans -Number of spans successfully pushed into the pipeline. [alpha] +Number of spans successfully pushed into the pipeline. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {spans} | Sum | Int | true | alpha | +| {spans} | Sum | Int | true | Alpha | ### otelcol_receiver_failed_log_records -The number of log records that failed to be processed by the receiver due to internal errors. [alpha] +The number of log records that failed to be processed by the receiver due to internal errors. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {records} | Sum | Int | true | alpha | +| {records} | Sum | Int | true | Alpha | ### otelcol_receiver_failed_metric_points -The number of metric points that failed to be processed by the receiver due to internal errors. [alpha] +The number of metric points that failed to be processed by the receiver due to internal errors. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {datapoints} | Sum | Int | true | alpha | +| {datapoints} | Sum | Int | true | Alpha | ### otelcol_receiver_failed_spans -The number of spans that failed to be processed by the receiver due to internal errors. [alpha] +The number of spans that failed to be processed by the receiver due to internal errors. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {spans} | Sum | Int | true | alpha | +| {spans} | Sum | Int | true | Alpha | ### otelcol_receiver_refused_log_records -Number of log records that could not be pushed into the pipeline. [alpha] +Number of log records that could not be pushed into the pipeline. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {records} | Sum | Int | true | alpha | +| {records} | Sum | Int | true | Alpha | ### otelcol_receiver_refused_metric_points -Number of metric points that could not be pushed into the pipeline. [alpha] +Number of metric points that could not be pushed into the pipeline. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {datapoints} | Sum | Int | true | alpha | +| {datapoints} | Sum | Int | true | Alpha | ### otelcol_receiver_refused_spans -Number of spans that could not be pushed into the pipeline. [alpha] +Number of spans that could not be pushed into the pipeline. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {spans} | Sum | Int | true | alpha | +| {spans} | Sum | Int | true | Alpha | ### otelcol_receiver_requests -The number of requests performed. [alpha] +The number of requests performed. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {requests} | Sum | Int | true | alpha | +| {requests} | Sum | Int | true | Alpha | #### Attributes diff --git a/receiver/receiverhelper/internal/metadata/generated_telemetry.go b/receiver/receiverhelper/internal/metadata/generated_telemetry.go index 962bc2e90fe..4409c14891f 100644 --- a/receiver/receiverhelper/internal/metadata/generated_telemetry.go +++ b/receiver/receiverhelper/internal/metadata/generated_telemetry.go @@ -69,61 +69,61 @@ func NewTelemetryBuilder(settings component.TelemetrySettings, options ...Teleme var err, errs error builder.ReceiverAcceptedLogRecords, err = builder.meter.Int64Counter( "otelcol_receiver_accepted_log_records", - metric.WithDescription("Number of log records successfully pushed into the pipeline. [alpha]"), + metric.WithDescription("Number of log records successfully pushed into the pipeline. [Alpha]"), metric.WithUnit("{records}"), ) errs = errors.Join(errs, err) builder.ReceiverAcceptedMetricPoints, err = builder.meter.Int64Counter( "otelcol_receiver_accepted_metric_points", - metric.WithDescription("Number of metric points successfully pushed into the pipeline. [alpha]"), + metric.WithDescription("Number of metric points successfully pushed into the pipeline. [Alpha]"), metric.WithUnit("{datapoints}"), ) errs = errors.Join(errs, err) builder.ReceiverAcceptedSpans, err = builder.meter.Int64Counter( "otelcol_receiver_accepted_spans", - metric.WithDescription("Number of spans successfully pushed into the pipeline. [alpha]"), + metric.WithDescription("Number of spans successfully pushed into the pipeline. [Alpha]"), metric.WithUnit("{spans}"), ) errs = errors.Join(errs, err) builder.ReceiverFailedLogRecords, err = builder.meter.Int64Counter( "otelcol_receiver_failed_log_records", - metric.WithDescription("The number of log records that failed to be processed by the receiver due to internal errors. [alpha]"), + metric.WithDescription("The number of log records that failed to be processed by the receiver due to internal errors. [Alpha]"), metric.WithUnit("{records}"), ) errs = errors.Join(errs, err) builder.ReceiverFailedMetricPoints, err = builder.meter.Int64Counter( "otelcol_receiver_failed_metric_points", - metric.WithDescription("The number of metric points that failed to be processed by the receiver due to internal errors. [alpha]"), + metric.WithDescription("The number of metric points that failed to be processed by the receiver due to internal errors. [Alpha]"), metric.WithUnit("{datapoints}"), ) errs = errors.Join(errs, err) builder.ReceiverFailedSpans, err = builder.meter.Int64Counter( "otelcol_receiver_failed_spans", - metric.WithDescription("The number of spans that failed to be processed by the receiver due to internal errors. [alpha]"), + metric.WithDescription("The number of spans that failed to be processed by the receiver due to internal errors. [Alpha]"), metric.WithUnit("{spans}"), ) errs = errors.Join(errs, err) builder.ReceiverRefusedLogRecords, err = builder.meter.Int64Counter( "otelcol_receiver_refused_log_records", - metric.WithDescription("Number of log records that could not be pushed into the pipeline. [alpha]"), + metric.WithDescription("Number of log records that could not be pushed into the pipeline. [Alpha]"), metric.WithUnit("{records}"), ) errs = errors.Join(errs, err) builder.ReceiverRefusedMetricPoints, err = builder.meter.Int64Counter( "otelcol_receiver_refused_metric_points", - metric.WithDescription("Number of metric points that could not be pushed into the pipeline. [alpha]"), + metric.WithDescription("Number of metric points that could not be pushed into the pipeline. [Alpha]"), metric.WithUnit("{datapoints}"), ) errs = errors.Join(errs, err) builder.ReceiverRefusedSpans, err = builder.meter.Int64Counter( "otelcol_receiver_refused_spans", - metric.WithDescription("Number of spans that could not be pushed into the pipeline. [alpha]"), + metric.WithDescription("Number of spans that could not be pushed into the pipeline. [Alpha]"), metric.WithUnit("{spans}"), ) errs = errors.Join(errs, err) builder.ReceiverRequests, err = builder.meter.Int64Counter( "otelcol_receiver_requests", - metric.WithDescription("The number of requests performed. [alpha]"), + metric.WithDescription("The number of requests performed. [Alpha]"), metric.WithUnit("{requests}"), ) errs = errors.Join(errs, err) diff --git a/receiver/receiverhelper/internal/metadatatest/generated_telemetrytest.go b/receiver/receiverhelper/internal/metadatatest/generated_telemetrytest.go index 199c88c22e8..d2ad658b53a 100644 --- a/receiver/receiverhelper/internal/metadatatest/generated_telemetrytest.go +++ b/receiver/receiverhelper/internal/metadatatest/generated_telemetrytest.go @@ -15,7 +15,7 @@ import ( func AssertEqualReceiverAcceptedLogRecords(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_receiver_accepted_log_records", - Description: "Number of log records successfully pushed into the pipeline. [alpha]", + Description: "Number of log records successfully pushed into the pipeline. [Alpha]", Unit: "{records}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -31,7 +31,7 @@ func AssertEqualReceiverAcceptedLogRecords(t *testing.T, tt *componenttest.Telem func AssertEqualReceiverAcceptedMetricPoints(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_receiver_accepted_metric_points", - Description: "Number of metric points successfully pushed into the pipeline. [alpha]", + Description: "Number of metric points successfully pushed into the pipeline. [Alpha]", Unit: "{datapoints}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -47,7 +47,7 @@ func AssertEqualReceiverAcceptedMetricPoints(t *testing.T, tt *componenttest.Tel func AssertEqualReceiverAcceptedSpans(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_receiver_accepted_spans", - Description: "Number of spans successfully pushed into the pipeline. [alpha]", + Description: "Number of spans successfully pushed into the pipeline. [Alpha]", Unit: "{spans}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -63,7 +63,7 @@ func AssertEqualReceiverAcceptedSpans(t *testing.T, tt *componenttest.Telemetry, func AssertEqualReceiverFailedLogRecords(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_receiver_failed_log_records", - Description: "The number of log records that failed to be processed by the receiver due to internal errors. [alpha]", + Description: "The number of log records that failed to be processed by the receiver due to internal errors. [Alpha]", Unit: "{records}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -79,7 +79,7 @@ func AssertEqualReceiverFailedLogRecords(t *testing.T, tt *componenttest.Telemet func AssertEqualReceiverFailedMetricPoints(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_receiver_failed_metric_points", - Description: "The number of metric points that failed to be processed by the receiver due to internal errors. [alpha]", + Description: "The number of metric points that failed to be processed by the receiver due to internal errors. [Alpha]", Unit: "{datapoints}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -95,7 +95,7 @@ func AssertEqualReceiverFailedMetricPoints(t *testing.T, tt *componenttest.Telem func AssertEqualReceiverFailedSpans(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_receiver_failed_spans", - Description: "The number of spans that failed to be processed by the receiver due to internal errors. [alpha]", + Description: "The number of spans that failed to be processed by the receiver due to internal errors. [Alpha]", Unit: "{spans}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -111,7 +111,7 @@ func AssertEqualReceiverFailedSpans(t *testing.T, tt *componenttest.Telemetry, d func AssertEqualReceiverRefusedLogRecords(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_receiver_refused_log_records", - Description: "Number of log records that could not be pushed into the pipeline. [alpha]", + Description: "Number of log records that could not be pushed into the pipeline. [Alpha]", Unit: "{records}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -127,7 +127,7 @@ func AssertEqualReceiverRefusedLogRecords(t *testing.T, tt *componenttest.Teleme func AssertEqualReceiverRefusedMetricPoints(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_receiver_refused_metric_points", - Description: "Number of metric points that could not be pushed into the pipeline. [alpha]", + Description: "Number of metric points that could not be pushed into the pipeline. [Alpha]", Unit: "{datapoints}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -143,7 +143,7 @@ func AssertEqualReceiverRefusedMetricPoints(t *testing.T, tt *componenttest.Tele func AssertEqualReceiverRefusedSpans(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_receiver_refused_spans", - Description: "Number of spans that could not be pushed into the pipeline. [alpha]", + Description: "Number of spans that could not be pushed into the pipeline. [Alpha]", Unit: "{spans}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -159,7 +159,7 @@ func AssertEqualReceiverRefusedSpans(t *testing.T, tt *componenttest.Telemetry, func AssertEqualReceiverRequests(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_receiver_requests", - Description: "The number of requests performed. [alpha]", + Description: "The number of requests performed. [Alpha]", Unit: "{requests}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, diff --git a/scraper/scraperhelper/documentation.md b/scraper/scraperhelper/documentation.md index caf74536bc7..0aa12afb608 100644 --- a/scraper/scraperhelper/documentation.md +++ b/scraper/scraperhelper/documentation.md @@ -8,32 +8,32 @@ The following telemetry is emitted by this component. ### otelcol_scraper_errored_log_records -Number of log records that were unable to be scraped. [alpha] +Number of log records that were unable to be scraped. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {datapoints} | Sum | Int | true | alpha | +| {datapoints} | Sum | Int | true | Alpha | ### otelcol_scraper_errored_metric_points -Number of metric points that were unable to be scraped. [alpha] +Number of metric points that were unable to be scraped. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {datapoints} | Sum | Int | true | alpha | +| {datapoints} | Sum | Int | true | Alpha | ### otelcol_scraper_scraped_log_records -Number of log records successfully scraped. [alpha] +Number of log records successfully scraped. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {datapoints} | Sum | Int | true | alpha | +| {datapoints} | Sum | Int | true | Alpha | ### otelcol_scraper_scraped_metric_points -Number of metric points successfully scraped. [alpha] +Number of metric points successfully scraped. [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| {datapoints} | Sum | Int | true | alpha | +| {datapoints} | Sum | Int | true | Alpha | diff --git a/scraper/scraperhelper/internal/metadata/generated_telemetry.go b/scraper/scraperhelper/internal/metadata/generated_telemetry.go index 035ff8fe842..a02dc64137c 100644 --- a/scraper/scraperhelper/internal/metadata/generated_telemetry.go +++ b/scraper/scraperhelper/internal/metadata/generated_telemetry.go @@ -63,25 +63,25 @@ func NewTelemetryBuilder(settings component.TelemetrySettings, options ...Teleme var err, errs error builder.ScraperErroredLogRecords, err = builder.meter.Int64Counter( "otelcol_scraper_errored_log_records", - metric.WithDescription("Number of log records that were unable to be scraped. [alpha]"), + metric.WithDescription("Number of log records that were unable to be scraped. [Alpha]"), metric.WithUnit("{datapoints}"), ) errs = errors.Join(errs, err) builder.ScraperErroredMetricPoints, err = builder.meter.Int64Counter( "otelcol_scraper_errored_metric_points", - metric.WithDescription("Number of metric points that were unable to be scraped. [alpha]"), + metric.WithDescription("Number of metric points that were unable to be scraped. [Alpha]"), metric.WithUnit("{datapoints}"), ) errs = errors.Join(errs, err) builder.ScraperScrapedLogRecords, err = builder.meter.Int64Counter( "otelcol_scraper_scraped_log_records", - metric.WithDescription("Number of log records successfully scraped. [alpha]"), + metric.WithDescription("Number of log records successfully scraped. [Alpha]"), metric.WithUnit("{datapoints}"), ) errs = errors.Join(errs, err) builder.ScraperScrapedMetricPoints, err = builder.meter.Int64Counter( "otelcol_scraper_scraped_metric_points", - metric.WithDescription("Number of metric points successfully scraped. [alpha]"), + metric.WithDescription("Number of metric points successfully scraped. [Alpha]"), metric.WithUnit("{datapoints}"), ) errs = errors.Join(errs, err) diff --git a/scraper/scraperhelper/internal/metadatatest/generated_telemetrytest.go b/scraper/scraperhelper/internal/metadatatest/generated_telemetrytest.go index ca65b6625ba..8e86843fdfb 100644 --- a/scraper/scraperhelper/internal/metadatatest/generated_telemetrytest.go +++ b/scraper/scraperhelper/internal/metadatatest/generated_telemetrytest.go @@ -15,7 +15,7 @@ import ( func AssertEqualScraperErroredLogRecords(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_scraper_errored_log_records", - Description: "Number of log records that were unable to be scraped. [alpha]", + Description: "Number of log records that were unable to be scraped. [Alpha]", Unit: "{datapoints}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -31,7 +31,7 @@ func AssertEqualScraperErroredLogRecords(t *testing.T, tt *componenttest.Telemet func AssertEqualScraperErroredMetricPoints(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_scraper_errored_metric_points", - Description: "Number of metric points that were unable to be scraped. [alpha]", + Description: "Number of metric points that were unable to be scraped. [Alpha]", Unit: "{datapoints}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -47,7 +47,7 @@ func AssertEqualScraperErroredMetricPoints(t *testing.T, tt *componenttest.Telem func AssertEqualScraperScrapedLogRecords(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_scraper_scraped_log_records", - Description: "Number of log records successfully scraped. [alpha]", + Description: "Number of log records successfully scraped. [Alpha]", Unit: "{datapoints}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -63,7 +63,7 @@ func AssertEqualScraperScrapedLogRecords(t *testing.T, tt *componenttest.Telemet func AssertEqualScraperScrapedMetricPoints(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_scraper_scraped_metric_points", - Description: "Number of metric points successfully scraped. [alpha]", + Description: "Number of metric points successfully scraped. [Alpha]", Unit: "{datapoints}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, diff --git a/service/documentation.md b/service/documentation.md index de9fa2e70f7..4c46bee5e11 100644 --- a/service/documentation.md +++ b/service/documentation.md @@ -8,96 +8,96 @@ The following telemetry is emitted by this component. ### otelcol.connector.consumed.items -Number of items passed to the connector. +Number of items passed to the connector. [Development] -| Unit | Metric Type | Value Type | Monotonic | -| ---- | ----------- | ---------- | --------- | -| {item} | Sum | Int | true | +| Unit | Metric Type | Value Type | Monotonic | Stability | +| ---- | ----------- | ---------- | --------- | --------- | +| {item} | Sum | Int | true | Development | ### otelcol.connector.produced.items -Number of items emitted from the connector. +Number of items emitted from the connector. [Development] -| Unit | Metric Type | Value Type | Monotonic | -| ---- | ----------- | ---------- | --------- | -| {item} | Sum | Int | true | +| Unit | Metric Type | Value Type | Monotonic | Stability | +| ---- | ----------- | ---------- | --------- | --------- | +| {item} | Sum | Int | true | Development | ### otelcol.exporter.consumed.items -Number of items passed to the exporter. +Number of items passed to the exporter. [Development] -| Unit | Metric Type | Value Type | Monotonic | -| ---- | ----------- | ---------- | --------- | -| {item} | Sum | Int | true | +| Unit | Metric Type | Value Type | Monotonic | Stability | +| ---- | ----------- | ---------- | --------- | --------- | +| {item} | Sum | Int | true | Development | ### otelcol_process_cpu_seconds -Total CPU user and system time in seconds [alpha] +Total CPU user and system time in seconds [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| s | Sum | Double | true | alpha | +| s | Sum | Double | true | Alpha | ### otelcol_process_memory_rss -Total physical memory (resident set size) [alpha] +Total physical memory (resident set size) [Alpha] | Unit | Metric Type | Value Type | Stability | | ---- | ----------- | ---------- | --------- | -| By | Gauge | Int | alpha | +| By | Gauge | Int | Alpha | ### otelcol_process_runtime_heap_alloc_bytes -Bytes of allocated heap objects (see 'go doc runtime.MemStats.HeapAlloc') [alpha] +Bytes of allocated heap objects (see 'go doc runtime.MemStats.HeapAlloc') [Alpha] | Unit | Metric Type | Value Type | Stability | | ---- | ----------- | ---------- | --------- | -| By | Gauge | Int | alpha | +| By | Gauge | Int | Alpha | ### otelcol_process_runtime_total_alloc_bytes -Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc') [alpha] +Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc') [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| By | Sum | Int | true | alpha | +| By | Sum | Int | true | Alpha | ### otelcol_process_runtime_total_sys_memory_bytes -Total bytes of memory obtained from the OS (see 'go doc runtime.MemStats.Sys') [alpha] +Total bytes of memory obtained from the OS (see 'go doc runtime.MemStats.Sys') [Alpha] | Unit | Metric Type | Value Type | Stability | | ---- | ----------- | ---------- | --------- | -| By | Gauge | Int | alpha | +| By | Gauge | Int | Alpha | ### otelcol_process_uptime -Uptime of the process [alpha] +Uptime of the process [Alpha] | Unit | Metric Type | Value Type | Monotonic | Stability | | ---- | ----------- | ---------- | --------- | --------- | -| s | Sum | Double | true | alpha | +| s | Sum | Double | true | Alpha | ### otelcol.processor.consumed.items -Number of items passed to the processor. +Number of items passed to the processor. [Development] -| Unit | Metric Type | Value Type | Monotonic | -| ---- | ----------- | ---------- | --------- | -| {item} | Sum | Int | true | +| Unit | Metric Type | Value Type | Monotonic | Stability | +| ---- | ----------- | ---------- | --------- | --------- | +| {item} | Sum | Int | true | Development | ### otelcol.processor.produced.items -Number of items emitted from the processor. +Number of items emitted from the processor. [Development] -| Unit | Metric Type | Value Type | Monotonic | -| ---- | ----------- | ---------- | --------- | -| {item} | Sum | Int | true | +| Unit | Metric Type | Value Type | Monotonic | Stability | +| ---- | ----------- | ---------- | --------- | --------- | +| {item} | Sum | Int | true | Development | ### otelcol.receiver.produced.items -Number of items emitted from the receiver. +Number of items emitted from the receiver. [Development] -| Unit | Metric Type | Value Type | Monotonic | -| ---- | ----------- | ---------- | --------- | -| {item} | Sum | Int | true | +| Unit | Metric Type | Value Type | Monotonic | Stability | +| ---- | ----------- | ---------- | --------- | --------- | +| {item} | Sum | Int | true | Development | diff --git a/service/internal/metadata/generated_telemetry.go b/service/internal/metadata/generated_telemetry.go index 9bdb0665c20..381f25019ba 100644 --- a/service/internal/metadata/generated_telemetry.go +++ b/service/internal/metadata/generated_telemetry.go @@ -189,109 +189,109 @@ func NewTelemetryBuilder(settings component.TelemetrySettings, options ...Teleme var err, errs error builder.ConnectorConsumedItems, err = builder.meter.Int64Counter( "otelcol.connector.consumed.items", - metric.WithDescription("Number of items passed to the connector."), + metric.WithDescription("Number of items passed to the connector. [Development]"), metric.WithUnit("{item}"), ) errs = errors.Join(errs, err) builder.ConnectorConsumedSize, err = builder.meter.Int64Counter( "otelcol.connector.consumed.size", - metric.WithDescription("Size of items passed to the connector, based on ProtoMarshaler.Sizer."), + metric.WithDescription("Size of items passed to the connector, based on ProtoMarshaler.Sizer. [Development]"), metric.WithUnit("{item}"), ) errs = errors.Join(errs, err) builder.ConnectorProducedItems, err = builder.meter.Int64Counter( "otelcol.connector.produced.items", - metric.WithDescription("Number of items emitted from the connector."), + metric.WithDescription("Number of items emitted from the connector. [Development]"), metric.WithUnit("{item}"), ) errs = errors.Join(errs, err) builder.ConnectorProducedSize, err = builder.meter.Int64Counter( "otelcol.connector.produced.size", - metric.WithDescription("Size of items emitted from the connector, based on ProtoMarshaler.Sizer."), + metric.WithDescription("Size of items emitted from the connector, based on ProtoMarshaler.Sizer. [Development]"), metric.WithUnit("{item}"), ) errs = errors.Join(errs, err) builder.ExporterConsumedItems, err = builder.meter.Int64Counter( "otelcol.exporter.consumed.items", - metric.WithDescription("Number of items passed to the exporter."), + metric.WithDescription("Number of items passed to the exporter. [Development]"), metric.WithUnit("{item}"), ) errs = errors.Join(errs, err) builder.ExporterConsumedSize, err = builder.meter.Int64Counter( "otelcol.exporter.consumed.size", - metric.WithDescription("Size of items passed to the exporter, based on ProtoMarshaler.Sizer."), + metric.WithDescription("Size of items passed to the exporter, based on ProtoMarshaler.Sizer. [Development]"), metric.WithUnit("{item}"), ) errs = errors.Join(errs, err) builder.ProcessCPUSeconds, err = builder.meter.Float64ObservableCounter( "otelcol_process_cpu_seconds", - metric.WithDescription("Total CPU user and system time in seconds [alpha]"), + metric.WithDescription("Total CPU user and system time in seconds [Alpha]"), metric.WithUnit("s"), ) errs = errors.Join(errs, err) builder.ProcessMemoryRss, err = builder.meter.Int64ObservableGauge( "otelcol_process_memory_rss", - metric.WithDescription("Total physical memory (resident set size) [alpha]"), + metric.WithDescription("Total physical memory (resident set size) [Alpha]"), metric.WithUnit("By"), ) errs = errors.Join(errs, err) builder.ProcessRuntimeHeapAllocBytes, err = builder.meter.Int64ObservableGauge( "otelcol_process_runtime_heap_alloc_bytes", - metric.WithDescription("Bytes of allocated heap objects (see 'go doc runtime.MemStats.HeapAlloc') [alpha]"), + metric.WithDescription("Bytes of allocated heap objects (see 'go doc runtime.MemStats.HeapAlloc') [Alpha]"), metric.WithUnit("By"), ) 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') [alpha]"), + metric.WithDescription("Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc') [Alpha]"), metric.WithUnit("By"), ) errs = errors.Join(errs, err) builder.ProcessRuntimeTotalSysMemoryBytes, err = builder.meter.Int64ObservableGauge( "otelcol_process_runtime_total_sys_memory_bytes", - metric.WithDescription("Total bytes of memory obtained from the OS (see 'go doc runtime.MemStats.Sys') [alpha]"), + metric.WithDescription("Total bytes of memory obtained from the OS (see 'go doc runtime.MemStats.Sys') [Alpha]"), metric.WithUnit("By"), ) errs = errors.Join(errs, err) builder.ProcessUptime, err = builder.meter.Float64ObservableCounter( "otelcol_process_uptime", - metric.WithDescription("Uptime of the process [alpha]"), + metric.WithDescription("Uptime of the process [Alpha]"), metric.WithUnit("s"), ) errs = errors.Join(errs, err) builder.ProcessorConsumedItems, err = builder.meter.Int64Counter( "otelcol.processor.consumed.items", - metric.WithDescription("Number of items passed to the processor."), + metric.WithDescription("Number of items passed to the processor. [Development]"), metric.WithUnit("{item}"), ) errs = errors.Join(errs, err) builder.ProcessorConsumedSize, err = builder.meter.Int64Counter( "otelcol.processor.consumed.size", - metric.WithDescription("Size of items passed to the processor, based on ProtoMarshaler.Sizer."), + metric.WithDescription("Size of items passed to the processor, based on ProtoMarshaler.Sizer. [Development]"), metric.WithUnit("{item}"), ) errs = errors.Join(errs, err) builder.ProcessorProducedItems, err = builder.meter.Int64Counter( "otelcol.processor.produced.items", - metric.WithDescription("Number of items emitted from the processor."), + metric.WithDescription("Number of items emitted from the processor. [Development]"), metric.WithUnit("{item}"), ) errs = errors.Join(errs, err) builder.ProcessorProducedSize, err = builder.meter.Int64Counter( "otelcol.processor.produced.size", - metric.WithDescription("Size of items emitted from the processor, based on ProtoMarshaler.Sizer."), + metric.WithDescription("Size of items emitted from the processor, based on ProtoMarshaler.Sizer. [Development]"), metric.WithUnit("{item}"), ) errs = errors.Join(errs, err) builder.ReceiverProducedItems, err = builder.meter.Int64Counter( "otelcol.receiver.produced.items", - metric.WithDescription("Number of items emitted from the receiver."), + metric.WithDescription("Number of items emitted from the receiver. [Development]"), metric.WithUnit("{item}"), ) errs = errors.Join(errs, err) builder.ReceiverProducedSize, err = builder.meter.Int64Counter( "otelcol.receiver.produced.size", - metric.WithDescription("Size of items emitted from the receiver, based on ProtoMarshaler.Sizer."), + metric.WithDescription("Size of items emitted from the receiver, based on ProtoMarshaler.Sizer. [Development]"), metric.WithUnit("{item}"), ) errs = errors.Join(errs, err) diff --git a/service/internal/metadatatest/generated_telemetrytest.go b/service/internal/metadatatest/generated_telemetrytest.go index b429d868713..9819ac8a143 100644 --- a/service/internal/metadatatest/generated_telemetrytest.go +++ b/service/internal/metadatatest/generated_telemetrytest.go @@ -15,7 +15,7 @@ import ( func AssertEqualConnectorConsumedItems(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol.connector.consumed.items", - Description: "Number of items passed to the connector.", + Description: "Number of items passed to the connector. [Development]", Unit: "{item}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -31,7 +31,7 @@ func AssertEqualConnectorConsumedItems(t *testing.T, tt *componenttest.Telemetry func AssertEqualConnectorConsumedSize(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol.connector.consumed.size", - Description: "Size of items passed to the connector, based on ProtoMarshaler.Sizer.", + Description: "Size of items passed to the connector, based on ProtoMarshaler.Sizer. [Development]", Unit: "{item}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -47,7 +47,7 @@ func AssertEqualConnectorConsumedSize(t *testing.T, tt *componenttest.Telemetry, func AssertEqualConnectorProducedItems(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol.connector.produced.items", - Description: "Number of items emitted from the connector.", + Description: "Number of items emitted from the connector. [Development]", Unit: "{item}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -63,7 +63,7 @@ func AssertEqualConnectorProducedItems(t *testing.T, tt *componenttest.Telemetry func AssertEqualConnectorProducedSize(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol.connector.produced.size", - Description: "Size of items emitted from the connector, based on ProtoMarshaler.Sizer.", + Description: "Size of items emitted from the connector, based on ProtoMarshaler.Sizer. [Development]", Unit: "{item}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -79,7 +79,7 @@ func AssertEqualConnectorProducedSize(t *testing.T, tt *componenttest.Telemetry, func AssertEqualExporterConsumedItems(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol.exporter.consumed.items", - Description: "Number of items passed to the exporter.", + Description: "Number of items passed to the exporter. [Development]", Unit: "{item}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -95,7 +95,7 @@ func AssertEqualExporterConsumedItems(t *testing.T, tt *componenttest.Telemetry, func AssertEqualExporterConsumedSize(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol.exporter.consumed.size", - Description: "Size of items passed to the exporter, based on ProtoMarshaler.Sizer.", + Description: "Size of items passed to the exporter, based on ProtoMarshaler.Sizer. [Development]", Unit: "{item}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -111,7 +111,7 @@ func AssertEqualExporterConsumedSize(t *testing.T, tt *componenttest.Telemetry, func AssertEqualProcessCPUSeconds(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[float64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_process_cpu_seconds", - Description: "Total CPU user and system time in seconds [alpha]", + Description: "Total CPU user and system time in seconds [Alpha]", Unit: "s", Data: metricdata.Sum[float64]{ Temporality: metricdata.CumulativeTemporality, @@ -127,7 +127,7 @@ func AssertEqualProcessCPUSeconds(t *testing.T, tt *componenttest.Telemetry, dps func AssertEqualProcessMemoryRss(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_process_memory_rss", - Description: "Total physical memory (resident set size) [alpha]", + Description: "Total physical memory (resident set size) [Alpha]", Unit: "By", Data: metricdata.Gauge[int64]{ DataPoints: dps, @@ -141,7 +141,7 @@ func AssertEqualProcessMemoryRss(t *testing.T, tt *componenttest.Telemetry, dps func AssertEqualProcessRuntimeHeapAllocBytes(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_process_runtime_heap_alloc_bytes", - Description: "Bytes of allocated heap objects (see 'go doc runtime.MemStats.HeapAlloc') [alpha]", + Description: "Bytes of allocated heap objects (see 'go doc runtime.MemStats.HeapAlloc') [Alpha]", Unit: "By", Data: metricdata.Gauge[int64]{ DataPoints: dps, @@ -155,7 +155,7 @@ func AssertEqualProcessRuntimeHeapAllocBytes(t *testing.T, tt *componenttest.Tel 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') [alpha]", + Description: "Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc') [Alpha]", Unit: "By", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -171,7 +171,7 @@ func AssertEqualProcessRuntimeTotalAllocBytes(t *testing.T, tt *componenttest.Te func AssertEqualProcessRuntimeTotalSysMemoryBytes(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_process_runtime_total_sys_memory_bytes", - Description: "Total bytes of memory obtained from the OS (see 'go doc runtime.MemStats.Sys') [alpha]", + Description: "Total bytes of memory obtained from the OS (see 'go doc runtime.MemStats.Sys') [Alpha]", Unit: "By", Data: metricdata.Gauge[int64]{ DataPoints: dps, @@ -185,7 +185,7 @@ func AssertEqualProcessRuntimeTotalSysMemoryBytes(t *testing.T, tt *componenttes func AssertEqualProcessUptime(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[float64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_process_uptime", - Description: "Uptime of the process [alpha]", + Description: "Uptime of the process [Alpha]", Unit: "s", Data: metricdata.Sum[float64]{ Temporality: metricdata.CumulativeTemporality, @@ -201,7 +201,7 @@ func AssertEqualProcessUptime(t *testing.T, tt *componenttest.Telemetry, dps []m func AssertEqualProcessorConsumedItems(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol.processor.consumed.items", - Description: "Number of items passed to the processor.", + Description: "Number of items passed to the processor. [Development]", Unit: "{item}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -217,7 +217,7 @@ func AssertEqualProcessorConsumedItems(t *testing.T, tt *componenttest.Telemetry func AssertEqualProcessorConsumedSize(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol.processor.consumed.size", - Description: "Size of items passed to the processor, based on ProtoMarshaler.Sizer.", + Description: "Size of items passed to the processor, based on ProtoMarshaler.Sizer. [Development]", Unit: "{item}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -233,7 +233,7 @@ func AssertEqualProcessorConsumedSize(t *testing.T, tt *componenttest.Telemetry, func AssertEqualProcessorProducedItems(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol.processor.produced.items", - Description: "Number of items emitted from the processor.", + Description: "Number of items emitted from the processor. [Development]", Unit: "{item}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -249,7 +249,7 @@ func AssertEqualProcessorProducedItems(t *testing.T, tt *componenttest.Telemetry func AssertEqualProcessorProducedSize(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol.processor.produced.size", - Description: "Size of items emitted from the processor, based on ProtoMarshaler.Sizer.", + Description: "Size of items emitted from the processor, based on ProtoMarshaler.Sizer. [Development]", Unit: "{item}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -265,7 +265,7 @@ func AssertEqualProcessorProducedSize(t *testing.T, tt *componenttest.Telemetry, func AssertEqualReceiverProducedItems(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol.receiver.produced.items", - Description: "Number of items emitted from the receiver.", + Description: "Number of items emitted from the receiver. [Development]", Unit: "{item}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, @@ -281,7 +281,7 @@ func AssertEqualReceiverProducedItems(t *testing.T, tt *componenttest.Telemetry, func AssertEqualReceiverProducedSize(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol.receiver.produced.size", - Description: "Size of items emitted from the receiver, based on ProtoMarshaler.Sizer.", + Description: "Size of items emitted from the receiver, based on ProtoMarshaler.Sizer. [Development]", Unit: "{item}", Data: metricdata.Sum[int64]{ Temporality: metricdata.CumulativeTemporality, diff --git a/service/metadata.yaml b/service/metadata.yaml index 344b7e587c3..5f59e270e25 100644 --- a/service/metadata.yaml +++ b/service/metadata.yaml @@ -13,6 +13,8 @@ telemetry: connector.consumed.items: prefix: otelcol. enabled: true + stability: + level: development description: Number of items passed to the connector. unit: "{item}" sum: @@ -22,6 +24,8 @@ telemetry: connector.consumed.size: prefix: otelcol. enabled: false + stability: + level: development description: Size of items passed to the connector, based on ProtoMarshaler.Sizer. unit: "{item}" sum: @@ -31,6 +35,8 @@ telemetry: connector.produced.items: prefix: otelcol. enabled: true + stability: + level: development description: Number of items emitted from the connector. unit: "{item}" sum: @@ -40,6 +46,8 @@ telemetry: connector.produced.size: prefix: otelcol. enabled: false + stability: + level: development description: Size of items emitted from the connector, based on ProtoMarshaler.Sizer. unit: "{item}" sum: @@ -49,6 +57,8 @@ telemetry: exporter.consumed.items: prefix: otelcol. enabled: true + stability: + level: development description: Number of items passed to the exporter. unit: "{item}" sum: @@ -58,6 +68,8 @@ telemetry: exporter.consumed.size: prefix: otelcol. enabled: false + stability: + level: development description: Size of items passed to the exporter, based on ProtoMarshaler.Sizer. unit: "{item}" sum: @@ -130,6 +142,8 @@ telemetry: processor.consumed.items: prefix: otelcol. enabled: true + stability: + level: development description: Number of items passed to the processor. unit: "{item}" sum: @@ -139,6 +153,8 @@ telemetry: processor.consumed.size: prefix: otelcol. enabled: false + stability: + level: development description: Size of items passed to the processor, based on ProtoMarshaler.Sizer. unit: "{item}" sum: @@ -148,6 +164,8 @@ telemetry: processor.produced.items: prefix: otelcol. enabled: true + stability: + level: development description: Number of items emitted from the processor. unit: "{item}" sum: @@ -157,6 +175,8 @@ telemetry: processor.produced.size: prefix: otelcol. enabled: false + stability: + level: development description: Size of items emitted from the processor, based on ProtoMarshaler.Sizer. unit: "{item}" sum: @@ -166,6 +186,8 @@ telemetry: receiver.produced.items: prefix: otelcol. enabled: true + stability: + level: development description: Number of items emitted from the receiver. unit: "{item}" sum: @@ -175,6 +197,8 @@ telemetry: receiver.produced.size: prefix: otelcol. enabled: false + stability: + level: development description: Size of items emitted from the receiver, based on ProtoMarshaler.Sizer. unit: "{item}" sum: