Add metadata to User-Agent header #5774
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
rfratto
approved these changes
Nov 15, 2023
pkg/useragent/useragent.go
Outdated
| // package useragent provides a consistent way to get a user agent for outbound http requests from Grafana Agent. | ||
| // The default User-Agent is `GrafanaAgent/$VERSION($MODE)` | ||
| // Where version is the build version of the agent and MODE is one of "static" or "flow". | ||
| package useragent |
There was a problem hiding this comment.
Can we put this in internal/useragent instead of pkg/useragent? Since we're heading towards 1.0 where we're unlikely to have a large public API (or any public API at all), I'd like to get in the habit of only exposing what absolutely needs to be made public.
pkg/useragent/useragent.go
Outdated
| metadata = append(metadata, op) | ||
| } | ||
| if len(metadata) > 0 { | ||
| parenthesis = fmt.Sprintf(" (%s)", strings.Join(metadata, ";")) |
There was a problem hiding this comment.
What do you think about using strings.Join(metadata, "; ") here (with the space after the semicolon)? That would help make the metadata slightly more human-readable:
GrafanaAgent/v1.2.3 (static; linux; operator)
vs
GrafanaAgent/v1.2.3 (static;linux;operator)
pkg/useragent/useragent.go
Outdated
| // settable by tests | ||
| var goos = runtime.GOOS | ||
|
|
||
| func UserAgent() string { |
There was a problem hiding this comment.
Calling this Get() might be less repetitive so callers use useragent.Get() instead of useragent.UserAgent()
rfratto
approved these changes
Nov 15, 2023
github-actions
bot
added
the
frozen-due-to-age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
floworstatic)operatorif running in operator generated pod.AGENT_OPERATOR=1to agent pods it creates to facilitate the above.Example User Agents:
GrafanaAgent/v1.2.3 (static; linux; operator)GrafanaAgent/v1.2.3 (flow; windows)GrafanaAgent/v1.2.3 (static; linux)Why?
This will allow database operators (mimir,loki,pyroscope, etc.) to better understand agent traffic patterns sending them data.