Observability: define shared optional OTLP/OpenObserve config contract #1

New issue

Open

opened 2026-08-26 07:46:05 +00:00 by lost-rob0t · 0 comments

lost-rob0t commented

2026-08-26 07:46:05 +00:00

(Migrated from github.com)

Goal

Define a common StarIntel configuration shape for operator-controlled observability, coordinated with https://github.com/lost-rob0t/starintel-server/issues/128.

The contract should be OpenTelemetry/OTLP-first; OpenObserve is one supported backend.

Requirements

Observability block is optional and defaults disabled.
Missing block preserves existing application behavior exactly.
Common fields: enabled, protocol, endpoint, service name, environment, stream, signal toggles, batching/queue/timeouts, resource attributes, and redaction/filter settings.
Credentials are represented only as environment/secret references; never literal checked-in secrets.
Define stable names/types usable from Nim plus mappings/examples for Lisp, Python, and JS consumers.
Define per-signal defaults and bounded retry/drop behavior.
Explicitly distinguish operator observability from product telemetry.
Schema/tests prove disabled configuration causes no exporter requirement or network activity in consumers.

Compatibility constraint

Do not force modern StarIntel components to depend on this repository if it is no longer their configuration authority. The important deliverable is the shared contract; active projects may mirror it in their native init/config system.

Docs: https://openobserve.ai/docs/ingestion/

Exclusion

No anonymous analytics or StarIntel-owned telemetry endpoint in this work.

## Goal Define a common StarIntel configuration shape for operator-controlled observability, coordinated with https://github.com/lost-rob0t/starintel-server/issues/128. The contract should be OpenTelemetry/OTLP-first; OpenObserve is one supported backend. ## Requirements - [ ] Observability block is optional and defaults disabled. - [ ] Missing block preserves existing application behavior exactly. - [ ] Common fields: `enabled`, protocol, endpoint, service name, environment, stream, signal toggles, batching/queue/timeouts, resource attributes, and redaction/filter settings. - [ ] Credentials are represented only as environment/secret references; never literal checked-in secrets. - [ ] Define stable names/types usable from Nim plus mappings/examples for Lisp, Python, and JS consumers. - [ ] Define per-signal defaults and bounded retry/drop behavior. - [ ] Explicitly distinguish operator observability from product telemetry. - [ ] Schema/tests prove disabled configuration causes no exporter requirement or network activity in consumers. ## Compatibility constraint Do not force modern StarIntel components to depend on this repository if it is no longer their configuration authority. The important deliverable is the shared contract; active projects may mirror it in their native init/config system. Docs: https://openobserve.ai/docs/ingestion/ ## Exclusion No anonymous analytics or StarIntel-owned telemetry endpoint in this work.