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

Semantic convention for name and version of the instrumented library #1229

Open
arminru opened this issue Sep 15, 2021 · 1 comment
Open

Comments

@arminru
Copy link
Member

arminru commented Sep 15, 2021

In open-telemetry/opentelemetry-specification#1904 the span attribute messaging.rocketmq.version was proposed to report the version of the RocketMQ client library being used for producing or consuming a message.
Would it make sense to have generic attributes for the name and version of the instrumented library instead?

The instrumentation library is already reported via the tracer or meter name. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/overview.md#instrumentation-libraries and https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#instrumentation-library for definitions and details.

If the instrumented library comes with instrumentation built-in, the instrumentation library will already match what we are looking for here.
If instrumentation is provided by a separate instrumentation library, however, we have no information about the library being used.

Most applications will be composed of multiple libraries but usually there should be a clear "top of stack" library that is the most relevant for a particular span, that would be the one to report here.
An alternative would be to just report all detected libraries as resource attributes but this will likely not be suitable for all languages and also multiple languages could be candidates to be "responsible" for a certain span, so a span attribute would likely make more sense.

@tigrannajaryan
Copy link
Member

@arminru do you mind if I assign this to you since you already looked into it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants