Skip to content

Commit

Permalink
Merge branch 'add_monitoring' of github.com:surrealdb/docs.surrealdb.…
Browse files Browse the repository at this point in the history
…com into add_monitoring
  • Loading branch information
MichelHollands committed Jan 13, 2025
2 parents 585d2df + 54f8926 commit f339340
Showing 1 changed file with 1 addition and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: In SurrealDB, metrics and traces are available if enabled⁠.
SurrealDB can be monitored by enabling the built in observability.

## Enable observability
To enable observability the `SURREAL_TELEMETRY_PROVIDER` environment variable has to be set to `otlp`. If set to anything else no observability will be available.
To enable observability, the `SURREAL_TELEMETRY_PROVIDER` environment variable has to be set to `otlp`. If set to anything else, no observability will be available.

If enabled, SurrealDB will send metrics and/or traces to an [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/). Configuration of the collector is done via [environment variables](https://opentelemetry.io/docs/languages/sdk-configuration/otlp-exporter/). The most important one is [OTEL_EXPORTER_OTLP_ENDPOINT](https://opentelemetry.io/docs/languages/sdk-configuration/otlp-exporter/#otel_exporter_otlp_endpoint). By default this is set to localhost. It should be set to the GRPC endpoint of your OTEL collector. For example if your OTEL collector named `my-collector` is running in Kubernetes in the `monitoring` namespace the following can be used:

Expand Down

0 comments on commit f339340

Please sign in to comment.