Skip to content

Commit

Permalink
Update env variable values to match other env variables. (#1965)
Browse files Browse the repository at this point in the history
* Update env variable values to match other env variables in the specification.
  • Loading branch information
jsuereth authored Sep 28, 2021
1 parent 96ac1fa commit 613bf2c
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 12 deletions.
13 changes: 1 addition & 12 deletions specification/metrics/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -754,15 +754,4 @@ modeled to interact with other components in the SDK:

## Defaults and Configuration

The SDK MUST provide the following configuration parameters for Exemplar
sampling:

| Name | Description | Default | Notes |
|-----------------|---------|-------------|---------|
| `OTEL_METRICS_EXEMPLAR_FILTER` | Filter for which measurements can become Exemplars. | `"WITH_SAMPLED_TRACE"` | |

Known values for `OTEL_METRICS_EXEMPLAR_FILTER` are:

- `"NONE"`: No measurements are eligble for exemplar sampling.
- `"ALL"`: All measurements are eligible for exemplar sampling.
- `"WITH_SAMPLED_TRACE"`: Only allow measurements with a sampled parent span in context.
The SDK MUST provide configuration according to the [SDK environment variables](../sdk-environment-variables.md) specification.
14 changes: 14 additions & 0 deletions specification/sdk-environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,20 @@ Known values for OTEL_METRICS_EXPORTER are:
- `"prometheus"`: [Prometheus](https://github.com/prometheus/docs/blob/master/content/docs/instrumenting/exposition_formats.md)
- `"none"`: No automatically configured exporter for metrics.

## Metrics SDK Configuration

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

| Name | Description | Default | Notes |
|-----------------|---------|-------------|---------|
| `OTEL_METRICS_EXEMPLAR_FILTER` | Filter for which measurements can become Exemplars. | `"with_sampled_trace"` | |

Known values for `OTEL_METRICS_EXEMPLAR_FILTER` are:

- `"none"`: No measurements are eligble for exemplar sampling.
- `"all"`: All measurements are eligible for exemplar sampling.
- `"with_sampled_trace"`: Only allow measurements with a sampled parent span in context.

## Language Specific Environment Variables

To ensure consistent naming across projects, this specification recommends that language specific environment variables are formed using the following convention:
Expand Down

0 comments on commit 613bf2c

Please sign in to comment.