-
Notifications
You must be signed in to change notification settings - Fork 975
normalize term for instrumentations #539
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
Changes from 2 commits
72d06d9
1fe9937
8f1ec7e
0cbc553
81f5047
cd52dab
13427cd
b5dab47
fe52785
5e47405
be491d5
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -266,23 +266,26 @@ service). | |
| Read more at OpenTelemetry Service [Long-term | ||
| Vision](https://github.com/open-telemetry/opentelemetry-collector/blob/master/docs/vision.md). | ||
|
|
||
| ## Instrumentation adapters | ||
|
|
||
| The inspiration of the project is to make every library and application | ||
| manageable out of the box by instrumenting it with OpenTelemetry. However on the | ||
| way to this goal there will be a need to enable instrumentation by plugging | ||
| instrumentation adapters into the library of choice. These adapters can be | ||
| wrapping library APIs, subscribing to the library-specific callbacks or | ||
| translating telemetry exposed in other formats into OpenTelemetry model. | ||
|
|
||
| Instrumentation adapters may be called different names. It is often referred as | ||
| plugin, collector or auto-collector, telemetry module, bridge, etc. It is always | ||
| recommended to follow the library and language standards. For instance, if | ||
| instrumentation adapter is implemented as "log appender" - it will probably be | ||
| called an `appender`, not an instrumentation adapter. However if there is no | ||
| established name - the recommendation is to call packages "Instrumentation | ||
| Adapter" or simply "Adapter". | ||
|
|
||
| ## Code injecting adapters | ||
|
|
||
| TODO: fill out as a result of SIG discussion. | ||
| ## Instrumentation Libraries | ||
|
|
||
| See [Instrumentation Library](glossary.md#instrumenting_library) | ||
|
toumorokoshi marked this conversation as resolved.
Outdated
|
||
|
|
||
| A goal of the project is to enable OpenTelemetry instrumentation on every library | ||
| and application out of the box. To achieve that goal, there is a need to author | ||
| instrumentation libraries on these shared libraries and applications. An | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. authoring an instrumentation library is a workaround while we are trying to instrument all libraries natively. This sentence implies opposite
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. sorry, yes, re-reading the statement I see that's what the original text was intending. Will fix. |
||
| instrumentation may wrap library APIs, subscribe to library-specific | ||
| callbacks or translators that convert telemetry exposed in other formats into | ||
| OpenTelemetry models. | ||
|
|
||
| If the library that is being instrumented has a convention around the naming of | ||
|
toumorokoshi marked this conversation as resolved.
Outdated
|
||
| an integration (e.g. 'middleware' for a web framework), the instrumentation should | ||
| have a name that follows the convention of that library. | ||
|
|
||
| If there is no established name, the recommendation is to prefix packages | ||
| with "opentelemetry-instrumentation", followed by the instrumented library name itself. | ||
|
|
||
| Here are some example library names that illustrate the OpenTelemetry | ||
| recommendation: | ||
|
|
||
| * opentelemetry-instrumentation-flask (Python) | ||
| * @opentelemetry/instrumentation-grpc (Javascript) | ||
Uh oh!
There was an error while loading. Please reload this page.