From 86ed587c08d47b06a2c60044a4939ab18a419cb2 Mon Sep 17 00:00:00 2001 From: Alan West <3676547+alanwest@users.noreply.github.com> Date: Mon, 14 Mar 2022 16:22:00 -0700 Subject: [PATCH 1/4] Specify MetricReader config defaults for stdout/in-memory MetricExporters --- CHANGELOG.md | 3 +++ specification/metrics/sdk_exporters/in-memory.md | 5 ++++- specification/metrics/sdk_exporters/stdout.md | 4 +++- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e7e897393fa..56288176ea4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -33,6 +33,9 @@ release. ([#2379](/~https://github.com/open-telemetry/opentelemetry-specification/pull/2379)). - Clarify that MetricReader has one-to-one mapping to MeterProvider. ([#2406](/~https://github.com/open-telemetry/opentelemetry-specification/pull/2406)). +- Specify default configuration for a periodic metric reader that is associated with + the stdout and in-memory metric exporters. + ([#TBD](/~https://github.com/open-telemetry/opentelemetry-specification/pull/TBD)). ### Logs diff --git a/specification/metrics/sdk_exporters/in-memory.md b/specification/metrics/sdk_exporters/in-memory.md index f430429a48a..44147df0b8b 100644 --- a/specification/metrics/sdk_exporters/in-memory.md +++ b/specification/metrics/sdk_exporters/in-memory.md @@ -11,7 +11,10 @@ If a language provides a mechanism to automatically configure a the [`OTEL_METRICS_EXPORTER` environment variable](../../sdk-environment-variables.md#exporter-selection)), by default the exporter MUST be paired with a -[periodic exporting MetricReader](../sdk.md#periodic-exporting-metricreader). +[periodic exporting MetricReader](../sdk.md#periodic-exporting-metricreader) +with a default `exportIntervalMilliseconds` and +`exportTimeoutMilliseconds` of positive infinity (i.e., a manual flush of the +`MetricReader` is required). In-memory Metrics Exporter MUST support both Cumulative and Delta [Temporality](../datamodel.md#temporality). diff --git a/specification/metrics/sdk_exporters/stdout.md b/specification/metrics/sdk_exporters/stdout.md index 6a41145de4f..46b49301f52 100644 --- a/specification/metrics/sdk_exporters/stdout.md +++ b/specification/metrics/sdk_exporters/stdout.md @@ -11,7 +11,9 @@ If a language provides a mechanism to automatically configure a the [`OTEL_METRICS_EXPORTER` environment variable](../../sdk-environment-variables.md#exporter-selection)), by default the exporter MUST be paired with a -[periodic exporting MetricReader](../sdk.md#periodic-exporting-metricreader). +[periodic exporting MetricReader](../sdk.md#periodic-exporting-metricreader) +with a default `exportIntervalMilliseconds` of 10000 and +`exportTimeoutMilliseconds` of 5000. [OpenTelemetry SDK](../../overview.md#sdk) authors MAY choose the best idiomatic name for their language. For example, ConsoleExporter, StdoutExporter, From cc6c77134a51f68d7e4c496ebdcc38b5939afcb3 Mon Sep 17 00:00:00 2001 From: Alan West <3676547+alanwest@users.noreply.github.com> Date: Tue, 15 Mar 2022 13:24:21 -0700 Subject: [PATCH 2/4] Remove specification of exportTimeoutMilliseconds --- CHANGELOG.md | 2 +- specification/metrics/sdk_exporters/in-memory.md | 5 ++--- specification/metrics/sdk_exporters/stdout.md | 3 +-- 3 files changed, 4 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 56288176ea4..ccffa2c809c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -35,7 +35,7 @@ release. ([#2406](/~https://github.com/open-telemetry/opentelemetry-specification/pull/2406)). - Specify default configuration for a periodic metric reader that is associated with the stdout and in-memory metric exporters. - ([#TBD](/~https://github.com/open-telemetry/opentelemetry-specification/pull/TBD)). + ([#2415](/~https://github.com/open-telemetry/opentelemetry-specification/pull/2415)). ### Logs diff --git a/specification/metrics/sdk_exporters/in-memory.md b/specification/metrics/sdk_exporters/in-memory.md index 44147df0b8b..4b9f95bb1f6 100644 --- a/specification/metrics/sdk_exporters/in-memory.md +++ b/specification/metrics/sdk_exporters/in-memory.md @@ -12,9 +12,8 @@ the [`OTEL_METRICS_EXPORTER` environment variable](../../sdk-environment-variables.md#exporter-selection)), by default the exporter MUST be paired with a [periodic exporting MetricReader](../sdk.md#periodic-exporting-metricreader) -with a default `exportIntervalMilliseconds` and -`exportTimeoutMilliseconds` of positive infinity (i.e., a manual flush of the -`MetricReader` is required). +with a default `exportIntervalMilliseconds` of positive infinity (i.e., a manual +flush of the `MetricReader` is required). In-memory Metrics Exporter MUST support both Cumulative and Delta [Temporality](../datamodel.md#temporality). diff --git a/specification/metrics/sdk_exporters/stdout.md b/specification/metrics/sdk_exporters/stdout.md index 46b49301f52..246b4691483 100644 --- a/specification/metrics/sdk_exporters/stdout.md +++ b/specification/metrics/sdk_exporters/stdout.md @@ -12,8 +12,7 @@ the [`OTEL_METRICS_EXPORTER` environment variable](../../sdk-environment-variables.md#exporter-selection)), by default the exporter MUST be paired with a [periodic exporting MetricReader](../sdk.md#periodic-exporting-metricreader) -with a default `exportIntervalMilliseconds` of 10000 and -`exportTimeoutMilliseconds` of 5000. +with a default `exportIntervalMilliseconds` of 10000. [OpenTelemetry SDK](../../overview.md#sdk) authors MAY choose the best idiomatic name for their language. For example, ConsoleExporter, StdoutExporter, From 93bc13ddc1534f4eea06b65c1a00043818ba5fc3 Mon Sep 17 00:00:00 2001 From: Alan West <3676547+alanwest@users.noreply.github.com> Date: Fri, 18 Mar 2022 08:25:33 -0700 Subject: [PATCH 3/4] Leave in-memory spec as-is for now --- CHANGELOG.md | 2 +- specification/metrics/sdk_exporters/in-memory.md | 6 ++---- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ccffa2c809c..7ab34f9fa52 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -34,7 +34,7 @@ release. - Clarify that MetricReader has one-to-one mapping to MeterProvider. ([#2406](/~https://github.com/open-telemetry/opentelemetry-specification/pull/2406)). - Specify default configuration for a periodic metric reader that is associated with - the stdout and in-memory metric exporters. + the stdout metric exporter. ([#2415](/~https://github.com/open-telemetry/opentelemetry-specification/pull/2415)). ### Logs diff --git a/specification/metrics/sdk_exporters/in-memory.md b/specification/metrics/sdk_exporters/in-memory.md index 4b9f95bb1f6..3b63398b10b 100644 --- a/specification/metrics/sdk_exporters/in-memory.md +++ b/specification/metrics/sdk_exporters/in-memory.md @@ -11,13 +11,11 @@ If a language provides a mechanism to automatically configure a the [`OTEL_METRICS_EXPORTER` environment variable](../../sdk-environment-variables.md#exporter-selection)), by default the exporter MUST be paired with a -[periodic exporting MetricReader](../sdk.md#periodic-exporting-metricreader) -with a default `exportIntervalMilliseconds` of positive infinity (i.e., a manual -flush of the `MetricReader` is required). +[periodic exporting MetricReader](../sdk.md#periodic-exporting-metricreader). In-memory Metrics Exporter MUST support both Cumulative and Delta [Temporality](../datamodel.md#temporality). In-memory Metrics Exporter MUST allow [Aggregation Temporality](../datamodel.md#temporality) to be specified, as described in -[MetricExporter](../sdk.md#metricexporter). +[MetricExporter](../sdk.md#metricexporter). \ No newline at end of file From 73de4187dc0312b1266b337508bb83ae543179b2 Mon Sep 17 00:00:00 2001 From: Alan West <3676547+alanwest@users.noreply.github.com> Date: Fri, 18 Mar 2022 08:29:52 -0700 Subject: [PATCH 4/4] Add newline --- specification/metrics/sdk_exporters/in-memory.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/metrics/sdk_exporters/in-memory.md b/specification/metrics/sdk_exporters/in-memory.md index 3b63398b10b..f430429a48a 100644 --- a/specification/metrics/sdk_exporters/in-memory.md +++ b/specification/metrics/sdk_exporters/in-memory.md @@ -18,4 +18,4 @@ In-memory Metrics Exporter MUST support both Cumulative and Delta In-memory Metrics Exporter MUST allow [Aggregation Temporality](../datamodel.md#temporality) to be specified, as described in -[MetricExporter](../sdk.md#metricexporter). \ No newline at end of file +[MetricExporter](../sdk.md#metricexporter).