Skip to content

Mark TelemetryProvider API experimental #885

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.

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

Merged
merged 1 commit into from
Jul 7, 2023

Conversation

aajtodd
Copy link
Contributor

@aajtodd aajtodd commented Jul 7, 2023

Issue #

N/A

Description of changes

Mark the TelemetryProvider API as experimental and optin where necessary. This explicitly doesn't mark the TelemetryProvider interface or configuration types as experimental as that would make configuring the SDK itself experimental. Instead we mark every field/method on the interface as Experimental. As we stabilize each telemetry signal implementation we can start to remove the annotation (e.g. once we are happy with metrics and the set of metrics exported we might remove it from meterProvider).

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

public val contextManager: ContextManager
}

@OptIn(ExperimentalApi::class)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question: Shouldn't we opt into this annotation globally the way we do with @InternalApi?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I decided not to because I wanted to see how far reaching the API becomes. Turns out there weren't that many places that need it.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Jul 7, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@aajtodd aajtodd merged commit f0006d9 into observability Jul 7, 2023
@aajtodd aajtodd deleted the experimental-annotation branch July 7, 2023 18:39
aajtodd added a commit that referenced this pull request Jul 7, 2023
aajtodd added a commit that referenced this pull request Jul 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants