support/http: log user agent header at request start #2619
Merged
Conversation
This file contains 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
### What Log the `User-Agent` header at request start. ### Why Identifying which agent sent a request can be useful in the reference implementations that accept inbound requests. It can be useful for debugging strange issues, understanding broad usage patterns, and if a service is deployed in use with a specific client and that client uses the User-Agent header to communicate its version it can help an operator understand what versions of its client are accessing the service. This can help make decisions about upgrade plans, etc. The specific use case I have is that we are deploying webauth and recoverysigner with a client and I want to be able to know which version of the client is accessing these services. Horizon and the Horizon SDKs actually use some custom headers to achieve this specific goal but I am not repeating that pattern since it is more common to communicate this information in the user agent header. The header does not normally contain any personally identifiable information or sensitive information and so I believe there are no concerns on that front.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR Checklist
PR Structure
otherwise).
services/friendbot, orallordocif the changes are broad or impact manypackages.
Thoroughness
.mdfiles, etc... affected by this change). Take a look in the
docsfolder for a given service,like this one.
Release planning
needed with deprecations, added features, breaking changes, and DB schema changes.
semver, or if it's mainly a patch change. The PR is targeted at the next
release branch if it's not a patch change.
What
Log the
User-Agentheader at request start.Why
Identifying which agent sent a request can be useful in the reference
implementations that accept inbound requests. It can be useful for
debugging strange issues, understanding broad usage patterns, and if a
service is deployed in use with a specific client and that client uses
the User-Agent header to communicate its version it can help an operator
understand what versions of its client are accessing the service. This
can help make decisions about upgrade plans, etc.
The specific use case I have is that we are deploying webauth and
recoverysigner with a client and I want to be able to know which version
of the client is accessing these services.
Horizon and the Horizon SDKs actually use some custom headers to achieve
this specific goal but I am not repeating that pattern since it is more
common to communicate this information in the user agent header.
The header does not normally contain any personally identifiable
information or sensitive information and so I believe there are no
concerns on that front.
This change impacts these services inside this repo:
exp/services/webauthexp/services/recoverysignerservices/friendbotservices/federationKnown limitations
N/A