From 02511507115686e35418d92672b502b8c633c81e Mon Sep 17 00:00:00 2001 From: jack-berg <34418638+jack-berg@users.noreply.github.com> Date: Fri, 13 Jan 2023 14:34:27 -0600 Subject: [PATCH] Mark exponential histogram as stable (#3041) --- CHANGELOG.md | 6 ++++++ spec-compliance-matrix.md | 8 ++++---- specification/metrics/data-model.md | 2 +- specification/metrics/sdk.md | 14 ++++++-------- specification/metrics/sdk_exporters/otlp.md | 18 +++++++----------- 5 files changed, 24 insertions(+), 24 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 14a2b988f83..3dcbcd96ab1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/spec-compliance-matrix.md b/spec-compliance-matrix.md index be6dbfa7968..c3ff23a5570 100644 --- a/spec-compliance-matrix.md +++ b/spec-compliance-matrix.md @@ -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. | | | + | + | + | | | | | + | | | diff --git a/specification/metrics/data-model.md b/specification/metrics/data-model.md index c4ef608741a..1f3f9b8b7f5 100644 --- a/specification/metrics/data-model.md +++ b/specification/metrics/data-model.md @@ -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 diff --git a/specification/metrics/sdk.md b/specification/metrics/sdk.md index dd950fb93d5..f11de6258ea 100644 --- a/specification/metrics/sdk.md +++ b/specification/metrics/sdk.md @@ -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) @@ -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 @@ -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. diff --git a/specification/metrics/sdk_exporters/otlp.md b/specification/metrics/sdk_exporters/otlp.md index 56194214c79..0943b130055 100644 --- a/specification/metrics/sdk_exporters/otlp.md +++ b/specification/metrics/sdk_exporters/otlp.md @@ -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). @@ -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: @@ -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).