Refactor/deprecate trace config #2303

pitoniak32 · 2024-11-17T18:17:06Z

resolves: #2294

Changes

Moving away from trace::Config and .with_config(...) to remain consistent with the MeterProvider, and LoggerProvider.

Migration Guide

Moving away from TracerProvider::builder().with_config(trace::Config::default()).

Simple Example

The provider interface should be similar to the old method. For example, a TracerProvider being configured.

// old
let tracer_provider: TracerProvider = TracerProvider::builder()
    .with_config(Config::default().with_resource(Resource::empty()))
    .build();

// new
let tracer_provider: TracerProvider = TracerProvider::builder()
    .with_resource(Resource::empty())
    .build();

Advanced Example

// old
let tracer_provider = TracerProvider::builder()
    .with_config(
        Config::default()
            .with_resource(Resource::empty())
            .with_sampler(Sampler::AlwaysOn)
            .with_max_events_per_span(16),
    )
    .build();

// new
let tracer_provider = TracerProvider::builder()
    .with_resource(Resource::empty())
    .with_sampler(Sampler::AlwaysOn)
    .with_max_events_per_span(16)
    .build();

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)

codecov · 2024-11-17T18:20:48Z

Codecov Report

Attention: Patch coverage is 50.00000% with 29 lines in your changes missing coverage. Please review.

Project coverage is 79.5%. Comparing base (41afd7f) to head (7e6645c).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
opentelemetry-sdk/src/trace/provider.rs	40.4%	28 Missing ⚠️
opentelemetry-zipkin/src/exporter/mod.rs	0.0%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##            main   #2303     +/-   ##
=======================================
- Coverage   79.6%   79.5%   -0.2%     
=======================================
  Files        123     123             
  Lines      21263   21293     +30     
=======================================
- Hits       16940   16938      -2     
- Misses      4323    4355     +32

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

🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests

cijothomas · 2024-11-18T16:50:44Z

examples/tracing-jaeger/src/main.rs

-                "tracing-jaeger",
-            )])),
-        )
+        .with_resource(Resource::new(vec![KeyValue::new(


we could potentially offer an easier ways for users who is just trying to add service name. For another time!

opentelemetry-sdk/src/trace/config.rs

cijothomas · 2024-11-18T18:00:38Z

opentelemetry-sdk/src/trace/provider.rs

    }

    /// The sdk [`crate::trace::Config`] that this provider will use.
+    #[deprecated(


Please add a changelog too.

cijothomas

LGTM. Lets add changelog too, will merge after one more approval.

Note: This will be part of 0.27.1 as there is no actual method removal, just deprecation warning this time. Actual removal will be 0.28.0 time only

lalitb

LGTM, with nit comments.

opentelemetry-sdk/src/trace/provider.rs

lalitb · 2024-11-18T19:58:55Z

opentelemetry-zipkin/src/exporter/mod.rs

                ));
                cfg
            } else {
+                #[allow(deprecated)]


Would be good to cleanup this instead of having deprecated code. Not a blocker for this PR though :)

it seems like Zipkin needs to be updated to follow the builder pattern that was added for otlp also, its currently using the pipeline version.

I will try and get this refactored to not use the allow.

maybe there can be a followup for the zipkin to match the otlp crate.

Its best to do as a follow up to keep the scope for this PR smaller.

yup, that's what I was thinking. I went simple with the approach on this PR, but I would like to open another to move to the Builder pattern if that would be welcomed

my current change actually ignores the config, I'm going to revert to using the deprecated annotation, and then do a followup PR to move to the builder pattern to avoid too many changes in this PR.

Moving away from trace::Config

making this more consistent with the other signal providers open-telemetry#2294

As opentelemetry 0.27 or newer does not have a method `with_config` for TraceBuilder, it is necessary to call `with_sampler` directly from TraceBuilder without `with_config`. Needed to fix build issues with opentelemetry(_sdk) 0.27 or newer as well as tracing_opentelemetry 0.28 or newer. See also open-telemetry/opentelemetry-rust#2303.

