Skip to content

README.md

Latest commit

 

History

History
45 lines (32 loc) · 1.45 KB

README.md

File metadata and controls

45 lines (32 loc) · 1.45 KB
Raw

Technical documentation

Plural Telemetry provides object-store-backed databases and related services:

  • Metrics: Prometheus-compatible metrics.
  • Logs: Loki-compatible logs.
  • Traces: Tempo-compatible traces.
  • PseudoFS: a gRPC virtual filesystem for embedded runtimes.

Each database section describes its storage format, index strategy, public APIs, and server configuration. Cross-cutting behavior lives under common:

Benchmarks records differential fuzz results against Loki, Prometheus/Mimir, and Tempo over time.

These pages describe the implementation and operationally important limits. For Kubernetes CRD fields, also see the generated operator API reference. Complete runnable server examples live in config/.

Generated OpenAPI

Each server owns an OpenAPI 3.1 description generated with Utoipa. Regenerate the checked-in JSON documents after changing an HTTP route:

cargo run -p api-docs

CI-style drift check:

cargo run -p api-docs -- --check

OpenAPI covers HTTP APIs. Internal writer, OTLP, and Jaeger gRPC services remain described in the product API pages and their protobuf definitions.