Skip to content

Commit

Permalink
Merge branch 'main' into clarify_prometheus_timestamps
Browse files Browse the repository at this point in the history
  • Loading branch information
dashpole authored Mar 15, 2024
2 parents 3f6d17c + 6787e14 commit 8b62bfe
Show file tree
Hide file tree
Showing 10 changed files with 22 additions and 20 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ release.

### Logs

- Refine description of Instrumentation Scope.
([#3855](https://github.com/open-telemetry/opentelemetry-specification/pull/3855))

### Events

### Resource
Expand Down
5 changes: 3 additions & 2 deletions specification/common/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,8 +155,9 @@ at this time, as discussed in

## Attribute Collections

[Resources](../resource/sdk.md), Metrics
[data points](../metrics/data-model.md#metric-points),
[Resources](../resource/sdk.md),
[Instrumentation Scopes](../glossary.md#instrumentation-scope),
[Metric points](../metrics/data-model.md#metric-points),
[Spans](../trace/api.md#set-attributes), Span
[Events](../trace/api.md#add-events), Span
[Links](../trace/api.md#link) and
Expand Down
8 changes: 4 additions & 4 deletions specification/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Some other fundamental terms are documented in the [overview document](overview.
* [Instrumented Library](#instrumented-library)
* [Instrumentation Library](#instrumentation-library)
* [Instrumentation Scope](#instrumentation-scope)
* [Tracer Name / Meter Name](#tracer-name--meter-name)
* [Tracer Name / Meter Name / Logger Name](#tracer-name--meter-name--logger-name)
* [Execution Unit](#execution-unit)
- [Logs](#logs)
* [Log Record](#log-record)
Expand Down Expand Up @@ -169,19 +169,19 @@ 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 or Meter](#tracer-name--meter-name).
[Tracer, Meter, or Logger](#tracer-name--meter-name--logger-name).

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
repository URL the library's source code is stored. Since the scope is a build-time
concept the attributes of the scope cannot change at runtime.

### Tracer Name / Meter Name
### Tracer Name / Meter Name / Logger Name

This refers to the `name` and (optional) `version` arguments specified when
creating a new `Tracer` or `Meter` (see
[Obtaining a Tracer](trace/api.md#tracerprovider)/[Obtaining a Meter](metrics/api.md#meterprovider)).
[Obtaining a Tracer](trace/api.md#tracerprovider)/[Obtaining a Meter](metrics/api.md#meterprovider))/[Obtaining a Logger](logs/bridge-api.md#loggerprovider).
The name/version pair identifies the
[Instrumentation Scope](#instrumentation-scope), for example the
[Instrumentation Library](#instrumentation-library) or another unit of
Expand Down
6 changes: 5 additions & 1 deletion specification/logs/bridge-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@ The `LoggerProvider` MUST provide the following functions:

#### Get a Logger

This API MUST accept the following parameters:
This API MUST accept the following [instrumentation scope](data-model.md#field-instrumentationscope)
parameters:

* `name`: This name uniquely identifies the [instrumentation scope](../glossary.md#instrumentation-scope),
such as the [instrumentation library](../glossary.md#instrumentation-library)
Expand All @@ -68,6 +69,9 @@ This API MUST accept the following parameters:
[Instrumentation library](../glossary.md#instrumentation-library) may refer to
the same library. In that scenario, the `name` denotes a module name or component
name within that library or application.
For log sources which define a logger name (e.g. Java
[Logger Name](https://docs.oracle.com/javase/7/docs/api/java/util/logging/Logger.html#getLogger(java.lang.String)))
the Logger Name should be recorded as the instrumentation scope name.

* `version` (optional): Specifies the version of the instrumentation scope if
the scope has a version (e.g. a library version). Example value: 1.0.0.
Expand Down
10 changes: 2 additions & 8 deletions specification/logs/data-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -430,17 +430,11 @@ This field is optional.

### Field: `InstrumentationScope`

Type: (Name,Version) tuple of strings.
Type: [Instrumentation Scope](../glossary.md#instrumentation-scope).

Description: the [instrumentation scope](../glossary.md#instrumentation-scope).
Multiple occurrences of events coming from the same scope can happen across time and
they all have the same value of `InstrumentationScope`. For log sources which define
a logger name (e.g. Java
[Logger Name](https://docs.oracle.com/javase/7/docs/api/java/util/logging/Logger.html#getLogger(java.lang.String)))
the Logger Name SHOULD be recorded as the Instrumentation Scope name.

Version is optional. Name SHOULD be specified if version is specified, otherwise Name
is optional.
they all have the same value of `InstrumentationScope`. This field is optional.

### Field: `Attributes`

Expand Down
2 changes: 1 addition & 1 deletion specification/metrics/sdk_exporters/in-memory.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
linkTitle: In-memory
--->

# OpenTelemetry Metrics Exporter - In-memory
# Metrics Exporter - In-memory

**Status**: [Stable](../../document-status.md)

Expand Down
2 changes: 1 addition & 1 deletion specification/metrics/sdk_exporters/otlp.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
linkTitle: OTLP
--->

# OpenTelemetry Metrics Exporter - OTLP
# Metrics Exporter - OTLP

**Status**: [Stable](../../document-status.md)

Expand Down
2 changes: 1 addition & 1 deletion specification/metrics/sdk_exporters/prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
linkTitle: Prometheus
--->

# OpenTelemetry Metrics Exporter - Prometheus
# Metrics Exporter - Prometheus

**Status**: [Experimental](../../document-status.md)

Expand Down
2 changes: 1 addition & 1 deletion specification/metrics/sdk_exporters/stdout.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
linkTitle: Stdout
--->

# OpenTelemetry Metrics Exporter - Standard output
# Metrics Exporter - Standard output

**Status**: [Stable](../../document-status.md)

Expand Down
2 changes: 1 addition & 1 deletion specification/trace/sdk_exporters/stdout.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
linkTitle: Stdout
--->

# OpenTelemetry Span Exporter - Standard output
# Span Exporter - Standard output

**Status**: [Stable](../../document-status.md)

Expand Down

0 comments on commit 8b62bfe

Please sign in to comment.