Skip to content

Commit

Permalink
Update Instrumentation Scope glossary entry with correct identifying …
Browse files Browse the repository at this point in the history
…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
  • Loading branch information
aabmass authored Oct 9, 2024
1 parent b9d347a commit e5b37e1
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ release.

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

### Supplementary Guidelines

Expand Down
16 changes: 10 additions & 6 deletions specification/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,16 +172,20 @@ reasonable instrumentation scope. The most common approach is to use the
scopes are also common, e.g. a module, a package, or a class can be chosen as
the instrumentation scope.

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

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

The instrumentation scope's optional Schema URL identifies the [Telemetry
Schema](schemas/README.md) that the instrumentation's emitted
telemetry conforms to.

The instrumentation scope may have zero or more additional attributes that provide
additional information about the scope. For example for a scope that specifies an
instrumentation library an additional attribute may be recorded to denote the URL of the
Expand Down

0 comments on commit e5b37e1

Please sign in to comment.