Skip to content

Update instrumentation library naming guidance to avoid conflicts between external and otel instrumentations #4187

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

Merged
merged 5 commits into from
Aug 28, 2024
Merged

Update instrumentation library naming guidance to avoid conflicts between external and otel instrumentations #4187

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
eb36e1f
Update instrumentation library naming guidance to avoid conflicts wit…
Aug 16, 2024
d42770b
up
Aug 16, 2024
5a2b6e8
changelog
Aug 16, 2024
f6b6cbb
authored -> hosted by
Aug 16, 2024
3fd2dfe
Merge branch 'main' into udpate-inst-package-naming-guidance
arminru Aug 20, 2024
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
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ release.

### Common

- Update instrumentation library guidance to avoid naming collisions between external and OTel instrumentations.
([#4187](https://github.com/open-telemetry/opentelemetry-specification/pull/4187))

### Supplementary Guidelines

## v1.36.0 (2024-08-12)
Expand Down
9 changes: 8 additions & 1 deletion specification/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,9 +384,16 @@ an [Instrumentation Library](glossary.md#instrumentation-library).
An instrumentation library should be named to follow any naming conventions of
the instrumented library (e.g. 'middleware' for a web framework).

If there is no established name, the recommendation is to prefix packages
For OpenTelemetry-authored instrumentations, the recommendation is to prefix packages
with "opentelemetry-instrumentation", followed by the instrumented library
name itself. Examples include:

* opentelemetry-instrumentation-flask (Python)
* @opentelemetry/instrumentation-grpc (Javascript)

Instrumentations libraries not authored by OpenTelemetry should avoid potential naming collisions with
OpenTelemetry-authored instrumentations. For example, they may prefix instrumentation package name with
their company or project name:

* {company}-opentelemetry-instrumentation-{component} (Python)
* @{company}/opentelemetry-instrumentation-{component} (Javascript)