Add experimental synchronous gauge #1410

lalitb · 2023-11-29T00:58:13Z

Changes

Adds synchronous gauge, as described in specs - https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/api.md#gauge.

The feature is experimental in specs, so the API to create the Gauge instrument is behind the feature flag - otel_unstable. The feature flag can be removed once the specs are stable.

Merge requirement checklist

CONTRIBUTING guidelines followed
Unit tests added/updated (if applicable)
Appropriate CHANGELOG.md files updated for non-trivial, user-facing changes
Changes in public API reviewed (if applicable)

examples/metrics-basic/Cargo.toml

opentelemetry/src/metrics/mod.rs

opentelemetry-sdk/src/metrics/reader.rs

cijothomas

LGTM.
Lets also add changelog entry for api,sdks.

shaun-cox

Would like others to weigh in on the comment I left about feature flags design and where experimental features should reside, in general...

examples/metrics-basic/Cargo.toml

codecov · 2023-11-30T22:18:44Z

Codecov Report

Attention: 78 lines in your changes are missing coverage. Please review.

Comparison is base (66c1d5f) 58.6% compared to head (7b836ce) 57.8%.
Report is 3 commits behind head on main.

❗ Current head 7b836ce differs from pull request most recent head c1ac8dd. Consider uploading reports for the commit c1ac8dd to get more accurate results

Files	Patch %	Lines
opentelemetry/src/metrics/instruments/gauge.rs	10.7%	25 Missing ⚠️
opentelemetry/src/metrics/mod.rs	0.0%	24 Missing ⚠️
opentelemetry/src/metrics/meter.rs	0.0%	18 Missing ⚠️
opentelemetry-sdk/src/metrics/instrument.rs	0.0%	4 Missing ⚠️
opentelemetry-sdk/src/metrics/pipeline.rs	0.0%	3 Missing ⚠️
opentelemetry/src/metrics/noop.rs	0.0%	3 Missing ⚠️
opentelemetry-sdk/src/metrics/reader.rs	0.0%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##            main   #1410     +/-   ##
=======================================
- Coverage   58.6%   57.8%   -0.9%     
=======================================
  Files        146     146             
  Lines      18719   18605    -114     
=======================================
- Hits       10984   10764    -220     
- Misses      7735    7841    +106

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

opentelemetry-sdk/CHANGELOG.md

lalitb · 2023-12-07T15:18:37Z

