Skip to content

docs: bring observability-exporters.md current with all three kinds (otlp_http + aliyun_sls + object_store) #540

Description

@moonming

Problem

docs/configuration/observability-exporters.md still says "Current scope is kind: \"otlp_http\" only." (line 9) and documents only the OTLP/HTTP exporter. The feature has since grown to three kinds, all with real DP delivery + e2e coverage, and a generalized dashboard form — none of which is documented:

Scope

Update docs/configuration/observability-exporters.md (keep the existing structure — Current Fields / Endpoint Restriction / Runtime Model / Operator Guidance / Troubleshooting / Related Pages — and the Docusaurus sentence-case conventions). Anchor every field/value to current code, don't invent.

Add / revise:

  1. Kinds overview — replace the "otlp_http only" line with the three kinds + a one-line purpose each.
  2. Per-kind config + supported backends:
    • otlp_http: endpoint (full /v1/traces URL) + headers; the backend list above; note the dashboard presets (Langfuse / Honeycomb / Grafana Cloud Tempo) and that Tempo/Loki/Jaeger are self-hosted (enter the endpoint manually).
    • aliyun_sls: endpoint (bare region host, e.g. ap-southeast-3.log.aliyuncs.com), project, logstore, credential_ref, content_mode (metadata_only default | full), content_max_bytes (default 128 KiB, ≤ 1 MiB).
    • object_store: provider (s3/gcs/azure_blob), bucket, prefix, region, credential_ref, compression (gzip/none), optional endpoint for S3-compatible (MinIO / R2).
  3. credential_ref (the secret model) — for aliyun_sls + object_store, the cloud AccessKey is never in the config / cp-api / kine; only an opaque credential_ref the customer-deployed DP resolves locally (env / mounted secret). Document the DP-side env convention (SLS_CRED_<REF>_AK_ID / _AK_SECRET for SLS) and that the control plane stores only the reference.
  4. content_mode privacy notefull writes end-user prompt + response text into the customer's SLS; opt-in, per-field-capped, with a content_truncated marker. Make the privacy implication explicit (and note the dashboard surfaces a warning when enabling Full).
  5. Dashboard configuration flow — the multi-kind exporter form (Kind selector → per-kind field group), one-click presets (OTLP vendors + S3/GCS/Azure/MinIO/R2), and the credential-reference field (not a plaintext key). cp-api validates per-kind before persisting.
  6. Cross-links / Related Pages — link the design issues for depth.

References (anchor to these)

Not in this doc (future kinds — mention as roadmap only)

datadog_logs (#688), Snowflake (#690), Databricks Delta Lake (#380) are designed but not shipped — list under a short "Roadmap" note, don't document config that doesn't exist yet.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions