Document Otel environment variables (#552)

nais · Nov 6, 2023 · 2603399 · 2603399
1 parent cc9919c
commit 2603399
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/docs/observability/tracing.md b/docs/observability/tracing.md
@@ -47,6 +47,29 @@ That configuration is provided by NAIS through the `$OTEL_EXPORTER_OTLP_ENDPOINT
 which in turn is supposed to be automatically detected and used by your OpenTelemetry library.
 All data must be sent using the gRPC protocol.
 
+## Environment variables
+
+The following environment variables are available for configuring the tracing library:
+
+| Name                          | Description                                                                       | Default value                                             |
+| ----------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------- |
+| `OTEL_SERVICE_NAME`           | The name of the service.                                                          | `$APP_NAME`                                               |
+| `OTEL_RESOURCE_ATTRIBUTES`    | A comma-separated list of key-value pairs to be added to the resource attributes. | `service.name=$APP_NAME,service.namespace=$APP_NAMESPACE` |
+| `OTEL_EXPORTER_OTLP_ENDPOINT` | The endpoint to send trace data to.                                               | `http://tempo-distributor.nais-system:4317`               |
+| `OTEL_EXPORTER_PROTOCOL`      | The protocol to use when sending trace data. Must be `grpc`.                      | `grpc`                                                    |
+
+## Instrumenting your application
+
+The following libraries are available for instrumenting your application:
+
+| Language | Library                                                                                           |
+| -------- | ------------------------------------------------------------------------------------------------- |
+| Java     | [OpenTelemetry Java](https://opentelemetry.io/docs/instrumentation/java/getting-started/)         |
+| Node.js  | [OpenTelemetry Node.js](https://opentelemetry.io/docs/instrumentation/js/getting-started/nodejs/) |
+| Python   | [OpenTelemetry Python](https://opentelemetry.io/docs/python/getting-started/)                     |
+| Go       | [OpenTelemetry Go](https://opentelemetry.io/docs/go/getting-started/)                             |
+
+You can also see the [nais/examples](https://github.com/nais/examples) repository for examples of how to instrument your application.
 
 ## Visualizing application performance