Skip to content

Commit 0c56862

Browse files
doldol
committed
docs(collector): update internal telemetry RPC metrics
Align the internal telemetry docs with the RPC metrics emitted by newer Collector builds that use the updated Go semantic conventions. Rename the documented RPC duration metrics to rpc.client.call.duration and rpc.server.call.duration, remove the deprecated *_per_rpc entries from the detailed metrics list, and note that older Collector releases may still expose the legacy rpc.client.duration and rpc.server.duration metric names.
1 parent aaffe18 commit 0c56862

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

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

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -375,7 +375,7 @@ naming conventions, resulting in metric names that looked like
375375
Versions 0.120.0 and later of the Collector use Prometheus 3.0 scrapers, so the
376376
original `http*` and `rpc*` metric names with dots are preserved. The
377377
[internal metrics](#lists-of-internal-metrics) on this page are listed in their
378-
original form, such as`rpc.server.duration`. For more information, see the
378+
original form, such as `rpc.server.call.duration`. For more information, see the
379379
[Collector v0.120.0 release notes](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CHANGELOG.md#v01200).
380380

381381
### Lists of internal metrics
@@ -453,30 +453,30 @@ files in the repository.
453453

454454
#### Additional `detailed`-level metrics
455455

456-
| Metric name | Description | Type |
457-
| ----------------------------------------------------- | ----------------------------------------------------------------------------------------- | --------- |
458-
| `http.client.request.body.size` | Measures the size of HTTP client request bodies. | Counter |
459-
| `http.client.request.duration` | Measures the duration of HTTP client requests. | Histogram |
460-
| `http.server.request.body.size` | Measures the size of HTTP server request bodies. | Counter |
461-
| `http.server.request.duration` | Measures the duration of HTTP server requests. | Histogram |
462-
| `http.server.response.body.size` | Measures the size of HTTP server response bodies. | Counter |
463-
| `otelcol_processor_batch_batch_`<br>`send_size_bytes` | Number of bytes in the batch that was sent. | Histogram |
464-
| `rpc.client.duration` | Measures the duration of outbound RPC. | Histogram |
465-
| `rpc.client.request.size` | Measures the size of RPC request messages (uncompressed). | Histogram |
466-
| `rpc.client.requests_per_rpc` | Measures the number of messages received per RPC. Should be 1 for all non-streaming RPCs. | Histogram |
467-
| `rpc.client.response.size` | Measures the size of RPC response messages (uncompressed). | Histogram |
468-
| `rpc.client.responses_per_rpc` | Measures the number of messages sent per RPC. Should be 1 for all non-streaming RPCs. | Histogram |
469-
| `rpc.server.duration` | Measures the duration of inbound RPC. | Histogram |
470-
| `rpc.server.request.size` | Measures the size of RPC request messages (uncompressed). | Histogram |
471-
| `rpc.server.requests_per_rpc` | Measures the number of messages received per RPC. Should be 1 for all non-streaming RPCs. | Histogram |
472-
| `rpc.server.response.size` | Measures the size of RPC response messages (uncompressed). | Histogram |
473-
| `rpc.server.responses_per_rpc` | Measures the number of messages sent per RPC. Should be 1 for all non-streaming RPCs. | Histogram |
456+
| Metric name | Description | Type |
457+
| ----------------------------------------------------- | --------------------------------------------------------------- | --------- |
458+
| `http.client.request.body.size` | Measures the size of HTTP client request bodies. | Counter |
459+
| `http.client.request.duration` | Measures the duration of HTTP client requests. | Histogram |
460+
| `http.server.request.body.size` | Measures the size of HTTP server request bodies. | Counter |
461+
| `http.server.request.duration` | Measures the duration of HTTP server requests. | Histogram |
462+
| `http.server.response.body.size` | Measures the size of HTTP server response bodies. | Counter |
463+
| `otelcol_processor_batch_batch_`<br>`send_size_bytes` | Number of bytes in the batch that was sent. | Histogram |
464+
| `rpc.client.call.duration` | Measures the duration of outbound remote procedure calls (RPC). | Histogram |
465+
| `rpc.client.request.size` | Measures the size of RPC request messages (uncompressed). | Histogram |
466+
| `rpc.client.response.size` | Measures the size of RPC response messages (uncompressed). | Histogram |
467+
| `rpc.server.call.duration` | Measures the duration of inbound remote procedure calls (RPC). | Histogram |
468+
| `rpc.server.request.size` | Measures the size of RPC request messages (uncompressed). | Histogram |
469+
| `rpc.server.response.size` | Measures the size of RPC response messages (uncompressed). | Histogram |
474470

475471
> [!NOTE]
476472
>
477473
> The `http*` and `rpc*` metrics are not covered by the maturity levels below
478474
> since they are not under the Collector SIG control.
479475
>
476+
> RPC metric names are version-dependent. For instance, Collector releases
477+
> prior to 0.147.0 exposed `rpc.client.duration` and `rpc.server.duration`
478+
> instead of `rpc.client.call.duration` and `rpc.server.call.duration`.
479+
>
480480
> The `otelcol_processor_batch_` metrics are unique to the `batchprocessor`.
481481
>
482482
> The `otelcol_receiver_`, `otelcol_scraper_`, `otelcol_processor_`, and

0 commit comments

Comments
 (0)
⚡