Skip to content

Commit e5b37e1

Browse files
authored
Update Instrumentation Scope glossary entry with correct identifying fields (#4244)
Small follow up to #4161 ## Changes Updates the glossary to indicate that instrumentation scope's schema url and attributes are also identifying. I simplified the language a bit. * [x] Related issues #4160
1 parent b9d347a commit e5b37e1

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ release.
5656

5757
- Define equality for attributes and collection of attributes.
5858
([#4161](https://github.com/open-telemetry/opentelemetry-specification/pull/4161))
59+
- Update Instrumentation Scope glossary entry with correct identifying fields
60+
([#4244](https://github.com/open-telemetry/opentelemetry-specification/pull/4244))
5961

6062
### Supplementary Guidelines
6163

specification/glossary.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -172,16 +172,20 @@ reasonable instrumentation scope. The most common approach is to use the
172172
scopes are also common, e.g. a module, a package, or a class can be chosen as
173173
the instrumentation scope.
174174

175-
If the unit of code has a version then the instrumentation scope is defined by
176-
the (name,version) pair otherwise the version is omitted and only the name is
177-
used. The name or (name,version) pair uniquely identify the logical unit of the
178-
code that emits the telemetry. A typical approach to ensure uniqueness is to use
179-
fully qualified name of the emitting code (e.g. fully qualified library name or
180-
fully qualified class name).
175+
The instrumentation scope is defined by the
176+
(name,version,schema_url,attributes) tuple where version, schema_url, and
177+
attributes are optional. This tuple uniquely identifies the logical unit of the
178+
code that emits the telemetry. A typical approach to ensure uniqueness is to
179+
use the fully qualified name of the emitting code (e.g. fully qualified library
180+
name or fully qualified class name).
181181

182182
The instrumentation scope is used to obtain a
183183
[Tracer, Meter, or Logger](#tracer-name--meter-name--logger-name).
184184

185+
The instrumentation scope's optional Schema URL identifies the [Telemetry
186+
Schema](schemas/README.md) that the instrumentation's emitted
187+
telemetry conforms to.
188+
185189
The instrumentation scope may have zero or more additional attributes that provide
186190
additional information about the scope. For example for a scope that specifies an
187191
instrumentation library an additional attribute may be recorded to denote the URL of the

0 commit comments

Comments
 (0)