From 1107f56df17e61feb9cd3ef497aad29af773b8af Mon Sep 17 00:00:00 2001 From: Jade Guiton Date: Thu, 6 Mar 2025 16:52:08 +0100 Subject: [PATCH 1/4] [en] Update internal telemetry docs --- .../en/docs/collector/internal-telemetry.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/content/en/docs/collector/internal-telemetry.md b/content/en/docs/collector/internal-telemetry.md index 7beaf9783c45..6e138fb59d9f 100644 --- a/content/en/docs/collector/internal-telemetry.md +++ b/content/en/docs/collector/internal-telemetry.md @@ -257,10 +257,6 @@ files in the repository. | `otelcol_process_runtime_total_`
`alloc_bytes` | Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc'). | Counter | | `otelcol_process_runtime_total_`
`sys_memory_bytes` | Total bytes of memory obtained from the OS (see 'go doc runtime.MemStats.Sys'). | Gauge | | `otelcol_process_uptime` | Uptime of the process in seconds. | Counter | -| `otelcol_processor_batch_batch_`
`send_size` | Number of units in the batch that was sent. | Histogram | -| `otelcol_processor_batch_batch_size_`
`trigger_send` | Number of times the batch was sent due to a size trigger. | Counter | -| `otelcol_processor_batch_metadata_`
`cardinality` | Number of distinct metadata value combinations being processed. | Counter | -| `otelcol_processor_batch_timeout_`
`trigger_send` | Number of times the batch was sent due to a timeout trigger. | Counter | | `otelcol_processor_incoming_items` | Number of items passed to the processor. | Counter | | `otelcol_processor_outgoing_items` | Number of items emitted from the processor. | Counter | | `otelcol_receiver_accepted_`
`log_records` | Number of logs successfully ingested and pushed into the pipeline. | Counter | @@ -274,7 +270,20 @@ files in the repository. #### Additional `normal`-level metrics -There are currently no metrics specific to `normal` verbosity. +| Metric name | Description | Type | +| ------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------- | +| `otelcol_processor_batch_batch_`
`send_size` | Number of units in the batch that was sent. | Histogram | +| `otelcol_processor_batch_batch_size_`
`trigger_send` | Number of times the batch was sent due to a size trigger. | Counter | +| `otelcol_processor_batch_metadata_`
`cardinality` | Number of distinct metadata value combinations being processed. | Counter | +| `otelcol_processor_batch_timeout_`
`trigger_send` | Number of times the batch was sent due to a timeout trigger. | Counter | + +{{% alert title="Note" color="info" %}} +Aside from `otelcol_processor_batch_batch_send_size_bytes` which has been +`detailed` since its introduction, the other batch processor metrics were +`basic` until they were switched to `normal` in Collector version 0.99.0. +They were later switched back to `basic` by mistake in versions [0.109.0, +0.121.0]. +{{% /alert %}} #### Additional `detailed`-level metrics From a8e9473873d47f23d5a803fc5a62b03b10e3a7ef Mon Sep 17 00:00:00 2001 From: Jade Guiton Date: Thu, 6 Mar 2025 16:58:57 +0100 Subject: [PATCH 2/4] Formatting fixes --- .../en/docs/collector/internal-telemetry.md | 84 +++++++++---------- 1 file changed, 41 insertions(+), 43 deletions(-) diff --git a/content/en/docs/collector/internal-telemetry.md b/content/en/docs/collector/internal-telemetry.md index 6e138fb59d9f..e67f89e60c50 100644 --- a/content/en/docs/collector/internal-telemetry.md +++ b/content/en/docs/collector/internal-telemetry.md @@ -238,52 +238,50 @@ files in the repository. #### `basic`-level metrics -| Metric name | Description | Type | -| ------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------- | -| `otelcol_exporter_enqueue_failed_`
`log_records` | Number of logs that exporter(s) failed to enqueue. | Counter | -| `otelcol_exporter_enqueue_failed_`
`metric_points` | Number of metric points that exporter(s) failed to enqueue. | Counter | -| `otelcol_exporter_enqueue_failed_`
`spans` | Number of spans that exporter(s) failed to enqueue. | Counter | -| `otelcol_exporter_queue_capacity` | Fixed capacity of the sending queue, in batches. | Gauge | -| `otelcol_exporter_queue_size` | Current size of the sending queue, in batches. | Gauge | -| `otelcol_exporter_send_failed_`
`log_records` | Number of logs that exporter(s) failed to send to destination. | Counter | -| `otelcol_exporter_send_failed_`
`metric_points` | Number of metric points that exporter(s) failed to send to destination. | Counter | -| `otelcol_exporter_send_failed_`
`spans` | Number of spans that exporter(s) failed to send to destination. | Counter | -| `otelcol_exporter_sent_log_records` | Number of logs successfully sent to destination. | Counter | -| `otelcol_exporter_sent_metric_points` | Number of metric points successfully sent to destination. | Counter | -| `otelcol_exporter_sent_spans` | Number of spans successfully sent to destination. | Counter | -| `otelcol_process_cpu_seconds` | Total CPU user and system time in seconds. | Counter | -| `otelcol_process_memory_rss` | Total physical memory (resident set size) in bytes. | Gauge | -| `otelcol_process_runtime_heap_`
`alloc_bytes` | Bytes of allocated heap objects (see 'go doc runtime.MemStats.HeapAlloc'). | Gauge | -| `otelcol_process_runtime_total_`
`alloc_bytes` | Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc'). | Counter | -| `otelcol_process_runtime_total_`
`sys_memory_bytes` | Total bytes of memory obtained from the OS (see 'go doc runtime.MemStats.Sys'). | Gauge | -| `otelcol_process_uptime` | Uptime of the process in seconds. | Counter | -| `otelcol_processor_incoming_items` | Number of items passed to the processor. | Counter | -| `otelcol_processor_outgoing_items` | Number of items emitted from the processor. | Counter | -| `otelcol_receiver_accepted_`
`log_records` | Number of logs successfully ingested and pushed into the pipeline. | Counter | -| `otelcol_receiver_accepted_`
`metric_points` | Number of metric points successfully ingested and pushed into the pipeline. | Counter | -| `otelcol_receiver_accepted_spans` | Number of spans successfully ingested and pushed into the pipeline. | Counter | -| `otelcol_receiver_refused_`
`log_records` | Number of logs that could not be pushed into the pipeline. | Counter | -| `otelcol_receiver_refused_`
`metric_points` | Number of metric points that could not be pushed into the pipeline. | Counter | -| `otelcol_receiver_refused_spans` | Number of spans that could not be pushed into the pipeline. | Counter | -| `otelcol_scraper_errored_`
`metric_points` | Number of metric points the Collector failed to scrape. | Counter | -| `otelcol_scraper_scraped_`
`metric_points` | Number of metric points scraped by the Collector. | Counter | +| Metric name | Description | Type | +| ------------------------------------------------------ | --------------------------------------------------------------------------------------- | ------- | +| `otelcol_exporter_enqueue_failed_`
`log_records` | Number of logs that exporter(s) failed to enqueue. | Counter | +| `otelcol_exporter_enqueue_failed_`
`metric_points` | Number of metric points that exporter(s) failed to enqueue. | Counter | +| `otelcol_exporter_enqueue_failed_`
`spans` | Number of spans that exporter(s) failed to enqueue. | Counter | +| `otelcol_exporter_queue_capacity` | Fixed capacity of the sending queue, in batches. | Gauge | +| `otelcol_exporter_queue_size` | Current size of the sending queue, in batches. | Gauge | +| `otelcol_exporter_send_failed_`
`log_records` | Number of logs that exporter(s) failed to send to destination. | Counter | +| `otelcol_exporter_send_failed_`
`metric_points` | Number of metric points that exporter(s) failed to send to destination. | Counter | +| `otelcol_exporter_send_failed_`
`spans` | Number of spans that exporter(s) failed to send to destination. | Counter | +| `otelcol_exporter_sent_log_records` | Number of logs successfully sent to destination. | Counter | +| `otelcol_exporter_sent_metric_points` | Number of metric points successfully sent to destination. | Counter | +| `otelcol_exporter_sent_spans` | Number of spans successfully sent to destination. | Counter | +| `otelcol_process_cpu_seconds` | Total CPU user and system time in seconds. | Counter | +| `otelcol_process_memory_rss` | Total physical memory (resident set size) in bytes. | Gauge | +| `otelcol_process_runtime_heap_`
`alloc_bytes` | Bytes of allocated heap objects (see 'go doc runtime.MemStats.HeapAlloc'). | Gauge | +| `otelcol_process_runtime_total_`
`alloc_bytes` | Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc'). | Counter | +| `otelcol_process_runtime_total_`
`sys_memory_bytes` | Total bytes of memory obtained from the OS (see 'go doc runtime.MemStats.Sys'). | Gauge | +| `otelcol_process_uptime` | Uptime of the process in seconds. | Counter | +| `otelcol_processor_incoming_items` | Number of items passed to the processor. | Counter | +| `otelcol_processor_outgoing_items` | Number of items emitted from the processor. | Counter | +| `otelcol_receiver_accepted_`
`log_records` | Number of logs successfully ingested and pushed into the pipeline. | Counter | +| `otelcol_receiver_accepted_`
`metric_points` | Number of metric points successfully ingested and pushed into the pipeline. | Counter | +| `otelcol_receiver_accepted_spans` | Number of spans successfully ingested and pushed into the pipeline. | Counter | +| `otelcol_receiver_refused_`
`log_records` | Number of logs that could not be pushed into the pipeline. | Counter | +| `otelcol_receiver_refused_`
`metric_points` | Number of metric points that could not be pushed into the pipeline. | Counter | +| `otelcol_receiver_refused_spans` | Number of spans that could not be pushed into the pipeline. | Counter | +| `otelcol_scraper_errored_`
`metric_points` | Number of metric points the Collector failed to scrape. | Counter | +| `otelcol_scraper_scraped_`
`metric_points` | Number of metric points scraped by the Collector. | Counter | #### Additional `normal`-level metrics -| Metric name | Description | Type | -| ------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------- | -| `otelcol_processor_batch_batch_`
`send_size` | Number of units in the batch that was sent. | Histogram | -| `otelcol_processor_batch_batch_size_`
`trigger_send` | Number of times the batch was sent due to a size trigger. | Counter | -| `otelcol_processor_batch_metadata_`
`cardinality` | Number of distinct metadata value combinations being processed. | Counter | -| `otelcol_processor_batch_timeout_`
`trigger_send` | Number of times the batch was sent due to a timeout trigger. | Counter | - -{{% alert title="Note" color="info" %}} -Aside from `otelcol_processor_batch_batch_send_size_bytes` which has been -`detailed` since its introduction, the other batch processor metrics were -`basic` until they were switched to `normal` in Collector version 0.99.0. -They were later switched back to `basic` by mistake in versions [0.109.0, -0.121.0]. -{{% /alert %}} +| Metric name | Description | Type | +| ------------------------------------------------------- | --------------------------------------------------------------- | --------- | +| `otelcol_processor_batch_batch_`
`send_size` | Number of units in the batch that was sent. | Histogram | +| `otelcol_processor_batch_batch_size_`
`trigger_send` | Number of times the batch was sent due to a size trigger. | Counter | +| `otelcol_processor_batch_metadata_`
`cardinality` | Number of distinct metadata value combinations being processed. | Counter | +| `otelcol_processor_batch_timeout_`
`trigger_send` | Number of times the batch was sent due to a timeout trigger. | Counter | + +{{% alert title="Note" color="info" %}} Aside from +`otelcol_processor_batch_batch_send_size_bytes` which has been `detailed` since +its introduction, the other batch processor metrics were `basic` until they were +switched to `normal` in Collector version 0.99. They were later switched back to +`basic` by mistake in versions [0.109, 0.121]. {{% /alert %}} #### Additional `detailed`-level metrics From c1bda5764ae6001f80f58b6b01f2ca7a7975e7f3 Mon Sep 17 00:00:00 2001 From: Jade Guiton Date: Fri, 7 Mar 2025 15:21:17 +0100 Subject: [PATCH 3/4] Clear up wording for version range --- content/en/docs/collector/internal-telemetry.md | 6 ++++-- static/refcache.json | 4 ++++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/content/en/docs/collector/internal-telemetry.md b/content/en/docs/collector/internal-telemetry.md index e67f89e60c50..3828ad1eed09 100644 --- a/content/en/docs/collector/internal-telemetry.md +++ b/content/en/docs/collector/internal-telemetry.md @@ -280,8 +280,10 @@ files in the repository. {{% alert title="Note" color="info" %}} Aside from `otelcol_processor_batch_batch_send_size_bytes` which has been `detailed` since its introduction, the other batch processor metrics were `basic` until they were -switched to `normal` in Collector version 0.99. They were later switched back to -`basic` by mistake in versions [0.109, 0.121]. {{% /alert %}} +switched to `normal` in Collector +[v0.99.0](https://github.com/open-telemetry/opentelemetry-collector/releases/tag/v0.99.0). +They were accidentally switched back to `basic` in v0.109.0, which was fixed in +v0.122.0. {{% /alert %}} #### Additional `detailed`-level metrics diff --git a/static/refcache.json b/static/refcache.json index 2ffa7ee46e16..382dc07475ca 100644 --- a/static/refcache.json +++ b/static/refcache.json @@ -6707,6 +6707,10 @@ "StatusCode": 200, "LastSeen": "2024-10-24T15:10:25.832305+02:00" }, + "https://github.com/open-telemetry/opentelemetry-collector/releases/tag/v0.99.0": { + "StatusCode": 206, + "LastSeen": "2025-03-07T15:19:33.345532+01:00" + }, "https://github.com/open-telemetry/opentelemetry-collector/security/advisories/GHSA-c74f-6mfw-mm4v": { "StatusCode": 206, "LastSeen": "2025-02-01T07:10:33.83398-05:00" From dd65cba782d2bc6ee56d59e2870d0711992422b3 Mon Sep 17 00:00:00 2001 From: Jade Guiton Date: Thu, 20 Mar 2025 12:49:08 +0100 Subject: [PATCH 4/4] Apply suggested edits Co-authored-by: Patrice Chalin --- .../en/docs/collector/internal-telemetry.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/content/en/docs/collector/internal-telemetry.md b/content/en/docs/collector/internal-telemetry.md index 3828ad1eed09..f5c3524e76db 100644 --- a/content/en/docs/collector/internal-telemetry.md +++ b/content/en/docs/collector/internal-telemetry.md @@ -277,13 +277,18 @@ files in the repository. | `otelcol_processor_batch_metadata_`
`cardinality` | Number of distinct metadata value combinations being processed. | Counter | | `otelcol_processor_batch_timeout_`
`trigger_send` | Number of times the batch was sent due to a timeout trigger. | Counter | -{{% alert title="Note" color="info" %}} Aside from -`otelcol_processor_batch_batch_send_size_bytes` which has been `detailed` since -its introduction, the other batch processor metrics were `basic` until they were -switched to `normal` in Collector -[v0.99.0](https://github.com/open-telemetry/opentelemetry-collector/releases/tag/v0.99.0). -They were accidentally switched back to `basic` in v0.109.0, which was fixed in -v0.122.0. {{% /alert %}} +{{% alert title="Batch processor metrics level changes" color="info" %}} + +In Collector [v0.99.0], all batch processor metrics were upgraded from `basic` +to `normal` (current level), except for +`otelcol_processor_batch_batch_send_size_bytes`, which has been `detailed` since +its introduction. Note however that these metrics were inadvertently reverted to +`basic` from v0.109.0 to v0.121.0. + +[v0.99.0]: + https://github.com/open-telemetry/opentelemetry-collector/releases/tag/v0.99.0 + +{{% /alert %}} #### Additional `detailed`-level metrics