@shaun-cox do you think the requested changes can be unblocked with latest commits.

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [opentelemetry](https://togithub.com/open-telemetry/opentelemetry-rust) | dependencies | minor | `0.21` -> `0.22` | | [opentelemetry-http](https://togithub.com/open-telemetry/opentelemetry-rust) | dependencies | minor | `0.10` -> `0.11` | | [opentelemetry-otlp](https://togithub.com/open-telemetry/opentelemetry-rust/tree/main/opentelemetry-otlp) ([source](https://togithub.com/open-telemetry/opentelemetry-rust/tree/HEAD/opentelemetry-otlp)) | dependencies | minor | `0.14` -> `0.15` | | [opentelemetry_sdk](https://togithub.com/open-telemetry/opentelemetry-rust) | dependencies | minor | `0.21` -> `0.22` | | [tracing-opentelemetry](https://togithub.com/tokio-rs/tracing-opentelemetry) | dependencies | minor | `0.22` -> `0.23` | --- ### Release Notes <details> <summary>open-telemetry/opentelemetry-rust (opentelemetry)</summary> ### [`v0.22.0`](https://togithub.com/open-telemetry/opentelemetry-rust/releases/tag/v0.22.0) [Compare Source](https://togithub.com/open-telemetry/opentelemetry-rust/compare/v0.21.0...opentelemetry-0.22.0) ### API #### Added - [open-telemetry/opentelemetry-rust#1410 Add experimental synchronous gauge. This is behind the feature flag, and can be enabled by enabling the feature otel_unstable for opentelemetry crate. - [open-telemetry/opentelemetry-rust#1410 Guidelines to add new unstable/experimental features. #### Changed - Modified AnyValue.Map to be backed by HashMap instead of custom OrderMap, which internally used IndexMap. There was no requirement to maintain the order of entries, so moving from IndexMap to HashMap offers slight performance gains, and avoids IndexMap dependency. This affects body and attributes of LogRecord. [open-telemetry/opentelemetry-rust#1353 - Add TextMapCompositePropagator [open-telemetry/opentelemetry-rust#1373 - Turned off events for NoopLogger to save on operations [open-telemetry/opentelemetry-rust#1455 #### Removed - Removed OrderMap type as there was no requirement to use this over regular HashMap. [open-telemetry/opentelemetry-rust#1353 - Remove API for Creating Histograms with signed integers. [open-telemetry/opentelemetry-rust#1371 - Remove global::shutdown_meter_provider, use SdkMeterProvider::shutdown directly instead ([#1412](https://togithub.com/open-telemetry/opentelemetry-rust/issues/1412)). ### SDK ##### Deprecated - XrayIdGenerator in the opentelemetry-sdk has been deprecated and moved to version 0.10.0 of the opentelemetry-aws crate. ##### Added - [#1410](https://togithub.com/open-telemetry/opentelemetry-rust/pull/1410) Add experimental synchronous gauge - [#1471](https://togithub.com/open-telemetry/opentelemetry-rust/pull/1471) Configure batch log record processor via [`OTEL_BLRP_*`](https://togithub.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#batch-logrecord-processor) environment variables and via `OtlpLogPipeline::with_batch_config` - [#1503](https://togithub.com/open-telemetry/opentelemetry-rust/pull/1503) Make the documentation for In-Memory exporters visible. - [#1526](https://togithub.com/open-telemetry/opentelemetry-rust/pull/1526) Performance Improvement : Creating Spans and LogRecords are now faster, by avoiding expensive cloning of `Resource` for every Span/LogRecord. ##### Changed - **Breaking** [#1313](https://togithub.com/open-telemetry/opentelemetry-rust/pull/1313) [#1350](https://togithub.com/open-telemetry/opentelemetry-rust/pull/1350) Changes how Span links/events are stored to achieve performance gains. See below for details: *Behavior Change*: When enforcing `max_links_per_span`, `max_events_per_span` from `SpanLimits`, links/events are kept in the first-come order. The previous "eviction" based approach is no longer performed. *Breaking Change Affecting Exporter authors*: `SpanData` now stores `links` as `SpanLinks` instead of `EvictedQueue` where `SpanLinks` is a struct with a `Vec` of links and `dropped_count`. `SpanData` now stores `events` as `SpanEvents` instead of `EvictedQueue` where `SpanEvents` is a struct with a `Vec` of events and `dropped_count`. - **Breaking** Remove `TextMapCompositePropagator` [#1373](https://togithub.com/open-telemetry/opentelemetry-rust/pull/1373). Use `TextMapCompositePropagator` in opentelemetry API. - [#1375](https://togithub.com/open-telemetry/opentelemetry-rust/pull/1375/) Fix metric collections during PeriodicReader shutdown - **Breaking** [#1480](https://togithub.com/open-telemetry/opentelemetry-rust/pull/1480) Remove fine grained `BatchConfig` configurations from `BatchLogProcessorBuilder` and `BatchSpanProcessorBuilder`. Use `BatchConfigBuilder` to construct a `BatchConfig` instance and pass it using `BatchLogProcessorBuilder::with_batch_config` or `BatchSpanProcessorBuilder::with_batch_config`. - **Breaking** [#1480](https://togithub.com/open-telemetry/opentelemetry-rust/pull/1480) Remove mutating functions from `BatchConfig`, use `BatchConfigBuilder` to construct a `BatchConfig` instance. - **Breaking** [#1495](https://togithub.com/open-telemetry/opentelemetry-rust/pull/1495) Remove Batch LogRecord\&Span Processor configuration via non-standard environment variables. Use the following table to migrate from the no longer supported non-standard environment variables to the standard ones. | No longer supported | Standard equivalent | |---------------------------------|---------------------------| | OTEL_BLRP_SCHEDULE_DELAY_MILLIS | OTEL_BLRP_SCHEDULE_DELAY | | OTEL_BLRP_EXPORT_TIMEOUT_MILLIS | OTEL_BLRP_EXPORT_TIMEOUT | | OTEL_BSP_SCHEDULE_DELAY_MILLIS | OTEL_BSP_SCHEDULE_DELAY | | OTEL_BSP_EXPORT_TIMEOUT_MILLIS | OTEL_BSP_EXPORT_TIMEOUT | - **Breaking** [1455](https://togithub.com/open-telemetry/opentelemetry-rust/pull/1455) Make the LoggerProvider Owned - `Logger` now takes an Owned Logger instead of a `Weak<LoggerProviderInner>` - `LoggerProviderInner` is no longer `pub (crate)` - `Logger.provider()` now returns `&LoggerProvider` instead of an `Option<LoggerProvider>` - [1519](https://togithub.com/open-telemetry/opentelemetry-rust/pull/1519) Performance improvements when calling `Counter::add()` and `UpDownCounter::add()` with an empty set of attributes (e.g. `counter.Add(5, &[])`) ##### Fixed - [#1481](https://togithub.com/open-telemetry/opentelemetry-rust/pull/1481) Fix error message caused by race condition when using PeriodicReader </details> <details> <summary>open-telemetry/opentelemetry-rust (opentelemetry-otlp)</summary> ### [`v0.15.0`](https://togithub.com/open-telemetry/opentelemetry-rust/blob/HEAD/opentelemetry-otlp/CHANGELOG.md#v0150) [Compare Source](https://togithub.com/open-telemetry/opentelemetry-rust/compare/opentelemetry-otlp-0.14.0...opentelemetry-otlp-0.15.0) ##### Added - Support custom channels in topic exporters [#1335](https://togithub.com/open-telemetry/opentelemetry-rust/pull/1335) - Allow specifying OTLP Tonic metadata from env variable [#1377](https://togithub.com/open-telemetry/opentelemetry-rust/pull/1377) ##### Changed - Update to tonic 0.11 and prost 0.12 [#1536](https://togithub.com/open-telemetry/opentelemetry-rust/pull/1536) ##### Fixed - Fix `tonic()` to the use correct port. [#1556](https://togithub.com/open-telemetry/opentelemetry-rust/pull/1556) ##### Removed - **Breaking** Remove support for surf HTTP client [#1537](https://togithub.com/open-telemetry/opentelemetry-rust/pull/1537) - **Breaking** Remove support for grpcio transport [#1534](https://togithub.com/open-telemetry/opentelemetry-rust/pull/1534) </details> <details> <summary>tokio-rs/tracing-opentelemetry (tracing-opentelemetry)</summary> ### [`v0.23.0`](https://togithub.com/tokio-rs/tracing-opentelemetry/blob/HEAD/CHANGELOG.md#0230-February-26-2024) [Compare Source](https://togithub.com/tokio-rs/tracing-opentelemetry/compare/v0.22.0...v0.23.0) ##### Breaking Changes - Upgrade to opentelemetry 0.22. Refer to the upstream [changelog](https://togithub.com/open-telemetry/opentelemetry-rust/releases/tag/v0.22.0) for more information. In particular, i64 histograms will silently downgrade to key/value exports. </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://togithub.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/TheHackerApp/logging).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

lalitb added 4 commits November 28, 2023 23:53

add synchronous gauge

c07700b

add experimental feature

8560235

fix comments

e3f5903

enable gauge in metrics example

7d43e66

lalitb requested a review from a team as a code owner November 29, 2023 00:58

cijothomas reviewed Nov 29, 2023

View reviewed changes

examples/metrics-basic/Cargo.toml Outdated Show resolved Hide resolved

cijothomas reviewed Nov 29, 2023

View reviewed changes

opentelemetry/src/metrics/mod.rs Show resolved Hide resolved

cijothomas reviewed Nov 29, 2023

View reviewed changes

opentelemetry-sdk/src/metrics/reader.rs Show resolved Hide resolved

cijothomas approved these changes Nov 29, 2023

View reviewed changes

hdost mentioned this pull request Nov 29, 2023

Proposal: Naming for features #1411

Open

shaun-cox requested changes Nov 29, 2023

View reviewed changes

examples/metrics-basic/Cargo.toml Outdated Show resolved Hide resolved

TommyCpp approved these changes Nov 30, 2023

View reviewed changes

use otel_unstable cfg

aa1a2a5

lalitb added 4 commits November 30, 2023 22:26

update contributing.md

271111f

Merge branch 'main' into sync-gauge

7a999c8

changelog

2c0f989

changelog

ac7971d

cijothomas reviewed Dec 1, 2023

View reviewed changes

opentelemetry-sdk/CHANGELOG.md Show resolved Hide resolved

lalitb and others added 5 commits December 1, 2023 18:27

update changelog

bbb1613

switch to feature flag

251736c

update contributing

8b06012

more updates

f64806f

Merge branch 'main' into sync-gauge

6a68927

cijothomas approved these changes Dec 5, 2023

View reviewed changes

cijothomas and others added 2 commits December 4, 2023 17:37

Merge branch 'main' into sync-gauge

7b836ce

Merge branch 'main' into sync-gauge

8ef2526

shaun-cox approved these changes Dec 12, 2023

View reviewed changes

Merge branch 'main' into sync-gauge

c1ac8dd

cijothomas merged commit 038b91b into open-telemetry:main Dec 12, 2023
12 of 13 checks passed

lalitb mentioned this pull request Dec 19, 2023

Add API support for bound instruments #1444

Open

4 tasks

lalitb mentioned this pull request Jan 19, 2024

There should be a way to create a synchronous guage. #1483

Closed

whoahbot mentioned this pull request Feb 22, 2024

Start working on custom metrics for Kafka bytewax/bytewax#404

Merged

ewoolsey mentioned this pull request Feb 27, 2024

Support for synchronous guages tokio-rs/tracing-opentelemetry#109

Open

cijothomas mentioned this pull request Apr 29, 2024

Stabilize synchronous gauge instrument API open-telemetry/opentelemetry-specification#3893

Closed

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add experimental synchronous gauge #1410

Add experimental synchronous gauge #1410

lalitb commented Nov 29, 2023 •

edited

cijothomas left a comment

shaun-cox left a comment

codecov bot commented Nov 30, 2023 •

edited

lalitb commented Dec 7, 2023 •

edited

Add experimental synchronous gauge #1410

Add experimental synchronous gauge #1410

Conversation

lalitb commented Nov 29, 2023 • edited

Changes

Merge requirement checklist

cijothomas left a comment

Choose a reason for hiding this comment

shaun-cox left a comment

Choose a reason for hiding this comment

codecov bot commented Nov 30, 2023 • edited

Codecov Report

lalitb commented Dec 7, 2023 • edited

lalitb commented Nov 29, 2023 •

edited

codecov bot commented Nov 30, 2023 •

edited

lalitb commented Dec 7, 2023 •

edited