Skip to content
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

Add glossary for typically misused terms #497

Merged
Merged
Show file tree
Hide file tree
Changes from 25 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
93049a3
Add glossary for typically misued terms
z1c0 Feb 26, 2020
44abe83
Update specification/glossary.md
z1c0 Feb 26, 2020
6b885af
Update specification/glossary.md
z1c0 Feb 26, 2020
5fb91df
Address first feedback round
z1c0 Feb 27, 2020
1acecc7
Address more feedback
z1c0 Feb 27, 2020
ec5b3ac
Update specification/glossary.md
z1c0 Feb 27, 2020
b58262f
Remove absolute links and mention of auto-instrumentation
z1c0 Feb 27, 2020
8281599
Merge branch 'glossary' of https://github.com/dynatrace-oss-contrib/o…
z1c0 Feb 27, 2020
55ae9c8
Update specification/glossary.md
z1c0 Feb 28, 2020
3a00b80
Update specification/glossary.md
z1c0 Feb 28, 2020
05b75c2
Update specification/glossary.md
z1c0 Feb 28, 2020
e397b2e
Update specification/glossary.md
z1c0 Feb 28, 2020
3880582
Update specification/glossary.md
z1c0 Feb 28, 2020
347932e
Implement more feedback on PR
z1c0 Feb 28, 2020
7ec9f65
More clarification
z1c0 Feb 28, 2020
5a1cfbb
Merge pull request #10 from dynatrace-oss-contrib/glossary
z1c0 Mar 2, 2020
f0c35c9
Fix markdownlint violation
z1c0 Mar 2, 2020
d065c4e
Merge pull request #12 from dynatrace-oss-contrib/glossary
z1c0 Mar 2, 2020
fbb1730
Merge branch 'master' into glossary-reviewed
z1c0 Mar 2, 2020
a008760
Update specification/glossary.md
z1c0 Mar 3, 2020
8f542de
Update specification/glossary.md
z1c0 Mar 3, 2020
f275c96
Update specification/glossary.md
z1c0 Mar 3, 2020
df9a2b1
Update specification/glossary.md
z1c0 Mar 3, 2020
c750746
Update specification/glossary.md
z1c0 Mar 3, 2020
497de5b
Fix whitespace issues
z1c0 Mar 3, 2020
9b9138a
Update specification/glossary.md
z1c0 Mar 4, 2020
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ The OpenTelemetry specification describes the cross-language requirements and ex
## Table of Contents

- [Overview](specification/overview.md)
- [Glossary](specification/glossary.md)
- [Library Guidelines](specification/library-guidelines.md)
- [Package/Library Layout](specification/library-layout.md)
- [Concurrency and Thread-Safety](specification/concurrency.md)
Expand Down
50 changes: 50 additions & 0 deletions specification/glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Glossary

Below are a list of some OpenTelemetry specific terms that are used across this
specification.

## (Telemetry) Library

Denotes the library that implements the *OpenTelemetry API*.

See [Library resource semantic conventions](data-resource-semantic-conventions.md#library)

<a name="instrumented_library"></a>

## Instrumented Library

Denotes the library for which the telemetry signals (traces, metrics, logs) are gathered.

The calls to the OpenTelemetry API can be done either by the Instrumented Library itself,
or by another [Instrumenting Library](#instrumenting_library).

Example: `org.mongodb.client`.

<a name="instrumenting_library"></a>

## Instrumenting Library

Denotes the library that provides the instrumentation for a given [Instrumented Library](#instrumented_library).
*Instrumented Library* and *Instrumenting Library* may be the same library
if it has built-in OpenTelemetry instrumentation.

Example: `io.opentelemetry.contrib.mongodb`.

Synonyms: *Instrumentation Library*, *Integration*.

<a name="name"></a>

## Tracer Name / Meter Name

This refers to the `name` and (optional) `version` arguments specified when
creating a new `Tracer` or `Meter` (see [Obtaining a Tracer](api-tracing.md#obtaining-a-tracer)/[Obtaining a Meter](api-metrics-user.md#obtaining-a-meter)). It identifies the [Instrumenting Library](#instrumenting_library).

## Namespace

This term applies to [Metric names](api-metrics-user.md#metric-names) only. The namespace is used to disambiguate identical metric
names used in different [instrumenting libraries](#instrumenting_library). The [Name](#name) provided
for creating a `Meter` serves as its namespace in addition to the primary semantics
described [here](#name).

The `version` argument is not relevant here and will not be included in
the resulting namespace string.