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.

Sign up for GitHub

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

Jump to bottom

Add specification for exporter user-agent names. #22

Merged
merged 2 commits into from
Nov 26, 2019
Merged

Add specification for exporter user-agent names. #22

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d15407
Add specification for exporter user-agent names.
a-feld Nov 26, 2019
cc99ebc
Clarify that user-agent values described are appended.
a-feld Nov 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions Common.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Common Exporter Behavior

This document describes behavior that is common to all New Relic exporters.

# User-Agent values

Each exporter **MUST** report an identifying string and version as part of the `User-Agent` header when sending data to New Relic.

These values should be appended using the [add_version_info API](https://github.com/newrelic/newrelic-telemetry-sdk-specs/blob/be844b5ca5044c0f80b037812de7498b3663ae34/communication.md#user-agent) described in the telemetry SDK specification.

The `User-Agent` values that are appended are always in the format `<author>-<language>-<exporter_name>`. For New Relic exporters, the author is `NewRelic`.

Language names are title cased.

| Exporter | exporter_name | Example Value Appended to the User-Agent |
| -------- | ------------- | ------------------ |
| [opencensus](opencensus) | `OpenCensus` | `NewRelic-Python-OpenCensus/0.1.0` |
| [micrometer](micrometer) | `Micrometer` | `NewRelic-Java-Micrometer/0.1.0` |
| [kamon](kamon) | `Kamon` | `NewRelic-Java-Kamon/0.1.0` |
| [dropwizard](dropwizard) | `DropWizard` | `NewRelic-Java-DropWizard/0.1.0` |

A full `User-Agent` example might look like `NewRelic-Python-TelemetrySDK/0.2.3 NewRelic-Python-OpenCensus/0.1.0`.