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

Clarify MetricReader parameters and temporality controls #2404

Merged
merged 28 commits into from
Mar 18, 2022
Merged

Clarify MetricReader parameters and temporality controls #2404

Show file tree
Hide file tree
Changes from 23 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
3def12b
Allow view configuration to specify cumulative, delta, or default agg…
Mar 5, 2022
6863a5d
the other exporters
Mar 5, 2022
e4c063e
Changelog
Mar 5, 2022
52ed7d5
PR num fix
Mar 7, 2022
597f8d5
Update specification/metrics/sdk_exporters/stdout.md
jmacd Mar 8, 2022
2f65282
Update specification/metrics/sdk.md
jmacd Mar 8, 2022
8873052
Merge branch 'main' of github.com:open-telemetry/opentelemetry-specif…
Mar 9, 2022
f66dc14
Merge branch 'jmacd/view_tempo' of github.com:jmacd/opentelemetry-spe…
Mar 9, 2022
c49d996
rough draft
Mar 10, 2022
40aec67
remove view aspect
Mar 10, 2022
5f9bb1a
Apply suggestions from code review
jmacd Mar 11, 2022
e8c3476
remove default_enabled, restore original view behavior
Mar 14, 2022
b301b5e
Merge branch 'jmacd/view_tempo' of github.com:jmacd/opentelemetry-spe…
Mar 14, 2022
6a036b3
update changelog
Mar 14, 2022
cd0c4d1
on the basis of..
Mar 14, 2022
cb38fe4
be explicit about UpDownCounter being cumulative even for DELTA prefe…
Mar 14, 2022
eef4876
consistency
Mar 14, 2022
fdd071d
restore delta example
Mar 14, 2022
5c688c8
Apply suggestions from code review
jmacd Mar 15, 2022
d295a6c
update spec matrix
Mar 15, 2022
fa34577
Merge branch 'jmacd/view_tempo' of github.com:jmacd/opentelemetry-spe…
Mar 15, 2022
e508b8e
Merge branch 'main' of github.com:open-telemetry/opentelemetry-specif…
Mar 15, 2022
7260dcd
lint
Mar 15, 2022
efb040f
be explicit about cumulative-to-delta
Mar 16, 2022
158e7ac
Merge branch 'main' of github.com:open-telemetry/opentelemetry-specif…
Mar 16, 2022
2a870f3
Merge branch 'main' into jmacd/view_tempo
reyang Mar 18, 2022
a901987
lint
Mar 18, 2022
e9db2ea
Merge branch 'jmacd/view_tempo' of github.com:jmacd/opentelemetry-spe…
Mar 18, 2022
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
9 changes: 9 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,15 @@ 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)).
- Clarify the manner in which aggregation and temporality preferences
are encoded via MetricReader parameters "on the basis of instrument
kind". Rename the environment variable
`OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE` used to set the
preference to be used when auto-configuring an OTLP Exporter,
defaults to CUMULATIVE, with DELTA an option that makes Counter,
Asynchronous Counter, and Histogram instruments choose Delta
temporality by default.
([#2404](https://github.com/open-telemetry/opentelemetry-specification/pull/2404)).

### Logs

Expand Down
70 changes: 37 additions & 33 deletions spec-compliance-matrix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,15 +181,18 @@ Disclaimer: this list of features is still a work in progress, please refer to t
| The `Histogram` aggregation performs as specified. | | + | + | | - | | | | | | + | |
| The explicit bucket `Histogram` aggregation is available. | | - | + | | + | | | | | | + | |
| The explicit bucket `Histogram` aggregation performs as specified. | | - | + | | - | | | | | | + | |
| The metrics exporter has access to the aggregated metrics data (aggregated points, not raw measurements). | | + | - | | - | | | | | | + | |
| The metrics exporter `export` function can not be called concurrently from the same exporter instance. | | + | - | | - | | | | | | + | |
| The metrics exporter `export` function does not block indefinitely. | | + | - | | - | | | | | | + | |
| The metrics exporter `export` function receives a batch of metrics. | | + | + | | - | | | | | | + | |
| The metrics exporter `export` function returns `Success` or `Failure`. | | + | + | | - | | | | | | + | |
| The metrics exporter provides a `ForceFlush` function. | | - | - | | - | | | | | | + | |
| The metrics exporter `ForceFlush` can inform the caller whether it succeeded, failed or timed out. | | | | | - | | | | | | + | |
| The metrics exporter provides a `shutdown` function. | | + | + | | - | | | | | | + | |
| The metrics exporter `shutdown` function do not block indefinitely. | | + | - | | - | | | | | | + | |
| 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. | | | | | | | | | | | | |
| The metrics Exporter has access to the aggregated metrics data (aggregated points, not raw measurements). | | + | - | | - | | | | | | + | |
| The metrics Exporter `export` function can not be called concurrently from the same Exporter instance. | | + | - | | - | | | | | | + | |
| The metrics Exporter `export` function does not block indefinitely. | | + | - | | - | | | | | | + | |
| The metrics Exporter `export` function receives a batch of metrics. | | + | + | | - | | | | | | + | |
| The metrics Exporter `export` function returns `Success` or `Failure`. | | + | + | | - | | | | | | + | |
| The metrics Exporter provides a `ForceFlush` function. | | - | - | | - | | | | | | + | |
| The metrics Exporter `ForceFlush` can inform the caller whether it succeeded, failed or timed out. | | | | | - | | | | | | + | |
| The metrics Exporter provides a `shutdown` function. | | + | + | | - | | | | | | + | |
| The metrics Exporter `shutdown` function do not block indefinitely. | | + | - | | - | | | | | | + | |
| The metrics SDK samples `Exemplar`s from measurements. | | | | | - | | | | | | - | |
| Exemplar sampling can be disabled. | | | | | - | | | | | | - | |
| The metrics SDK samples measurements in the context of a sampled trace by default. | | | | | - | | | | | | - | |
Expand Down Expand Up @@ -240,30 +243,31 @@ 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_RESOURCE_ATTRIBUTES | + | + | + | + | + | + | - | + | + | + | - |
|OTEL_SERVICE_NAME | + | | | | | + | | | | + | |
|OTEL_LOG_LEVEL | - | - | + | [-][py1059] | + | - | - | | - | - | - |
|OTEL_PROPAGATORS | - | + | | + | + | + | - | - | - | - | - |
|OTEL_BSP_* | - | + | | + | + | + | - | + | - | - | - |
|OTEL_EXPORTER_OTLP_* | + | + | | + | + | + | - | + | + | + | - |
|OTEL_EXPORTER_JAEGER_* | + | | | | | - | - | | - | + | - |
|OTEL_EXPORTER_ZIPKIN_* | - | | | | | - | - | - | - | + | - |
|OTEL_TRACES_EXPORTER | - | + | | + | + | + | | - | - | - | |
|OTEL_METRICS_EXPORTER | - | + | | + | - | - | | - | - | - | - |
|OTEL_LOGS_EXPORTER | | | | | | | | | | - | |
|OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT | - | + | | + | + | + | | + | - | - | |
|OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT | | | | | | + | | | | - | |
|OTEL_SPAN_EVENT_COUNT_LIMIT | - | + | | + | + | + | | + | - | - | |
|OTEL_SPAN_LINK_COUNT_LIMIT | - | + | | + | + | + | | + | - | - | |
|OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT | | | | | | + | | | | - | |
|OTEL_LINK_ATTRIBUTE_COUNT_LIMIT | | | | | | + | | | | - | |
|OTEL_TRACES_SAMPLER | - | + | | + | + | + | | - | - | - | |
|OTEL_TRACES_SAMPLER_ARG | - | + | | + | + | + | | - | - | - | |
|OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT | | | | | | - | | | | - | |
|OTEL_ATTRIBUTE_COUNT_LIMIT | | | | | | - | | | | - | |
|OTEL_METRICS_EXEMPLAR_FILTER | | | | | | | | | | - | |
|Feature |Go |Java|JS |Python|Ruby|Erlang|PHP|Rust|C++|.NET|Swift|
|--------------------------------------------------|---|----|---|------|----|------|---|----|---|----|-----|
|OTEL_RESOURCE_ATTRIBUTES | + | + | + | + | + | + | - | + | + | + | - |
|OTEL_SERVICE_NAME | + | | | | | + | | | | + | |
|OTEL_LOG_LEVEL | - | - | + | [-][py1059] | + | - | - | | - | - | - |
|OTEL_PROPAGATORS | - | + | | + | + | + | - | - | - | - | - |
|OTEL_BSP_* | - | + | | + | + | + | - | + | - | - | - |
|OTEL_EXPORTER_OTLP_* | + | + | | + | + | + | - | + | + | + | - |
|OTEL_EXPORTER_JAEGER_* | + | | | | | - | - | | - | + | - |
|OTEL_EXPORTER_ZIPKIN_* | - | | | | | - | - | - | - | + | - |
|OTEL_TRACES_EXPORTER | - | + | | + | + | + | | - | - | - | |
|OTEL_METRICS_EXPORTER | - | + | | + | - | - | | - | - | - | - |
|OTEL_LOGS_EXPORTER | | | | | | | | | | - | |
|OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT | - | + | | + | + | + | | + | - | - | |
|OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT | | | | | | + | | | | - | |
|OTEL_SPAN_EVENT_COUNT_LIMIT | - | + | | + | + | + | | + | - | - | |
|OTEL_SPAN_LINK_COUNT_LIMIT | - | + | | + | + | + | | + | - | - | |
|OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT | | | | | | + | | | | - | |
|OTEL_LINK_ATTRIBUTE_COUNT_LIMIT | | | | | | + | | | | - | |
|OTEL_TRACES_SAMPLER | - | + | | + | + | + | | - | - | - | |
|OTEL_TRACES_SAMPLER_ARG | - | + | | + | + | + | | - | - | - | |
|OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT | | | | | | - | | | | - | |
|OTEL_ATTRIBUTE_COUNT_LIMIT | | | | | | - | | | | - | |
|OTEL_METRICS_EXEMPLAR_FILTER | | | | | | | | | | - | |
|OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE | | | | | | | | | | | |

## Exporters

Expand Down
Loading