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.

Sign up for GitHub

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

Jump to bottom

Refine trace and logs SDK configuration sections #3559

Merged
merged 3 commits into from
Jul 6, 2023
Merged

Refine trace and logs SDK configuration sections #3559

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c678094
Refine trace and logs SDK configuration sections
pellared Jun 20, 2023
4f6a39b
Update CHANGELOG.md
pellared Jun 28, 2023
426481e
Merge branch 'main' into refine-sdk-docs
carlosalberto Jul 6, 2023
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ release.

### Traces

- Refine SDK TracerProvider configuration section.
([#3559](https://github.com/open-telemetry/opentelemetry-specification/pull/3559))
- Make SDK Tracer Creation more normative.
([#3529](https://github.com/open-telemetry/opentelemetry-specification/pull/3529))

Expand All @@ -27,6 +29,8 @@ release.

### Logs

- Refine SDK LoggerProvider configuration section.
([#3559](https://github.com/open-telemetry/opentelemetry-specification/pull/3559))
- Make SDK Logger Creation more normative.
([#3529](https://github.com/open-telemetry/opentelemetry-specification/pull/3529))

Expand Down
10 changes: 6 additions & 4 deletions specification/logs/sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
- [LoggerProvider](#loggerprovider)
* [LoggerProvider Creation](#loggerprovider-creation)
* [Logger Creation](#logger-creation)
* [Configuration](#configuration)
* [Shutdown](#shutdown)
* [ForceFlush](#forceflush)
- [Logger](#logger)
Expand Down Expand Up @@ -68,10 +69,11 @@ working `Logger` MUST be returned as a fallback rather than returning null or
throwing an exception, its `name` SHOULD keep the original invalid value, and a
message reporting that the specified value is invalid SHOULD be logged.

Configuration (i.e. [LogRecordProcessors](#logrecordprocessor)) MUST be managed
solely by the `LoggerProvider` and the SDK MUST provide some way to configure
all options that are implemented by the SDK. This MAY be done at the time
of `LoggerProvider` creation if appropriate.
### Configuration

Configuration (i.e. [LogRecordProcessors](#logrecordprocessor)) MUST be owned
by the the `LoggerProvider`. The configuration MAY be applied at the time of
`LoggerProvider` creation if appropriate.

The `LoggerProvider` MAY provide methods to update the configuration. If
configuration is updated (e.g., adding a `LogRecordProcessor`), the updated
Expand Down
12 changes: 6 additions & 6 deletions specification/trace/sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ linkTitle: SDK

- [Tracer Provider](#tracer-provider)
* [Tracer Creation](#tracer-creation)
* [Configuration](#configuration)
* [Shutdown](#shutdown)
* [ForceFlush](#forceflush)
- [Additional Span Interfaces](#additional-span-interfaces)
Expand All @@ -29,7 +30,6 @@ linkTitle: SDK
- [Requirements for `TraceIdRatioBased` sampler algorithm](#requirements-for-traceidratiobased-sampler-algorithm)
+ [ParentBased](#parentbased)
+ [JaegerRemoteSampler](#jaegerremotesampler)
- [Configuration](#configuration)
- [Span Limits](#span-limits)
- [Id Generators](#id-generators)
- [Span processor](#span-processor)
Expand Down Expand Up @@ -68,10 +68,12 @@ The input provided by the user MUST be used to create
an [`InstrumentationScope`](../glossary.md#instrumentation-scope) instance which
is stored on the created `Tracer`.

### Configuration

Configuration (i.e., [SpanProcessors](#span-processor), [IdGenerator](#id-generators),
[SpanLimits](#span-limits) and [`Sampler`](#sampling)) MUST be managed solely by
the `TracerProvider` and it MUST provide some way to configure all of them that
are implemented in the SDK, at least when creating or initializing it.
[SpanLimits](#span-limits) and [`Sampler`](#sampling)) MUST be owned by the
the `TracerProvider`. The configuration MAY be applied at the time of `TracerProvider`
creation if appropriate.

The TracerProvider MAY provide methods to update the configuration. If
configuration is updated (e.g., adding a `SpanProcessor`),
Expand Down Expand Up @@ -380,8 +382,6 @@ Optional parameters:

The full Protobuf definition can be found at [jaegertracing/jaeger-idl/api_v2/sampling.proto](https://github.com/jaegertracing/jaeger-idl/blob/main/proto/api_v2/sampling.proto).

##### Configuration

The following configuration properties should be available when creating the sampler:

* endpoint - address of a service that implements the [Remote Sampling API][jaeger-remote-sampling-api], such as Jaeger Collector or OpenTelemetry Collector.
Expand Down