…uild issues (#161) * Update opentelemetry_sdk requirement from 0.26 to 0.27 Updates the requirements on [opentelemetry_sdk](https://github.com/open-telemetry/opentelemetry-rust) to permit the latest version. - [Release notes](https://github.com/open-telemetry/opentelemetry-rust/releases) - [Commits](open-telemetry/opentelemetry-rust@opentelemetry_sdk-0.26.0...opentelemetry_sdk-0.27.1) --- updated-dependencies: - dependency-name: opentelemetry_sdk dependency-type: direct:production ... * Update opentelemetry requirement from 0.26 to 0.27 Updates the requirements on [opentelemetry](https://github.com/open-telemetry/opentelemetry-rust) to permit the latest version. - [Release notes](https://github.com/open-telemetry/opentelemetry-rust/releases) - [Commits](open-telemetry/opentelemetry-rust@opentelemetry-0.26.0...opentelemetry-0.27.1) --- updated-dependencies: - dependency-name: opentelemetry dependency-type: direct:production ... * Update tracing-opentelemetry requirement from 0.27 to 0.28 Updates the requirements on [tracing-opentelemetry](https://github.com/tokio-rs/tracing-opentelemetry) to permit the latest version. - [Release notes](https://github.com/tokio-rs/tracing-opentelemetry/releases) - [Changelog](https://github.com/tokio-rs/tracing-opentelemetry/blob/v0.1.x/CHANGELOG.md) - [Commits](tokio-rs/tracing-opentelemetry@v0.27.0...v0.28.0) --- updated-dependencies: - dependency-name: tracing-opentelemetry dependency-type: direct:production ... * Do not use with_config for opentelemetry 0.27 As opentelemetry 0.27 or newer does not have a method `with_config` for TraceBuilder, it is necessary to call `with_sampler` directly from TraceBuilder without `with_config`. Needed to fix build issues with opentelemetry(_sdk) 0.27 or newer as well as tracing-opentelemetry 0.28 or newer. See also open-telemetry/opentelemetry-rust#2303. --------- Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: Dongsu Park <[email protected]>

pitoniak32 requested a review from a team as a code owner November 17, 2024 18:17

cijothomas reviewed Nov 18, 2024

View reviewed changes

opentelemetry-sdk/src/trace/config.rs Outdated Show resolved Hide resolved

cijothomas reviewed Nov 18, 2024

View reviewed changes

cijothomas approved these changes Nov 18, 2024

View reviewed changes

lalitb approved these changes Nov 18, 2024

View reviewed changes

pitoniak32 added 4 commits November 18, 2024 19:41

refactor: mark trace::Config methods as deprecated

d477a29

Moving away from trace::Config

refactor: move trace::Config methods to provider Builder

a53a0d5

making this more consistent with the other signal providers open-telemetry#2294

fix: update deprecation message to match method

9b68694

doc: update docs to be more accurate

3c3f826

pitoniak32 force-pushed the refactor/deprecate-trace-config branch from 3c1ba0c to be6b8dd Compare November 19, 2024 01:27

chore: update CHANGELOG with deprecation details

7e6645c

pitoniak32 force-pushed the refactor/deprecate-trace-config branch from 3a37cc8 to 7e6645c Compare November 19, 2024 01:48

cijothomas merged commit 849778d into open-telemetry:main Nov 19, 2024
23 of 25 checks passed

pitoniak32 mentioned this pull request Nov 22, 2024

REQUEST: New membership for pitoniak32 open-telemetry/community#2452

Closed

6 tasks

djc mentioned this pull request Dec 10, 2024

sdk: set correct span limit in builder #2405

Merged

dongsupark mentioned this pull request Feb 4, 2025

Update opentelemetry(_sdk) to 0.27, tracing-opentelemetry 0.28, fix build issues Azure/azure-init#161

Merged

bantonsson pushed a commit to bantonsson/opentelemetry-rust that referenced this pull request Oct 9, 2025

Refactor/deprecate trace config (open-telemetry#2303)

cb3d024

bantonsson pushed a commit to bantonsson/opentelemetry-rust that referenced this pull request Oct 9, 2025

Refactor/deprecate trace config (open-telemetry#2303)

5e18340

bantonsson pushed a commit to bantonsson/opentelemetry-rust that referenced this pull request Oct 9, 2025

Refactor/deprecate trace config (open-telemetry#2303)

3d13cd8

Refactor/deprecate trace config #2303

Refactor/deprecate trace config #2303

Uh oh!

Conversation

pitoniak32 commented Nov 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Migration Guide

Simple Example

Advanced Example

Merge requirement checklist

Uh oh!

codecov bot commented Nov 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cijothomas left a comment

Choose a reason for hiding this comment

Uh oh!

lalitb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

pitoniak32 commented Nov 17, 2024 •

edited

Loading

codecov bot commented Nov 17, 2024 •

edited

Loading