[Extension Proposal] Provide extension for HTTP tracing header

[turing85]

Description

There are two quasi-standard header to use for user tracing: X-Request-ID and X-Correlation-ID^1,2. Its semantics normally is that it can be set by the client. If the client does not set it, the server should generate one. Every response should return the header - either the client-provided value, or the server-generated value if the client did not provide an id.

This header should:

• have a configurable name, defaulting to either X-Request-ID or X-Correlation-ID,
• be integrated in other forms of tracing, in particular OpenTelemetry. In particular, we want be able to find all traces that belong to a given request id,
• be propagated to downstream-systems so we can trace over multiple systems, and
• be integrated with OpenAPI.

Interested in this extension, please +1 via the emoji/reaction feature of GitHub (top right).

Repository name

quarkus-http-header-correlation-id

Short description

Provide HTTP Correlation ID headers

Repository Homepage URL

https://docs.quarkiverse.io/quarkus-http-header-correlation-id/dev/

Repository Topics

• web
• observability
• logging

Team Members

• turing85

Additional context

Why not use the trace- or span-id?

This is no replacement to OpenAPI's trace- or span-id; the trace- and span-ids are generated by OpenAPI, the tracing header can be set by the client.

Why do we need a separate value?

there are infrastructure components, like istio, that can - based on headers - route specific requests to specific application instances, for example based on the header. This can be used, for example, when debugging or reproducing issues.

[quarkus-bot]

/cc @aloubyansky (extension-proposal), @gastaldi (extension-proposal), @gsmet (extension-proposal), @maxandersen (extension-proposal)