[extension/clientaddrmiddleware] Add initial clientaddrmiddleware extension
#930
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vigneshshanmugam
approved these changes
Dec 8, 2025
| // ClientAddressMetadataKeys list of metadata keys to determine the client address. | ||
| // Keys are processed in order, the first valid value is used to set the client address. | ||
| // If there are no valid addresses found, the client address is not updated. | ||
| ClientAddressMetadataKeys []string `mapstructure:"client_address_metadata_keys,omitempty"` |
Member
There was a problem hiding this comment.
nit: MetadataKeys should suffice IMO
Contributor
Author
There was a problem hiding this comment.
Good call updated to metadata_keys
axw
reviewed
Dec 8, 2025
| Receivers should be configured with `include_metadata: true`, so that the context includes client metadata keys. | ||
|
|
||
| ### Example | ||
| The following example configures the middleware to set the client address based on the the `x-forwareded-for` metadata key (header). |
Member
There was a problem hiding this comment.
Suggested change
| The following example configures the middleware to set the client address based on the the `x-forwareded-for` metadata key (header). | |
| The following example configures the middleware to set the client address based on the the `x-forwarded-for` metadata key (header). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Overview
This PR adds the initial
clientaddrmiddlewareextension implementation which just includes the configuration, factory and middleware interface implementation.ClientAddressMetadataKeyshttp and grpc configuration to provide flexible client address determination open-telemetry/opentelemetry-collector#14224Currently both
confighttpandconfiggrpcset the client address based only one value RemoteAddress or peer address respectively. This middleware provides the flexibility to determine the client address (client.Info.Addr) from metadata keys.Enables custom processors such as the
elasticapmprocessorto enrich events with client IP address. See PR: #924.