Skip to content

[chore][kafkareceiver] Add stability level per metric #42944

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
songy23 merged 3 commits into from
Sep 29, 2025
Merged

[chore][kafkareceiver] Add stability level per metric #42944

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
925d79f
[chore][kafkareceiver] Add stability level per metric
ChrsMark Sep 25, 2025
e35b82b
Merge branch 'main' into kafkareceiver_metric_stability
ChrsMark Sep 25, 2025
8493bd9
Merge branch 'main' into kafkareceiver_metric_stability
ChrsMark Sep 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 64 additions & 64 deletions receiver/kafkareceiver/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ The following telemetry is emitted by this component.

### otelcol_kafka_broker_closed

The total number of connections closed.
The total number of connections closed. [development]

Only produced when franz-go is enabled.

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
| 1 | Sum | Int | true |
| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| 1 | Sum | Int | true | development |

#### Attributes

Expand All @@ -24,13 +24,13 @@ Only produced when franz-go is enabled.

### otelcol_kafka_broker_connects

The total number of connections opened.
The total number of connections opened. [development]

Only produced when franz-go is enabled.

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
| 1 | Sum | Int | true |
| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| 1 | Sum | Int | true | development |

#### Attributes

Expand All @@ -57,13 +57,13 @@ Only produced when franz-go is enabled. Deprecated in favor of kafka_broker_thro

### otelcol_kafka_broker_throttling_latency

The throttling latency in seconds imposed by the broker when receiving records.
The throttling latency in seconds imposed by the broker when receiving records. [development]

Only produced when franz-go is enabled.

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| s | Histogram | Double |
| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| s | Histogram | Double | development |

#### Attributes

Expand All @@ -73,13 +73,13 @@ Only produced when franz-go is enabled.

### otelcol_kafka_receiver_bytes

The size in bytes of received records seen by the broker.
The size in bytes of received records seen by the broker. [development]

Only produced when franz-go is enabled.

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
| By | Sum | Int | true |
| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| By | Sum | Int | true | development |

#### Attributes

Expand All @@ -92,11 +92,11 @@ Only produced when franz-go is enabled.

### otelcol_kafka_receiver_bytes_uncompressed

The uncompressed size in bytes of received records seen by the client.
The uncompressed size in bytes of received records seen by the client. [development]

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
| By | Sum | Int | true |
| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| By | Sum | Int | true | development |

#### Attributes

Expand All @@ -109,11 +109,11 @@ The uncompressed size in bytes of received records seen by the client.

### otelcol_kafka_receiver_current_offset

Current message offset
Current message offset [development]

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| 1 | Gauge | Int |
| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| 1 | Gauge | Int | development |

#### Attributes

Expand Down Expand Up @@ -162,11 +162,11 @@ Deprecated in favor of kafka_receiver_records.

### otelcol_kafka_receiver_offset_lag

Current offset lag
Current offset lag [development]

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| 1 | Gauge | Int |
| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| 1 | Gauge | Int | development |

#### Attributes

Expand All @@ -177,29 +177,29 @@ Current offset lag

### otelcol_kafka_receiver_partition_close

Number of finished partitions
Number of finished partitions [development]

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
| 1 | Sum | Int | true |
| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| 1 | Sum | Int | true | development |

### otelcol_kafka_receiver_partition_start

Number of started partitions
Number of started partitions [development]

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
| 1 | Sum | Int | true |
| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| 1 | Sum | Int | true | development |

### otelcol_kafka_receiver_read_latency

The time it took in seconds to receive a batch of records.
The time it took in seconds to receive a batch of records. [development]

Only produced when franz-go is enabled.

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| s | Histogram | Double |
| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| s | Histogram | Double | development |

#### Attributes

Expand All @@ -212,11 +212,11 @@ Only produced when franz-go is enabled.

### otelcol_kafka_receiver_records

The number of received records.
The number of received records. [development]

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
| 1 | Sum | Int | true |
| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| 1 | Sum | Int | true | development |

#### Attributes

Expand All @@ -229,17 +229,17 @@ The number of received records.

### otelcol_kafka_receiver_records_delay

The time in seconds between producing and receiving a batch of records.
The time in seconds between producing and receiving a batch of records. [development]

Optional, only reported when enabled via config.
Note that this metric may slow down high-volume consuming.
Only produced when franz-go is enabled.
This metric is reported with an assumption that the exporter and the receiver clocks are synchronized.


| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| s | Histogram | Double |
| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| s | Histogram | Double | development |

#### Attributes

Expand All @@ -250,11 +250,11 @@ This metric is reported with an assumption that the exporter and the receiver cl

### otelcol_kafka_receiver_unmarshal_failed_log_records

Number of log records failed to be unmarshaled
Number of log records failed to be unmarshaled [development]

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
| 1 | Sum | Int | true |
| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| 1 | Sum | Int | true | development |

#### Attributes

Expand All @@ -265,11 +265,11 @@ Number of log records failed to be unmarshaled

### otelcol_kafka_receiver_unmarshal_failed_metric_points

Number of metric points failed to be unmarshaled
Number of metric points failed to be unmarshaled [development]

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
| 1 | Sum | Int | true |
| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| 1 | Sum | Int | true | development |

#### Attributes

Expand All @@ -280,11 +280,11 @@ Number of metric points failed to be unmarshaled

### otelcol_kafka_receiver_unmarshal_failed_profiles

Number of profiles failed to be unmarshaled
Number of profiles failed to be unmarshaled [development]

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
| 1 | Sum | Int | true |
| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| 1 | Sum | Int | true | development |

#### Attributes

Expand All @@ -295,11 +295,11 @@ Number of profiles failed to be unmarshaled

### otelcol_kafka_receiver_unmarshal_failed_spans

Number of spans failed to be unmarshaled
Number of spans failed to be unmarshaled [development]

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
| 1 | Sum | Int | true |
| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| 1 | Sum | Int | true | development |

#### Attributes

Expand Down
32 changes: 16 additions & 16 deletions receiver/kafkareceiver/internal/metadata/generated_telemetry.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading