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

Add guidelines on User-Agent header content #24

Open
MrAlias opened this issue Dec 26, 2019 · 1 comment
Open

Add guidelines on User-Agent header content #24

MrAlias opened this issue Dec 26, 2019 · 1 comment
Assignees

Comments

@MrAlias
Copy link
Contributor

MrAlias commented Dec 26, 2019

The New Relic SDK specification defines functionality to append field-values to the User-Agent header. Exporters need to use this functionality to include information about what systems they are instrumenting. This is critical to ensuring analytics about data sources are possible.

The specification should have a section providing guidelines about how this field is formed and what valid values include. At a minimum values need to conform to the product definitions defined in RFC 7231 Section 5.5.3. Additionally, values should likely be required to include information about the instrumented systems in some encouraged format.

@MrAlias MrAlias self-assigned this Dec 26, 2019
@MrAlias
Copy link
Contributor Author

MrAlias commented Dec 26, 2019

Initial thoughts on what the guidelines should be changed to include:

  • SHOULD append a product identifier for the instrumented system. (going with SHOULD here to allow for the end user to deliberately override the decision).
  • MUST use the functionality offered by the SDK to append the User-Agent header. (don’t want the exporter overriding the SDK portion of the header).
  • MUST append a valid value as defined by a product in RFC 7231 Section 5.5.5
  • SHOULD include the name of the instrumented system.
  • Then product name SHOULD remain as stable a value as possible.
  • SHOULD include the version of the instrumented system if one is known.

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

No branches or pull requests

1 participant