diff options
Diffstat (limited to 'example/config.yaml')
| -rw-r--r-- | example/config.yaml | 40 |
1 files changed, 35 insertions, 5 deletions
diff --git a/example/config.yaml b/example/config.yaml index 3e7375627..9eaa560fe 100644 --- a/example/config.yaml +++ b/example/config.yaml @@ -1076,20 +1076,50 @@ syslog-protocol: "udp" # Default: "localhost:514" syslog-address: "localhost:514" -################################## -##### OBSERVABILITY SETTINGS ##### -################################## +############################################## +##### OBSERVABILITY AND METRICS SETTINGS ##### +############################################## -# String. Header name to use to extract a request or trace ID from. Typically set by a -# loadbalancer or proxy. +# String. Header name to use to extract a request or +# trace ID from. Typically set by a loadbalancer or proxy. +# # Default: "X-Request-Id" request-id-header: "X-Request-Id" # Bool. Enable OpenTelemetry based tracing support. +# +# When enabling tracing, you must also configure a traces +# exporter using the OTEL environment variable documented here: +# +# https://opentelemetry.io/docs/languages/sdk-configuration/general/#otel_traces_exporter +# # Default: false tracing-enabled: false # Bool. Enable OpenTelemetry based metrics support. +# +# To expose Prometheus metrics, you must configure a metrics producer and +# a metrics exporter, using the OTEL environment variables documented here: +# +# https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/autoexport#NewMetricReader +# +# Typically, you will want to set the following environment variables +# (take note of the plural "producers" and singular "exporter"): +# +# - OTEL_METRICS_PRODUCERS=prometheus +# - OTEL_METRICS_EXPORTER=prometheus +# +# With these variables set, a Prometheus metrics endpoint will be exposed at +# localhost:9464/metrics. This can be further configured using the variables: +# +# - OTEL_EXPORTER_OTLP_METRICS_PROTOCOL +# - OTEL_EXPORTER_PROMETHEUS_HOST +# - OTEL_EXPORTER_PROMETHEUS_PORT +# +# For more information, see the GtS metrics documentation here: +# +# https://docs.gotosocial.org/en/latest/advanced/metrics/ +# # Default: false metrics-enabled: false |