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

Add OTEL_SDK_DISABLED env var to disable opentelemetry SDK. #2679

Merged
merged 19 commits into from
Sep 22, 2022
Merged

Add OTEL_SDK_DISABLED env var to disable opentelemetry SDK. #2679

Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
27e70e4
Add OTEL_SDK_ENABLED environment property
brunobat Jul 21, 2022
a616f7f
Add OTEL_SDK_ENABLED environment property
brunobat Jul 25, 2022
a8c68c5
Add OTEL_SDK_ENABLED environment property
brunobat Jul 25, 2022
10a7f23
add blank
brunobat Jul 25, 2022
c15dce2
Merge branch 'main' into main
brunobat Jul 26, 2022
c6750de
Add OTEL_SDK_ENABLED environment property
brunobat Jul 21, 2022
e7cb7bb
Add OTEL_SDK_ENABLED environment property
brunobat Jul 25, 2022
a3305d2
Add OTEL_SDK_ENABLED environment property
brunobat Jul 25, 2022
0ff45a5
Address review comments
brunobat Aug 8, 2022
9fc25a9
Address review comments
brunobat Aug 9, 2022
2a8144b
Address review comments
brunobat Aug 9, 2022
840d2a1
Include Boolean value on the SDK
brunobat Aug 11, 2022
afaaee4
Include Boolean value on the SDK
brunobat Aug 11, 2022
7f1ca71
OTEL_SDK_DISABLED default to false
brunobat Aug 16, 2022
d5f97b3
Merge remote-tracking branch 'upstream/main'
brunobat Aug 16, 2022
6de1539
OTEL_SDK_DISABLED default to false and spinoff Boolean definition to …
brunobat Aug 16, 2022
d95b82d
Update CHANGELOG.md
jmacd Aug 17, 2022
fe62e3d
Merge branch 'main' into main
carlosalberto Aug 25, 2022
d54cc69
Merge branch 'main' into main
reyang Sep 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,9 @@ release.

### SDK Configuration

- Add the OTEL_SDK_DISABLED environment variable to the SDK configuration.
([2679](https://github.com/open-telemetry/opentelemetry-specification/pull/2679))

- Mark `OTEL_METRIC_EXPORT_INTERVAL`, `OTEL_METRIC_EXPORT_TIMEOUT`
environment variables as Stable
([#2658](https://github.com/open-telemetry/opentelemetry-specification/pull/2658))
Expand Down
3 changes: 2 additions & 1 deletion spec-compliance-matrix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,8 @@ Disclaimer: this list of features is still a work in progress, please refer to t
Note: Support for environment variables is optional.

|Feature |Go | Java |JS |Python|Ruby|Erlang|PHP|Rust|C++|.NET|Swift|
|--------------------------------------------------|---|------|---|------|----|------|---|----|---|----|-----|
|--------------------------------------------------|--|------|---|------|----|------|---|----|---|----|-----|
|OTEL_SDK_DISABLED | - | - | - | - | - | - | - | - | - | - | - |
|OTEL_RESOURCE_ATTRIBUTES | + | + | + | + | + | + | + | + | + | + | - |
|OTEL_SERVICE_NAME | + | + | + | + | + | + | + | | | + | |
|OTEL_LOG_LEVEL | - | - | + | [-][py1059] | + | - | - | | - | - | - |
Expand Down
3 changes: 2 additions & 1 deletion specification/sdk-environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,13 @@ For example, the value `12000` indicates 12000 milliseconds, i.e., 12 seconds.

| Name | Description | Default | Notes |
| ------------------------ | ------------------------------------------------- | --------------------------------- | ----------------------------------- |
| OTEL_SDK_DISABLED | Disable the SDK for all signals | false | Boolean value. If "true", a no-op SDK implementation will be used for all telemetry signals. Any other value or absence of the variable will have no effect and the SDK will remain enabled. This setting has no effect on propagators configured through the OTEL_PROPAGATORS variable.|
reyang marked this conversation as resolved.
Show resolved Hide resolved
| OTEL_RESOURCE_ATTRIBUTES | Key-value pairs to be used as resource attributes | See [Resource semantic conventions](resource/semantic_conventions/README.md#semantic-attributes-with-sdk-provided-default-value) for details. | See [Resource SDK](./resource/sdk.md#specifying-resource-information-via-an-environment-variable) for more details. |
| OTEL_SERVICE_NAME | Sets the value of the [`service.name`](./resource/semantic_conventions/README.md#service) resource attribute | | If `service.name` is also provided in `OTEL_RESOURCE_ATTRIBUTES`, then `OTEL_SERVICE_NAME` takes precedence. |
| OTEL_LOG_LEVEL | Log level used by the SDK logger | "info" | |
| OTEL_PROPAGATORS | Propagators to be used as a comma-separated list | "tracecontext,baggage" | Values MUST be deduplicated in order to register a `Propagator` only once. |
| OTEL_TRACES_SAMPLER | Sampler to be used for traces | "parentbased_always_on" | See [Sampling](./trace/sdk.md#sampling) |
| OTEL_TRACES_SAMPLER_ARG | String value to be used as the sampler argument | | The specified value will only be used if OTEL_TRACES_SAMPLER is set. Each Sampler type defines its own expected input, if any. Invalid or unrecognized input MUST be logged and MUST be otherwise ignored, i.e. the SDK MUST behave as if OTEL_TRACES_SAMPLER_ARG is not set. |
| OTEL_TRACES_SAMPLER_ARG | String value to be used as the sampler argument | | The specified value will only be used if OTEL_TRACES_SAMPLER is set. Each Sampler type defines its own expected input, if any. Invalid or unrecognized input MUST be logged and MUST be otherwise ignored, i.e. the SDK MUST behave as if OTEL_TRACES_SAMPLER_ARG is not set. |

Known values for `OTEL_PROPAGATORS` are:

Expand Down