Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document captured HTTP headers configuration options #4321

Conversation

mateuszrzeszutek
Copy link
Member

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.md file with Reactor Netty speficic configs, a config/spring-batch.md with Spring Batch configs and so on.

CC @theletterf

docs/config/common.md Outdated Show resolved Hide resolved
docs/config/common.md Outdated Show resolved Hide resolved
docs/config/common.md Outdated Show resolved Hide resolved
docs/config/common.md Outdated Show resolved Hide resolved
docs/config/common.md Outdated Show resolved Hide resolved
docs/config/common.md Outdated Show resolved Hide resolved
docs/config/common.md Outdated Show resolved Hide resolved
docs/config/common.md Outdated Show resolved Hide resolved
docs/config/common.md Outdated Show resolved Hide resolved
docs/config/common.md Outdated Show resolved Hide resolved
Mateusz Rzeszutek and others added 2 commits October 7, 2021 16:16
docs/config/common.md Outdated Show resolved Hide resolved
Comment on lines +43 to +46
| `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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these long names 😭

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wait, they’re still open for discussion? I love naming vars. Let’s discuss today. :)

Co-authored-by: Trask Stalnaker <[email protected]>
@trask
Copy link
Member

trask commented Oct 8, 2021

Wait, they’re still open for discussion? I love naming vars. Let’s discuss today. :)

Merging, but yes @theletterf please send in any ideas! we can definitely change any of the names that have EXPERIMENTAL in them.

@trask trask merged commit 2fbec93 into open-telemetry:main Oct 8, 2021
@mateuszrzeszutek mateuszrzeszutek deleted the document-captured-http-headers-properties branch October 9, 2021 07:12
@theletterf
Copy link
Member

@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 COMMON in favour of instrumentation categories that are indeed shared, such as HTTP, or LOG. I believe Mateusz will pitch this in the next SIG meeting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants