Fix OTel documentation

traefik · May 16, 2024 · e68e647 · e68e647
1 parent 8b55864
commit e68e647
Show file tree

Hide file tree

Showing 2 changed files with 84 additions and 82 deletions.
diff --git a/docs/content/observability/metrics/overview.md b/docs/content/observability/metrics/overview.md
@@ -5,7 +5,7 @@ description: "Traefik Proxy supports these metrics backend systems: Datadog, Inf
 
 # Metrics
 
-Traefik supports these metrics backends:
+Traefik provides metrics in the [OpenTelemetry](./opentelemetry.md) format as well as the following vendor specific backends:
 
 - [Datadog](./datadog.md)
 - [InfluxDB2](./influxdb2.md)
@@ -46,6 +46,13 @@ addInternals = true
 | Open connections           | Gauge | `entrypoint`, `protocol` | The current count of open connections, by entrypoint and protocol. |
 | TLS certificates not after | Gauge |                          | The expiration date of certificates.                               |
 
+```opentelemetry tab="OpenTelemetry"
+traefik_config_reloads_total
+traefik_config_last_reload_success
+traefik_open_connections
+traefik_tls_certs_not_after
+```
+
 ```prom tab="Prometheus"
 traefik_config_reloads_total
 traefik_config_last_reload_success
@@ -75,13 +82,6 @@ traefik.tls.certs.notAfterTimestamp
 {prefix}.tls.certs.notAfterTimestamp
 ```
 
-```opentelemetry tab="OpenTelemetry"
-traefik_config_reloads_total
-traefik_config_last_reload_success
-traefik_open_connections
-traefik_tls_certs_not_after
-```
-
 ### Labels
 
 Here is a comprehensive list of labels that are provided by the global metrics:
@@ -91,8 +91,56 @@ Here is a comprehensive list of labels that are provided by the global metrics:
 | `entrypoint` | Entrypoint that handled the connection | "example_entrypoint" |
 | `protocol`   | Connection protocol                    | "TCP"                |
 
