Document captured HTTP headers configuration options #4321
Conversation
mateuszrzeszutek
requested review from
anuraaga,
iNikem,
jkwatson,
laurit,
pavolloffay,
trask and
tylerbenson
as code owners
Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>
| | `otel.instrumentation.common.experimental.capture-http-headers.client.request` | `OTEL_INSTRUMENTATION_COMMON_EXPERIMENTAL_CAPTURE_HTTP_HEADERS_CLIENT_REQUEST` | A comma-separated list of HTTP header names. HTTP client instrumentations will capture HTTP request header values for all configured header names. | ||
| | `otel.instrumentation.common.experimental.capture-http-headers.client.response` | `OTEL_INSTRUMENTATION_COMMON_EXPERIMENTAL_CAPTURE_HTTP_HEADERS_CLIENT_RESPONSE` | A comma-separated list of HTTP header names. HTTP client instrumentations will capture HTTP response header values for all configured header names. | ||
| | `otel.instrumentation.common.experimental.capture-http-headers.server.request` | `OTEL_INSTRUMENTATION_COMMON_EXPERIMENTAL_CAPTURE_HTTP_HEADERS_SERVER_REQUEST` | A comma-separated list of HTTP header names. HTTP server instrumentations will capture HTTP request header values for all configured header names. | ||
| | `otel.instrumentation.common.experimental.capture-http-headers.server.response` | `OTEL_INSTRUMENTATION_COMMON_EXPERIMENTAL_CAPTURE_HTTP_HEADERS_SERVER_RESPONSE` | A comma-separated list of HTTP header names. HTTP server instrumentations will capture HTTP response header values for all configured header names. |
There was a problem hiding this comment.
Yeah... If somebody has a better idea for these, please speak up! Except from dropping the experimental part at some point in time I couldn't think of anything to make them better.
There was a problem hiding this comment.
Wait, they’re still open for discussion? I love naming vars. Let’s discuss today. :)
Co-authored-by: Trask Stalnaker <[email protected]>
Merging, but yes @theletterf please send in any ideas! we can definitely change any of the names that have |
|
@trask Thanks! @mateuszrzeszutek and I tried to shorten those names, to no avail. But we did came up with an intriguing idea that would essentially get rid of |
I moved docs for properties that are common to all instrumentations to a separate file - and created a new directory for instrumentation configuration docs. Perhaps in the future we'll have a
config/reactor-netty.mdfile with Reactor Netty speficic configs, aconfig/spring-batch.mdwith Spring Batch configs and so on.CC @theletterf