[configtelemetry] add guidelines for each level of config telemetry

[atoulme]

Description

Add to the package comment a set of guidelines for configtelemetry levels.

Link to tracking issue

Fixes #10286

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 91.86%. Comparing base (343f449) to head (33fea7b). Report is 31 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #10365      +/-   ##
==========================================
+ Coverage   91.62%   91.86%   +0.24%     
==========================================
  Files         406      411       +5     
  Lines       19046    19328     +282     
==========================================
+ Hits        17450    17756     +306     
+ Misses       1237     1221      -16     
+ Partials      359      351       -8     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[atoulme]

@jaronoff97 ptal

[jaronoff97]

I do think in the future it would be neat if we had wrapper methods around otel APIs for recording telemetry for each level so authors don't need to keep track of these things.

[github-actions[bot]]

This PR was marked stale due to lack of activity. It will be closed in 14 days.

[github-actions[bot]]

This PR was marked stale due to lack of activity. It will be closed in 14 days.

[mx-psi]

@jaronoff97 Can you take another look?

[jaronoff97]

@mx-psi added another comment, i think other collector maintainers/developers should also look at this as well given it would potentially change what the collector is recommended to emit.

[atoulme]

I'm curious how configtelemetry level is meant to be used in the collector. Is the idea that it will be used to conditionally record telemetry throughout the codebase (are there any examples)? Have you considered using existing SDK mechanisms to limit telemetry such as samplers and views?

you can look at obsreport to give you an idea of some of the bundled telemetry. We use the Go SDK for metrics and traces.

[djaglowski]

I opened https://github.com/open-telemetry/opentelemetry-collector/issues/10769 with a related feature request for metric levels.

[atoulme]

focusing the language on helping component developers make decisions about whether a metric or span should be included at a certain level That's a good insight and I have added a bit on the intent of the doc at the top. Please help make this better.

[atoulme]

@dmitryax reviewed with me and had feedback, we should wait before merging this. He explained that the "Basic" telemetry level is meant also to only be for core level libraries, which makes sense to me. It was discussed on an issue.

[dmitryax]

@dmitryax reviewed with me and had feedback, we should wait before merging this. He explained that the "Basic" telemetry level is meant also to only be for core level libraries, which makes sense to me. It was discussed on an issue.

Here is the issue I was referencing https://github.com/open-telemetry/opentelemetry-collector/issues/7890

[github-actions[bot]]

This PR was marked stale due to lack of activity. It will be closed in 14 days.