Skip to main content
The Orchestrator produces three categories of observability data: structured logs, OpenTelemetry metrics, and OpenTelemetry traces. This section covers what the Orchestrator emits, how to configure each category, and where to send the data.
Console terminology: In the Maverics Console, Orchestrator instances and configuration delivery are managed through Deployments. When working directly with YAML, configuration is managed as files delivered via the -config flag or MAVERICS_CONFIG environment variable.

​
Observability Categories

​
Structured Logging

The Orchestrator uses a single structured logger for all runtime output — startup, configuration loading, authentication decisions, authorization decisions, session operations, health checks, errors, and more. Logs can be output in JSON format for machine parsing and forwarded to any log aggregation or SIEM system. Session ID correlation and field ordering provide consistent, searchable log entries.

​
OpenTelemetry Metrics

The Orchestrator exports request, authentication, and runtime metrics via the OTLP protocol. Periodic readers push metrics to your OTLP endpoint at a configurable interval, giving you visibility into request volumes, error rates, latencies, and resource utilization.

​
OpenTelemetry Traces

The Orchestrator supports distributed tracing via the OTLP protocol, providing end-to-end visibility into request processing through authentication and authorization flows. Trace data is exported to any OTLP-compatible backend.

​
Telemetry Pages

Logging

Structured operational and auth event logging with JSON output, filtering, and session correlation

Metrics

OpenTelemetry metrics via OTLP for request, authentication, and runtime data

Traces

OpenTelemetry distributed tracing via OTLP for end-to-end request visibility

​
Health Check Configuration

The health key configures the health check endpoint and periodic heartbeat logging. The health endpoint is used by load balancers and orchestration platforms to verify the Orchestrator is running.
KeyTypeDefaultRequiredDescription
health.locationstring"/status"NoHTTP path for the health check endpoint
health.heartbeat.disabledbooleanfalseNoDisable periodic heartbeat logging
health.heartbeat.logLevelstring"info"NoHeartbeat log level — "info" or "debug"
health.heartbeat.intervalstring"60s"NoHeartbeat interval (duration string, e.g., "60s", "5m")
The health endpoint responds with: 
{"status": "up"}
The periodic heartbeat log entry includes the following fields: orchestrator_id, orchestrator_version, config_version, cpu_count, cpu_usage, total_memory, memory_usage, and active_goroutines.

​
Cross-Reference

Configuration details for each telemetry category are on their respective sub-pages. For a step-by-step setup guide, see Monitor and Observe.

Monitor and Observe

Step-by-step guide for setting up observability in production

Orchestrator Configuration

Config file structure, environment variables, and runtime settings