Correlation IDs

Correlation metadata on ingestion ties append traffic to observability, support bundles, and other systems without changing the Spine type of the payload. The wire shape is the CorrelationIds message on the Ingest append stream; the TransactionMessage, BatchMessage, and CorrelationIds definitions in the ingest gRPC contract (linked from that page) are the authoritative field list.

A CorrelationIds value groups a primary correlation id (or relies on a server-generated one when you omit it) with repeated secondary entries—each key can carry a value as UUID, string, or bytes—so a single command can hold more than one kind of correlation at a time.

Message and transaction — CorrelationIds can be set on batch and transactional per-message appends. The same model can be used so correlation also applies to the overarching root or sub-transaction in addition to individual messages, as your client and downstream tooling expect. Exact propagation to logs and traces depends on the data plane version, SDK, and your org-level observability and integration setup.

See also — Ingests · Observability · gRPC transport · Application integration