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.

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

Simplified self-diagnostics example #2274

Merged

Conversation

cijothomas
Copy link
Member

Simplifies self-diag example to use stdout exporter, and trigger internal log by using an invalid metric instrument name. The purpose is to demonstrate internal logging, so this seems the easiest setup to trigger one.

I kept the minimum filter example to show how to prevent the infinite, recursive logging problem. More complex examples might be needed in practice, but I think it is better instead of focus on fixing the root cause as priority than workarounds which are hacky. (But they are a necessary hack now)

@cijothomas cijothomas requested a review from a team as a code owner November 5, 2024 03:54
@cijothomas
Copy link
Member Author

@lalitb We may actually be able to get-rid of the dedicated self-diag example, and instead demonstrate this in every examples as well.. Maybe something to iterate for next release, based on feedback, especially since we have now starting doing extensive internal logging.

Copy link

codecov bot commented Nov 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.5%. Comparing base (91f44ff) to head (65dfbf0).
Report is 1 commits behind head on main.

Additional details and impacted files
@@          Coverage Diff          @@
##            main   #2274   +/-   ##
=====================================
  Coverage   79.5%   79.5%           
=====================================
  Files        121     121           
  Lines      20960   20960           
=====================================
+ Hits       16671   16673    +2     
+ Misses      4289    4287    -2     

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

.add_directive("tonic=error".parse().unwrap())
.add_directive("h2=error".parse().unwrap())
.add_directive("tower=error".parse().unwrap())
.add_directive("reqwest=error".parse().unwrap());
Copy link
Member

Choose a reason for hiding this comment

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

we can remove this filter if none of these transport dependencies are used in the example.

Copy link
Member Author

Choose a reason for hiding this comment

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

let me move it to the otlp examples, so when users face this issue, they have something to easily refer to, to mitigate the infinite logs problem.

Copy link
Member Author

Choose a reason for hiding this comment

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

will add this shortly in a follow up PR.

Copy link
Member

@lalitb lalitb left a comment

Choose a reason for hiding this comment

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

LGTM, agree on removing this example eventually.

@cijothomas cijothomas merged commit dd7b531 into open-telemetry:main Nov 5, 2024
24 of 25 checks passed
@cijothomas cijothomas deleted the cijothomas/selfdiag-simplifired branch November 5, 2024 16:59
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.

2 participants