Skip to content

Mark base-2 exponential histogram as stable #3041

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

Merged
merged 11 commits into from
Jan 13, 2023
Merged

Mark base-2 exponential histogram as stable #3041

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
cf6c6ac
Mark exponential histogram as stable
jack-berg Dec 15, 2022
9a4fc39
Add changelog entry
jack-berg Dec 15, 2022
8cd533a
Merge branch 'main' into stabilize-exponential-histogram
jack-berg Jan 4, 2023
7dae520
Merge branch 'main' of https://github.com/open-telemetry/opentelemetr…
jack-berg Jan 10, 2023
c10df40
SDKs should support exponential histogram
jack-berg Jan 10, 2023
f4b19f0
Merge branch 'main' into stabilize-exponential-histogram
reyang Jan 10, 2023
4755c90
Rename to base 2 exponential bucket histogram aggregation
jack-berg Jan 11, 2023
6cc0b1e
Merge branch 'stabilize-exponential-histogram' of https://github.com/…
jack-berg Jan 11, 2023
77a30fa
Fix typo in changelog
jack-berg Jan 13, 2023
48ff37c
Merge branch 'main' into stabilize-exponential-histogram
jack-berg Jan 13, 2023
78315eb
Merge branch 'main' into stabilize-exponential-histogram
reyang Jan 13, 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
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ release.
([#2919](https://github.com/open-telemetry/opentelemetry-specification/pull/2919))
- Add `MaxScale` config option to Exponential Bucket Histogram Aggregation.
([#3017](https://github.com/open-telemetry/opentelemetry-specification/pull/3017))
- Rename exponential bucket histogram aggregation to base 2 exponential histogram
aggregation. Rename "OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION"
value from "exponential_bucket_histogram" to
"base2_exponential_bucket_histogram". Mark exponential histogram data model and
base2 exponential histogram aggregation as stable.
([#3041](https://github.com/open-telemetry/opentelemetry-specification/pull/3041))

### Logs

Expand Down
8 changes: 4 additions & 4 deletions spec-compliance-matrix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,10 +177,10 @@ formats is required. Implementing more than one format is optional.
| The `Sum` aggregation performs as specified. | | + | + | + | + | | | + | | + | + | |
| The `LastValue` aggregation is available. | | + | + | + | + | | | + | | + | + | |
| The `LastValue` aggregation performs as specified. | | + | + | + | + | | | + | | + | + | |
| The `Histogram` aggregation is available. | | + | + | + | + | | | | | + | + | |
| The `Histogram` aggregation performs as specified. | | + | + | | + | | | | | + | + | |
| The explicit bucket `Histogram` aggregation is available. | | - | + | + | + | | | + | | + | + | |
| The explicit bucket `Histogram` aggregation performs as specified. | | - | + | + | + | | | + | | + | + | |
| The `ExplicitBucketHistogram` aggregation is available. | | - | + | + | + | | | + | | + | + | |
| The `ExplicitBucketHistogram` aggregation performs as specified. | | - | + | + | + | | | + | | + | + | |
| The `ExponentialBucketHistogram` aggregation is available. | | | | | | | | | | | | |
| The `ExponentialBucketHistogram` aggregation performs as specified. | | | | | | | | | | | | |
| The metrics Reader implementation supports registering metric Exporters | | | + | + | + | | | + | | + | + | |
| The metrics Reader implementation supports configuring the default aggregation on the basis of instrument kind. | | | + | | + | | | | | - | - | |
| The metrics Reader implementation supports configuring the default temporality on the basis of instrument kind. | | | + | + | + | | | | | + | | |
Expand Down
2 changes: 1 addition & 1 deletion specification/metrics/data-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,7 +519,7 @@ so that worst-case error is within their error tolerance.

### ExponentialHistogram

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

[ExponentialHistogram](https://github.com/open-telemetry/opentelemetry-proto/blob/cfbf9357c03bf4ac150a3ab3bcbe4cc4ed087362/opentelemetry/proto/metrics/v1/metrics.proto#L222)
data points are an alternate representation to the
Expand Down
14 changes: 6 additions & 8 deletions specification/metrics/sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ linkTitle: SDK
+ [Last Value Aggregation](#last-value-aggregation)
+ [Histogram Aggregations](#histogram-aggregations)
- [Explicit Bucket Histogram Aggregation](#explicit-bucket-histogram-aggregation)
- [Exponential Bucket Histogram Aggregation](#exponential-bucket-histogram-aggregation)
- [Base2 Exponential Bucket Histogram Aggregation](#base2-exponential-bucket-histogram-aggregation)
* [Handle all normal values](#handle-all-normal-values)
* [Support a minimum and maximum scale](#support-a-minimum-and-maximum-scale)
* [Use the maximum scale for single measurements](#use-the-maximum-scale-for-single-measurements)
Expand Down Expand Up @@ -357,9 +357,9 @@ The SDK MUST provide the following `Aggregation` to support the
- [Last Value](./sdk.md#last-value-aggregation)
- [Explicit Bucket Histogram](./sdk.md#explicit-bucket-histogram-aggregation)

The SDK MAY provide the following `Aggregation`:
The SDK SHOULD provide the following `Aggregation`:

- [Exponential Bucket Histogram Aggregation](./sdk.md#exponential-bucket-histogram-aggregation)
- [Base2 Exponential Bucket Histogram](./sdk.md#base2-exponential-bucket-histogram-aggregation)

#### Drop Aggregation

Expand Down Expand Up @@ -448,13 +448,11 @@ bound (except at positive infinity). A measurement is defined to fall
into the greatest-numbered bucket with boundary that is greater than
or equal to the measurement.

##### Exponential Bucket Histogram Aggregation
##### Base2 Exponential Bucket Histogram Aggregation

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

The Exponential Histogram Aggregation informs the SDK to collect data
The Base2 Exponential Histogram Aggregation informs the SDK to collect data
for the [Exponential Histogram Metric
Point](./data-model.md#exponentialhistogram), which uses an exponential
Point](./data-model.md#exponentialhistogram), which uses a base-2 exponential
formula to determine bucket boundaries and an integer `scale`
parameter to control resolution. Implementations adjust scale as necessary given
the data.
Expand Down
18 changes: 7 additions & 11 deletions specification/metrics/sdk_exporters/otlp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,10 @@ linkTitle: OTLP

# OpenTelemetry Metrics Exporter - OTLP

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

## General

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

OTLP Metrics Exporter is a [Push Metric
Exporter](../sdk.md#push-metric-exporter) which sends metrics via the
[OpenTelemetry Protocol](../../protocol/README.md).
Expand Down Expand Up @@ -37,12 +35,10 @@ then by default:

## Additional Configuration

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

| Name | Status | Description | Default |
|-----------------------------------------------------|--------------|---------------------------------------------------------------------|-----------------------------|
| `OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE` | Stable | The aggregation temporality to use on the basis of instrument kind. | `cumulative` |
| `OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION` | Experimental | The default aggregation to use for histogram instruments. | `explicit_bucket_histogram` |
| Name | Description | Default |
|------------------------------------------------------------|---------------------------------------------------------------------|-----------------------------|
| `OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE` | The aggregation temporality to use on the basis of instrument kind. | `cumulative` |
| `OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION` | The default aggregation to use for histogram instruments. | `explicit_bucket_histogram` |

The recognized (case-insensitive) values for `OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE` are:

Expand All @@ -62,5 +58,5 @@ The recognized (case-insensitive) values for `OTEL_EXPORTER_OTLP_METRICS_DEFAULT

* `explicit_bucket_histogram`:
Use [Explicit Bucket Histogram Aggregation](../sdk.md#explicit-bucket-histogram-aggregation).
* `exponential_bucket_histogram`:
Use [Exponential Bucket Histogram Aggregation](../sdk.md#exponential-bucket-histogram-aggregation).
* `base2_exponential_bucket_histogram`:
Use [Base2 Exponential Bucket Histogram Aggregation](../sdk.md#base2-exponential-bucket-histogram-aggregation).