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

[OTLP Registry] Exporter missing User-Agent header #5577

Open
joaopgrassi opened this issue Oct 9, 2024 · 2 comments · May be fixed by #5583
Open

[OTLP Registry] Exporter missing User-Agent header #5577

joaopgrassi opened this issue Oct 9, 2024 · 2 comments · May be fixed by #5583
Assignees
@joaopgrassi
Labels
bug A general bug registry: otlp OpenTelemetry Protocol (OTLP) registry-related
Milestone
1.12.x

Comments

@joaopgrassi
Copy link

Please describe the feature request.
The OTel specification defines that OTLP exporters SHOULD emit a User-Agent header identifying the exporter and its version.

https://github.com/open-telemetry/opentelemetry-specification/blob/v1.37.0/specification/protocol/exporter.md#user-agent

OpenTelemetry protocol exporters SHOULD emit a User-Agent header to at a minimum identify the exporter, the language of its implementation, and the version of the exporter. For example, the Python OTLP exporter version 1.2.3 would report the following:

OTel-OTLP-Exporter-Python/1.2.3

Right now, when using the OTLP registry in Micrometer, I get this "default" user agent Java/21.*. It makes it difficult to identify error with requests coming from micrometer apps using the OTLP registry.

Rationale
The exporter should follow the specification and emit the header with a more clear value. For example OTel-OTLP-Exporter-Micrometer/1.2.3
@jonatan-ivanov
Copy link
Member

Thank you for the issue!
If OTel-OTLP-Exporter-Python/1.2.3 represents the "Python OTLP exporter version 1.2.3" (I assume OTel represents the OTel SDK, though the spec does not say it), I think Micrometer should use something like this:

Micrometer-OTLP-Exporter-Java/1.2.3

Are you interested in filing a PR?
We could do something like this:

micrometer/implementations/micrometer-registry-dynatrace/src/main/java/io/micrometer/dynatrace/v2/DynatraceExporterV2.java

Line 425 in 0458fc8

requestBuilder.withHeader("User-Agent", "micrometer")

But we also need to figure out where to get the version number (the manifest should contain it).

@jonatan-ivanov jonatan-ivanov added bug A general bug registry: otlp OpenTelemetry Protocol (OTLP) registry-related and removed waiting-for-triage labels Oct 10, 2024
@jonatan-ivanov jonatan-ivanov added this to the 1.12.x milestone Oct 10, 2024
@joaopgrassi
Copy link
Author

joaopgrassi commented Oct 10, 2024 •
edited
Loading

Yes, I can send a PR for it! Just may need help with the version thing as I'm not that familiar with the codebase and how to get it. Feel free to assign this to me :)

@joaopgrassi joaopgrassi linked a pull request Oct 10, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@joaopgrassi joaopgrassi

Labels
bug A general bug registry: otlp OpenTelemetry Protocol (OTLP) registry-related
Projects
None yet
Milestone
1.12.x
Development

Successfully merging a pull request may close this issue.

Emit user agent header from OTLP registry dynatrace-oss-contrib/micrometer
2 participants
@jonatan-ivanov @joaopgrassi