+## OpenTelemetry Semantic Conventions
+
+Traefik Proxy follows [official OpenTelemetry semantic conventions v1.23.1](https://github.com/open-telemetry/semantic-conventions/blob/v1.23.1/docs/http/http-metrics.md).
+
+### HTTP Server
+
+| Metric                        | Type      | [Labels](#labels)                                                                                                                        | Description                       |
+|-------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|
+| http.server.request.duration	 | Histogram | `error.type`, `http.request.method`, `http.response.status_code`, `network.protocol.name`, `server.address`, `server.port`, `url.scheme` | Duration of HTTP server requests  |
+
+#### Labels
+
+Here is a comprehensive list of labels that are provided by the metrics:
+
+| Label                       | Description                                                  | example       |
+|-----------------------------|--------------------------------------------------------------|---------------|
+| `error.type`                | Describes a class of error the operation ended with          | "500"         |
+| `http.request.method`       | HTTP request method                                          | "GET"         |
+| `http.response.status_code` | HTTP response status code                                    | "200"         |
+| `network.protocol.name`     | OSI application layer or non-OSI equivalent                  | "http/1.1"    |
+| `network.protocol.version`  | Version of the protocol specified in `network.protocol.name` | "1.1"         |
+| `server.address`            | Name of the local HTTP server that received the request      | "example.com" |
+| `server.port`               | Port of the local HTTP server that received the request      | "80"          |
+| `url.scheme`                | The URI scheme component identifying the used protocol       | "http"        |
+
+### HTTP Client
+
+| Metric                        | Type      | [Labels](#labels)                                                                                                                        | Description                       |
+|-------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|
+| http.client.request.duration	 | Histogram | `error.type`, `http.request.method`, `http.response.status_code`, `network.protocol.name`, `server.address`, `server.port`, `url.scheme` | Duration of HTTP client requests  |
+
+#### Labels
+
+Here is a comprehensive list of labels that are provided by the metrics:
+
+| Label                       | Description                                                  | example       |
+|-----------------------------|--------------------------------------------------------------|---------------|
+| `error.type`                | Describes a class of error the operation ended with          | "500"         |
+| `http.request.method`       | HTTP request method                                          | "GET"         |
+| `http.response.status_code` | HTTP response status code                                   | "200"         |
+| `network.protocol.name`     | OSI application layer or non-OSI equivalent                  | "http/1.1"    |
+| `network.protocol.version`  | Version of the protocol specified in `network.protocol.name` | "1.1"         |
+| `server.address`            | Name of the local HTTP server that received the request      | "example.com" |
+| `server.port`               | Port of the local HTTP server that received the request      | "80"          |
+| `url.scheme`                | The URI scheme component identifying the used protocol       | "http"        |
+
 ## HTTP Metrics
 
+On top of the official OpenTelemetry semantic conventions, Traefik provides its own metrics to monitor the incoming traffic.
+
 ### EntryPoint Metrics
 
 | Metric                | Type      | [Labels](#labels)                          | Description                                                         |
@@ -103,6 +151,14 @@ Here is a comprehensive list of labels that are provided by the global metrics:
 | Requests bytes total  | Count     | `code`, `method`, `protocol`, `entrypoint` | The total size of HTTP requests in bytes handled by an entrypoint.  |
 | Responses bytes total | Count     | `code`, `method`, `protocol`, `entrypoint` | The total size of HTTP responses in bytes handled by an entrypoint. |
 
+```opentelemetry tab="OpenTelemetry"
+traefik_entrypoint_requests_total
+traefik_entrypoint_requests_tls_total
+traefik_entrypoint_request_duration_seconds
+traefik_entrypoint_requests_bytes_total
+traefik_entrypoint_responses_bytes_total
+```
+
 ```prom tab="Prometheus"
 traefik_entrypoint_requests_total
 traefik_entrypoint_requests_tls_total
@@ -136,14 +192,6 @@ traefik.entrypoint.responses.bytes.total
 {prefix}.entrypoint.responses.bytes.total
 ```
 
-```opentelemetry tab="OpenTelemetry"
-traefik_entrypoint_requests_total
-traefik_entrypoint_requests_tls_total
-traefik_entrypoint_request_duration_seconds
-traefik_entrypoint_requests_bytes_total
-traefik_entrypoint_responses_bytes_total
-```
-
 ### Router Metrics
 
 | Metric                | Type      | [Labels](#labels)                                 | Description                                                    |
@@ -154,6 +202,14 @@ traefik_entrypoint_responses_bytes_total
 | Requests bytes total  | Count     | `code`, `method`, `protocol`, `router`, `service` | The total size of HTTP requests in bytes handled by a router.  |
 | Responses bytes total | Count     | `code`, `method`, `protocol`, `router`, `service` | The total size of HTTP responses in bytes handled by a router. |
 
+```opentelemetry tab="OpenTelemetry"
+traefik_router_requests_total
+traefik_router_requests_tls_total
+traefik_router_request_duration_seconds
+traefik_router_requests_bytes_total
+traefik_router_responses_bytes_total
+```
+
 ```prom tab="Prometheus"
 traefik_router_requests_total
 traefik_router_requests_tls_total
@@ -187,14 +243,6 @@ traefik.router.responses.bytes.total
 {prefix}.router.responses.bytes.total
 ```
 
-```opentelemetry tab="OpenTelemetry"
-traefik_router_requests_total
-traefik_router_requests_tls_total
-traefik_router_request_duration_seconds
-traefik_router_requests_bytes_total
-traefik_router_responses_bytes_total
-```
-
 ### Service Metrics
 
 | Metric                | Type      | Labels                                  | Description                                                 |
@@ -207,6 +255,16 @@ traefik_router_responses_bytes_total
 | Requests bytes total  | Count     | `code`, `method`, `protocol`, `service` | The total size of requests in bytes received by a service.  |
 | Responses bytes total | Count     | `code`, `method`, `protocol`, `service` | The total size of responses in bytes returned by a service. |
 
+```opentelemetry tab="OpenTelemetry"
+traefik_service_requests_total
+traefik_service_requests_tls_total
+traefik_service_request_duration_seconds
+traefik_service_retries_total
+traefik_service_server_up
+traefik_service_requests_bytes_total
+traefik_service_responses_bytes_total
+```
+
 ```prom tab="Prometheus"
 traefik_service_requests_total
 traefik_service_requests_tls_total
@@ -248,16 +306,6 @@ traefik.service.responses.bytes.total
 {prefix}.service.responses.bytes.total
 ```
 
-```opentelemetry tab="OpenTelemetry"
-traefik_service_requests_total
-traefik_service_requests_tls_total
-traefik_service_request_duration_seconds
-traefik_service_retries_total
-traefik_service_server_up
-traefik_service_requests_bytes_total
-traefik_service_responses_bytes_total
-```
-
 ### Labels
 
 Here is a comprehensive list of labels that are provided by the metrics:
@@ -282,49 +330,3 @@ Here is a comprehensive list of labels that are provided by the metrics:
     If the HTTP method verb on a request is not one defined in the set of common methods for [`HTTP/1.1`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods)
     or the [`PRI`](https://datatracker.ietf.org/doc/html/rfc7540#section-11.6) verb (for `HTTP/2`),
     then the value for the method label becomes `EXTENSION_METHOD`.
-
-## Semantic Conventions for HTTP Metrics
-
-Traefik Proxy follows [official OTLP semantic conventions v1.23.1](https://github.com/open-telemetry/semantic-conventions/blob/v1.23.1/docs/http/http-metrics.md).
-
-### HTTP Server
-
-| Metric                        | Type      | [Labels](#labels)                                                                                                                        | Description                       |
-|-------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|
-| http.server.request.duration	 | Histogram | `error.type`, `http.request.method`, `http.response.status_code`, `network.protocol.name`, `server.address`, `server.port`, `url.scheme` | Duration of HTTP server requests  |
-
-#### Labels
-
-Here is a comprehensive list of labels that are provided by the metrics:
-
-| Label                       | Description                                                  | example       |
-|-----------------------------|--------------------------------------------------------------|---------------|
-| `error.type`                | Describes a class of error the operation ended with          | "500"         |
-| `http.request.method`       | HTTP request method                                          | "GET"         |
-| `http.response.status_code` | HTTP response status code                                    | "200"         |
-| `network.protocol.name`     | OSI application layer or non-OSI equivalent                  | "http/1.1"    |
-| `network.protocol.version`  | Version of the protocol specified in `network.protocol.name` | "1.1"         |
-| `server.address`            | Name of the local HTTP server that received the request      | "example.com" |
-| `server.port`               | Port of the local HTTP server that received the request      | "80"          |
-| `url.scheme`                | The URI scheme component identifying the used protocol       | "http"        |
-
-### HTTP Client
-
-| Metric                        | Type      | [Labels](#labels)                                                                                                                        | Description                       |
-|-------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|
-| http.client.request.duration	 | Histogram | `error.type`, `http.request.method`, `http.response.status_code`, `network.protocol.name`, `server.address`, `server.port`, `url.scheme` | Duration of HTTP client requests  |
-
-#### Labels
-
-Here is a comprehensive list of labels that are provided by the metrics:
-
-| Label                       | Description                                                  | example       |
-|-----------------------------|--------------------------------------------------------------|---------------|
-| `error.type`                | Describes a class of error the operation ended with          | "500"         |
-| `http.request.method`       | HTTP request method                                          | "GET"         |
-| `http.response.status_code` | HTTP response status code                                   | "200"         |
-| `network.protocol.name`     | OSI application layer or non-OSI equivalent                  | "http/1.1"    |
-| `network.protocol.version`  | Version of the protocol specified in `network.protocol.name` | "1.1"         |
-| `server.address`            | Name of the local HTTP server that received the request      | "example.com" |
-| `server.port`               | Port of the local HTTP server that received the request      | "80"          |
-| `url.scheme`                | The URI scheme component identifying the used protocol       | "http"        |
diff --git a/docs/content/observability/overview.md b/docs/content/observability/overview.md
@@ -29,14 +29,14 @@ Read the [Access Logs documentation](./access-logs.md) to learn how to configure
 Traefik offers a metrics feature that provides valuable insights about the performance and usage.
 These metrics include the number of requests received, the requests duration, and more.
 
-Traefik supports these metrics systems: Prometheus, Datadog, InfluxDB 2.X, and StatsD.
+On top of supporting metrics in the OpenTelemetry format, Traefik supports the following vendor specific metrics systems: Prometheus, Datadog, InfluxDB 2.X, and StatsD.
 
 Read the [Metrics documentation](./metrics/overview.md) to learn how to configure it.
 
 ## Tracing
 
 The Traefik tracing system allows developers to gain deep visibility into the flow of requests through their infrastructure.
 
-Traefik supports these tracing with OpenTelemetry.
+Traefik provides tracing information in the OpenTelemery format.
 
 Read the [Tracing documentation](./tracing/overview.md) to learn how to configure it.