Skip to content

Commit 7397b6d

Browse files
jade-guiton-ddchalin
jade-guiton-dd
and
chalin
authored
Update internal telemetry docs (#6484)
Co-authored-by: Patrice Chalin <[email protected]>
1 parent edc10d6 commit 7397b6d

File tree

2 files changed

+52
-34
lines changed

2 files changed

+52
-34
lines changed

‎content/en/docs/collector/internal-telemetry.md

+48-34
Original file line numberDiff line numberDiff line change
@@ -238,43 +238,57 @@ files in the repository.
238238

239239
#### `basic`-level metrics
240240

241-
| Metric name | Description | Type |
242-
| ------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------- |
243-
| `otelcol_exporter_enqueue_failed_`<br>`log_records` | Number of logs that exporter(s) failed to enqueue. | Counter |
244-
| `otelcol_exporter_enqueue_failed_`<br>`metric_points` | Number of metric points that exporter(s) failed to enqueue. | Counter |
245-
| `otelcol_exporter_enqueue_failed_`<br>`spans` | Number of spans that exporter(s) failed to enqueue. | Counter |
246-
| `otelcol_exporter_queue_capacity` | Fixed capacity of the sending queue, in batches. | Gauge |
247-
| `otelcol_exporter_queue_size` | Current size of the sending queue, in batches. | Gauge |
248-
| `otelcol_exporter_send_failed_`<br>`log_records` | Number of logs that exporter(s) failed to send to destination. | Counter |
249-
| `otelcol_exporter_send_failed_`<br>`metric_points` | Number of metric points that exporter(s) failed to send to destination. | Counter |
250-
| `otelcol_exporter_send_failed_`<br>`spans` | Number of spans that exporter(s) failed to send to destination. | Counter |
251-
| `otelcol_exporter_sent_log_records` | Number of logs successfully sent to destination. | Counter |
252-
| `otelcol_exporter_sent_metric_points` | Number of metric points successfully sent to destination. | Counter |
253-
| `otelcol_exporter_sent_spans` | Number of spans successfully sent to destination. | Counter |
254-
| `otelcol_process_cpu_seconds` | Total CPU user and system time in seconds. | Counter |
255-
| `otelcol_process_memory_rss` | Total physical memory (resident set size) in bytes. | Gauge |
256-
| `otelcol_process_runtime_heap_`<br>`alloc_bytes` | Bytes of allocated heap objects (see 'go doc runtime.MemStats.HeapAlloc'). | Gauge |
257-
| `otelcol_process_runtime_total_`<br>`alloc_bytes` | Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc'). | Counter |
258-
| `otelcol_process_runtime_total_`<br>`sys_memory_bytes` | Total bytes of memory obtained from the OS (see 'go doc runtime.MemStats.Sys'). | Gauge |
259-
| `otelcol_process_uptime` | Uptime of the process in seconds. | Counter |
260-
| `otelcol_processor_batch_batch_`<br>`send_size` | Number of units in the batch that was sent. | Histogram |
261-
| `otelcol_processor_batch_batch_size_`<br>`trigger_send` | Number of times the batch was sent due to a size trigger. | Counter |
262-
| `otelcol_processor_batch_metadata_`<br>`cardinality` | Number of distinct metadata value combinations being processed. | Counter |
263-
| `otelcol_processor_batch_timeout_`<br>`trigger_send` | Number of times the batch was sent due to a timeout trigger. | Counter |
264-
| `otelcol_processor_incoming_items` | Number of items passed to the processor. | Counter |
265-
| `otelcol_processor_outgoing_items` | Number of items emitted from the processor. | Counter |
266-
| `otelcol_receiver_accepted_`<br>`log_records` | Number of logs successfully ingested and pushed into the pipeline. | Counter |
267-
| `otelcol_receiver_accepted_`<br>`metric_points` | Number of metric points successfully ingested and pushed into the pipeline. | Counter |
268-
| `otelcol_receiver_accepted_spans` | Number of spans successfully ingested and pushed into the pipeline. | Counter |
269-
| `otelcol_receiver_refused_`<br>`log_records` | Number of logs that could not be pushed into the pipeline. | Counter |
270-
| `otelcol_receiver_refused_`<br>`metric_points` | Number of metric points that could not be pushed into the pipeline. | Counter |
271-
| `otelcol_receiver_refused_spans` | Number of spans that could not be pushed into the pipeline. | Counter |
272-
| `otelcol_scraper_errored_`<br>`metric_points` | Number of metric points the Collector failed to scrape. | Counter |
273-
| `otelcol_scraper_scraped_`<br>`metric_points` | Number of metric points scraped by the Collector. | Counter |
241+
| Metric name | Description | Type |
242+
| ------------------------------------------------------ | --------------------------------------------------------------------------------------- | ------- |
243+
| `otelcol_exporter_enqueue_failed_`<br>`log_records` | Number of logs that exporter(s) failed to enqueue. | Counter |
244+
| `otelcol_exporter_enqueue_failed_`<br>`metric_points` | Number of metric points that exporter(s) failed to enqueue. | Counter |
245+
| `otelcol_exporter_enqueue_failed_`<br>`spans` | Number of spans that exporter(s) failed to enqueue. | Counter |
246+
| `otelcol_exporter_queue_capacity` | Fixed capacity of the sending queue, in batches. | Gauge |
247+
| `otelcol_exporter_queue_size` | Current size of the sending queue, in batches. | Gauge |
248+
| `otelcol_exporter_send_failed_`<br>`log_records` | Number of logs that exporter(s) failed to send to destination. | Counter |
249+
| `otelcol_exporter_send_failed_`<br>`metric_points` | Number of metric points that exporter(s) failed to send to destination. | Counter |
250+
| `otelcol_exporter_send_failed_`<br>`spans` | Number of spans that exporter(s) failed to send to destination. | Counter |
251+
| `otelcol_exporter_sent_log_records` | Number of logs successfully sent to destination. | Counter |
252+
| `otelcol_exporter_sent_metric_points` | Number of metric points successfully sent to destination. | Counter |
253+
| `otelcol_exporter_sent_spans` | Number of spans successfully sent to destination. | Counter |
254+
| `otelcol_process_cpu_seconds` | Total CPU user and system time in seconds. | Counter |
255+
| `otelcol_process_memory_rss` | Total physical memory (resident set size) in bytes. | Gauge |
256+
| `otelcol_process_runtime_heap_`<br>`alloc_bytes` | Bytes of allocated heap objects (see 'go doc runtime.MemStats.HeapAlloc'). | Gauge |
257+
| `otelcol_process_runtime_total_`<br>`alloc_bytes` | Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc'). | Counter |
258+
| `otelcol_process_runtime_total_`<br>`sys_memory_bytes` | Total bytes of memory obtained from the OS (see 'go doc runtime.MemStats.Sys'). | Gauge |
259+
| `otelcol_process_uptime` | Uptime of the process in seconds. | Counter |
260+
| `otelcol_processor_incoming_items` | Number of items passed to the processor. | Counter |
261+
| `otelcol_processor_outgoing_items` | Number of items emitted from the processor. | Counter |
262+
| `otelcol_receiver_accepted_`<br>`log_records` | Number of logs successfully ingested and pushed into the pipeline. | Counter |
263+
| `otelcol_receiver_accepted_`<br>`metric_points` | Number of metric points successfully ingested and pushed into the pipeline. | Counter |
264+
| `otelcol_receiver_accepted_spans` | Number of spans successfully ingested and pushed into the pipeline. | Counter |
265+
| `otelcol_receiver_refused_`<br>`log_records` | Number of logs that could not be pushed into the pipeline. | Counter |
266+
| `otelcol_receiver_refused_`<br>`metric_points` | Number of metric points that could not be pushed into the pipeline. | Counter |
267+
| `otelcol_receiver_refused_spans` | Number of spans that could not be pushed into the pipeline. | Counter |
268+
| `otelcol_scraper_errored_`<br>`metric_points` | Number of metric points the Collector failed to scrape. | Counter |
269+
| `otelcol_scraper_scraped_`<br>`metric_points` | Number of metric points scraped by the Collector. | Counter |
274270

275271
#### Additional `normal`-level metrics
276272

277-
There are currently no metrics specific to `normal` verbosity.
273+
| Metric name | Description | Type |
274+
| ------------------------------------------------------- | --------------------------------------------------------------- | --------- |
275+
| `otelcol_processor_batch_batch_`<br>`send_size` | Number of units in the batch that was sent. | Histogram |
276+
| `otelcol_processor_batch_batch_size_`<br>`trigger_send` | Number of times the batch was sent due to a size trigger. | Counter |
277+
| `otelcol_processor_batch_metadata_`<br>`cardinality` | Number of distinct metadata value combinations being processed. | Counter |
278+
| `otelcol_processor_batch_timeout_`<br>`trigger_send` | Number of times the batch was sent due to a timeout trigger. | Counter |
279+
280+
{{% alert title="Batch processor metrics level changes" color="info" %}}
281+
282+
In Collector [v0.99.0], all batch processor metrics were upgraded from `basic`
283+
to `normal` (current level), except for
284+
`otelcol_processor_batch_batch_send_size_bytes`, which has been `detailed` since
285+
its introduction. Note however that these metrics were inadvertently reverted to
286+
`basic` from v0.109.0 to v0.121.0.
287+
288+
[v0.99.0]:
289+
https://github.com/open-telemetry/opentelemetry-collector/releases/tag/v0.99.0
290+
291+
{{% /alert %}}
278292

279293
#### Additional `detailed`-level metrics
280294

‎static/refcache.json

+4
Original file line numberDiff line numberDiff line change
@@ -6747,6 +6747,10 @@
67476747
"StatusCode": 200,
67486748
"LastSeen": "2024-10-24T15:10:25.832305+02:00"
67496749
},
6750+
"https://github.com/open-telemetry/opentelemetry-collector/releases/tag/v0.99.0": {
6751+
"StatusCode": 206,
6752+
"LastSeen": "2025-03-07T15:19:33.345532+01:00"
6753+
},
67506754
"https://github.com/open-telemetry/opentelemetry-collector/security/advisories/GHSA-c74f-6mfw-mm4v": {
67516755
"StatusCode": 206,
67526756
"LastSeen": "2025-02-01T07:10:33.83398-05:00"

0 commit comments

Comments
 (0)