chore: update otlp config section

flipt-io · Oct 2, 2023 · 158b05a · 158b05a
1 parent cc45f64
commit 158b05a
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 4 deletions.
diff --git a/configuration/observability.mdx b/configuration/observability.mdx
@@ -30,7 +30,7 @@ showing how to set up Flipt with Prometheus can be found in the GitHub repositor
 
 ![Grafana Dashboard](/images/configuration/grafana_flag_dashboard.png)
 
-We provide created a set of [Grafana](https://grafana.com/) dashboards that you can use to visualize the metrics collected by Flipt, including both server health and flag evaluation metrics.
+We provide a set of [Grafana](https://grafana.com/) dashboards that you can use to visualize the metrics collected by Flipt, including both server health and flag evaluation metrics.
 
 You can find the dashboards in our [grafana-dashboards](https://github.com/flipt-io/grafana-dashboards) repository.
 
@@ -48,6 +48,22 @@ Enable tracing via the values described in the [Tracing configuration](/configur
 
 [Examples](https://github.com/flipt-io/flipt/tree/main/examples/tracing) showing how to set up Flipt with each of the supported tracing backends can be found in the main GitHub repository .
 
+### OTLP
+
+OTLP supports additional configuration such as specifying the protocol to use (gRPC or HTTP) as well as providing custom headers to send with the request.
+
+Custom headers can be used to provide authentication information to the collector which may be required if you are using a hosted collector such as [NewRelic](https://docs.newrelic.com/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/get-started/opentelemetry-set-up-your-app/), [DataDog](https://docs.datadoghq.com/opentelemetry/otlp_ingest_in_the_agent/?tab=host), or [Honeycomb](https://docs.honeycomb.io/getting-data-in/opentelemetry-overview/#instrumenting-with-opentelemetry).
+
+These can be configured via the `tracing.otlp` configuration section.
+
+```yaml
+tracing:
+  otlp:
+    endpoint: "https://{your-collector-url}"
+    headers:
+      "X-Some-Header": "some-value"
+```
+
 ## Audit Events
 
 Flipt supports sending audit events to configured sinks. Audit events have the following structure:

diff --git a/configuration/overview.mdx b/configuration/overview.mdx
@@ -271,9 +271,10 @@ These properties are as follows:
 
 #### Tracing: OTLP
 
-| Property              | Description                    | Default        | Since   |
-| --------------------- | ------------------------------ | -------------- | ------- |
-| tracing.otlp.endpoint | The OTLP GRPC receiver address | localhost:4317 | v1.18.2 |
+| Property              | Description                                                       | Default               | Since   |
+| --------------------- | ----------------------------------------------------------------- | --------------------- | ------- |
+| tracing.otlp.endpoint | The OTLP receiver address (supports: grpc, http, https)           | grpc://localhost:4317 | v1.18.2 |
+| tracing.otlp.headers  | Additional headers to send with OTLP requests (map[string]string) |                       | v1.28.0 |
 
 ## Deprecations