mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-12-27 09:36:31 +00:00
56204cc2f4
Add support for sending additional HTTP or gRPC headers which can be used for authentication or other additional information for the tracing system without having to set up a local instance of the OpenTelemetry Collector to add these headers. Example with Dash0: ```yaml tracing-enabled: false tracing-transport: "grpc" tracing-endpoint: "ingress.eu-west-1.aws.dash0.com:4317" tracing-headers: "Authorization": "Bearer DASH0_AUTH_TOKEN" "Dash0-Dataset": "gotosocial" ``` Example with Honeycomb: ```yaml tracing-enabled: false tracing-transport: "grpc" tracing-endpoint: "api.honeycomb.io:443" tracing-headers: "x-honeycomb-team": "YOUR_API_KEY" "x-honeycomb-dataset": "YOUR_DATASET" ```
64 lines
1.9 KiB
Markdown
64 lines
1.9 KiB
Markdown
# Observability
|
|
|
|
These settings let you tune and configure certain observability related behaviours.
|
|
|
|
## Metrics
|
|
|
|
Before enabling metrics, [read the guide](../advanced/metrics.md) and ensure you've taken the appropriate security measures for your setup.
|
|
|
|
## Settings
|
|
|
|
```yaml
|
|
##################################
|
|
##### OBSERVABILITY SETTINGS #####
|
|
##################################
|
|
|
|
# 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.
|
|
# Default: false
|
|
tracing-enabled: false
|
|
|
|
# String. Set the transport protocol for the tracing system. Can either be "grpc"
|
|
# for OTLP gRPC, or "http" for OTLP HTTP.
|
|
# Options: ["grpc", "http"]
|
|
# Default: "grpc"
|
|
tracing-transport: "grpc"
|
|
|
|
# String. Endpoint of the trace ingester. When using the gRPC or HTTP based
|
|
# transports, provide the endpoint as a single address/port combination without a
|
|
# protocol scheme.
|
|
# Examples: ["localhost:4317"]
|
|
# Default: ""
|
|
tracing-endpoint: ""
|
|
|
|
# Map of strings. Additional headers to send to the trace ingester.
|
|
# Additional HTTP or gRPC headers can be used for authentication or other additional
|
|
# information for the tracing system.
|
|
# Examples: {"Authorization": "Bearer super-secret-token", "Dataset": "gotosocial"}
|
|
# Default: {}
|
|
tracing-headers: {}
|
|
|
|
# Bool. Disable TLS for the gRPC and HTTP transport protocols.
|
|
# Default: false
|
|
tracing-insecure-transport: false
|
|
|
|
# Bool. Enable OpenTelemetry based metrics support.
|
|
# Default: false
|
|
metrics-enabled: false
|
|
|
|
# Bool. Enable HTTP Basic Authentication for Prometheus metrics endpoint.
|
|
# Default: false
|
|
metrics-auth-enabled: false
|
|
|
|
# String. Username for Prometheus metrics endpoint.
|
|
# Default: ""
|
|
metrics-auth-username: ""
|
|
|
|
# String. Password for Prometheus metrics endpoint.
|
|
# Default: ""
|
|
metrics-auth-password: ""
|
|
``` |