Change HttpLogOptions to be HttpInstrumentationOptions, update docs #43780
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this episode, we
HttpLogOptions
to configure all HTTP instrumentation. It extendsInstrumentationOptions
and is calledHttpInstrumentationOptions
. It's now part ofHttpTrait
This matches current and proposed .NET behavior
Thoughts/doubts on the API changes:
HttpInstrumentationOptions
is flat. Some of it applies to logging only (headers).I don't envision tons of tracing and metrics options there or in
InstrumentationOptions
- configuration would be done on the otel side, our fallback does not need to be customizable, so having dedicatedTracingOptions
orMetricsOptions
seems to be an overkill.Separating
HttpLogOptions
(so it's clear they only affect logs) is an alternative, but it'd be a mouthful to writenew HttpInstrumentationOptions<>().setHttpLogOptions(new HttpLogOptions().setLoggingEnabled(true))
vsnew HttpInstrumentationOptions<>().setLoggingEnabled(true))
There are examples when SDKs need to provide more tracing/metrics/logging options (Cosmos has quite a few, SB/EH would need some) - they would need to extend either
InstrumentationOptions
orHttpInstrumentationOptions
depending on the protocol.