Skip to content

Commit 237ab5f

Browse files
MrAliasarminru
andauthored
Fix instrumentation library synonym (#612)
* Fix instrumentation library synonym Address issue not resolved in #539: https://github.com/open-telemetry/opentelemetry-specification/pull/539/files#r426546780 * Link to definition in api.md * Link to definition from glossary.md Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>
1 parent f9aabe2 commit 237ab5f

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

specification/glossary.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,11 @@ Denotes the library that provides the instrumentation for a given [Instrumented
3131
*Instrumented Library* and *Instrumentation Library* may be the same library
3232
if it has built-in OpenTelemetry instrumentation.
3333

34+
See [Overview](overview.md#instrumentation-libraries) for a more detailed definition and naming guidelines.
35+
3436
Example: `io.opentelemetry.contrib.mongodb`.
3537

36-
Synonyms: *Instrumentation Library*
38+
Synonyms: *Instrumenting Library*
3739

3840
<a name="name"></a>
3941

specification/trace/api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ Some applications may use multiple `TracerProvider` instances, e.g. to provide
8888
different settings (e.g. `SpanProcessor`s) to each of those instances and -
8989
in further consequence - to the `Tracer` instances created by them.
9090

91-
- `name` (required): This name must identify the instrumentation library (e.g. `io.opentelemetry.contrib.mongodb`) and *not*
92-
the instrumented library.
91+
- `name` (required): This name must identify the [instrumentation library](../overview.md#instrumentation-libraries)
92+
(e.g. `io.opentelemetry.contrib.mongodb`) and *not* the instrumented library.
9393
In case an invalid name (null or empty string) is specified, a working
9494
default Tracer implementation as a fallback is returned rather than returning
9595
null or throwing an exception.

0 commit comments

Comments
 (0)