Skip to content
SHC Docs

OpenObserve

OpenObserve is an observability platform for logs, metrics, and traces.

Key features:

  • Log aggregation and search
  • Metrics visualization
  • Distributed tracing
  • Low resource usage

shc init installs SHC’s own OpenObserve into the master tenant, SHC’s own tenant, and it runs nowhere else. To add it later, on a cluster whose shc init --modules-config left it out, name that tenant:

Terminal window
shc -t master install openobserve

Common variables:

  • admin_user - Admin username (default: admin)
  • admin_password - Admin password (auto-generated)
  • public_host - Public hostname
  • s3_bucket - S3 bucket for storage (optional)

Configure SHC to send telemetry to OpenObserve:

config.yaml
collector:
enabled: true
endpoint: "http://openobserve:5080"
logs:
enabled: true
metrics:
enabled: true
traces:
enabled: true

OpenObserve receives:

  • Logs: JSON format via /shc_logs/_json
  • Metrics: Custom format via /ingest/metrics/_json
  • Traces: OTLP format via /v1/traces

Every estate runs OpenObserve’s AGPL build (public.ecr.aws/zinclabs/openobserve, AGPL-3.0-or-later) by default. It has no single sign-on or roles of its own, so its web UI sits behind SHC’s forward-auth gate: only platform operators get through, and behind the gate there is one shared OpenObserve login, the root user whose password the vault holds. The ingest and API paths are not gated and keep OpenObserve’s own basic auth, so collectors and agents are unaffected.

--variable enterprise=true opts into the Self-Hosted Enterprise image instead, which brings Keycloak sign-in through Dex. Its licence allows internal use only, below 50 GB a day per legal entity, with telemetry on, and forbids running it for third parties as an MSP, SaaS or hosting service. See licensing postures.

  • URL: https://{public_host}
  • Username: {admin_user}
  • Password: (from vault) shc vault get observability/admin_password

Example log query:

SELECT * FROM shc_logs
WHERE tenant = 'production'
AND timestamp > now() - interval '1 hour'
ORDER BY timestamp DESC
LIMIT 100

OpenObserve backup includes:

  • Configuration
  • User accounts
  • Dashboards and alerts
  • Indexed data (if using local storage)

Note: S3-backed data is not included in backups (managed externally).

Common issues:

Problem: No logs appearing Solution: Verify collector endpoint in config.yaml

Problem: High memory usage Solution: Reduce retention period or use S3 storage