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

Docs - logging best practice #5246

Merged
merged 7 commits into from
Jan 23, 2024

Conversation

reyang
Copy link
Member

@reyang reyang commented Jan 23, 2024

Add the initial doc for logging best practices.
Updated the logging benchmark to reflect the latest recommendations.

@reyang reyang requested a review from a team January 23, 2024 19:26
@reyang reyang changed the title Reyang/logging best practice Docs - logging best practice Jan 23, 2024
Copy link

codecov bot commented Jan 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (6250307) 83.38% compared to head (df1133d) 83.12%.
Report is 23 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #5246      +/-   ##
==========================================
- Coverage   83.38%   83.12%   -0.27%     
==========================================
  Files         297      271      -26     
  Lines       12531    11970     -561     
==========================================
- Hits        10449     9950     -499     
+ Misses       2082     2020      -62     
Flag Coverage Δ
unittests ?
unittests-Solution-Experimental 83.08% <100.00%> (?)
unittests-Solution-Stable 83.11% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
...tation.AspNetCore/Implementation/HttpInListener.cs 89.72% <100.00%> (+0.14%) ⬆️
...AspNetCore/Implementation/HttpInMetricsListener.cs 89.47% <ø> (ø)
...plementation/HttpWebRequestActivitySource.netfx.cs 80.77% <100.00%> (ø)
...emetry/Metrics/Exemplar/SimpleExemplarReservoir.cs 80.43% <100.00%> (ø)

... and 33 files with indirect coverage changes

Comment on lines +51 to +53
* Starting from version `3.1.0`, the .NET runtime team is holding a high bar for
backward compatibility on `Microsoft.Extensions.Logging` even during major
version bumps, so compatibility is not a concern here.
Copy link
Member

Choose a reason for hiding this comment

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

I think "high bar" might not be clear to everyone. Maybe something like...

  • Starting from version 3.1.0 the .NET runtime team has committed to preserve backwards compatibility on the Microsoft.Extensions.Logging packages. There will be no breaking changes (within reason) across major version bumps.

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't think we can put such strong statement #4920 (comment).

@CodeBlanch CodeBlanch merged commit eab0a7c into open-telemetry:main Jan 23, 2024
30 checks passed
@reyang reyang deleted the reyang/logging-best-practice branch January 23, 2024 22:00
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