Octopus
1.x
Docs/Octopus/Observability
Open

Reading1 min
Updated31 Jul 2026
Sourcev1/configuration/observability.mdx

Observability

The observability section configures logging, metrics, and tracing. The whole block is optional and has sensible defaults. For conceptual coverage, see the Observability section.

Warning

Runtime status: metrics.endpoint is inert (metrics are always served on the fixed /metrics and /__metrics paths on the listen port), but metrics.enabled: false gates the endpoint to a 404. logging.level and logging.format (json or text) are honored (a --log-level flag overrides the level). tracing exports spans over OTLP when tracing.enabled and an endpoint are set — see Observability → Tracing. See Observability for what is emitted today.

observability:
  logging:
    level: info
    format: json
  metrics:
    enabled: true
    endpoint: /metrics
  tracing:
    enabled: true
    jaeger_endpoint: http://jaeger:14268/api/traces

logging01

KeyTypeDefaultDescription
levelstringinfoLog level (e.g. trace, debug, info, warn, error).
formatstringtextLog format: json or text.

metrics02

KeyTypeDefaultDescription
enabledbooleantrueEnable metrics collection and the metrics endpoint.
endpointstring/metricsPath the metrics are served on.

tracing03

KeyTypeDefaultDescription
enabledbooleanfalseEnable distributed tracing.
jaeger_endpointstringnoneJaeger collector endpoint.
Note

The metrics endpoint is served under the gateway's internal route prefix (see gateway.internal_route_prefix in Gateway). See Observability for dashboards and trace propagation details.