Skip to content

Conversation

@CodeBlanch
Copy link
Member

Relates to #4433

Changes

  • Exposes the logging artifacts in OpenTelemetry.Api and removes the added InternalsVisibleTos

Merge requirement checklist

  • CONTRIBUTING guidelines followed (nullable enabled, static analysis, etc.)
  • Appropriate CHANGELOG.md files updated for non-trivial changes
  • Changes in public API reviewed (if applicable)

@CodeBlanch CodeBlanch requested a review from a team June 6, 2023 23:42
@codecov
Copy link

codecov bot commented Jun 6, 2023

Codecov Report

Merging #4552 (20e0221) into main (b911e7e) will increase coverage by 0.26%.
The diff coverage is n/a.

❗ Current head 20e0221 differs from pull request most recent head 1d01283. Consider uploading reports for the commit 1d01283 to get more accurate results

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #4552      +/-   ##
==========================================
+ Coverage   85.16%   85.43%   +0.26%     
==========================================
  Files         320      320              
  Lines       12677    12641      -36     
==========================================
+ Hits        10797    10800       +3     
+ Misses       1880     1841      -39     
Impacted Files Coverage Δ
...c/OpenTelemetry.Api/Logs/LogRecordAttributeList.cs 68.75% <ø> (ø)
src/OpenTelemetry.Api/Logs/LogRecordData.cs 100.00% <ø> (ø)
...nTelemetry.Api/Logs/LogRecordSeverityExtensions.cs 100.00% <ø> (ø)
src/OpenTelemetry.Api/Logs/Logger.cs 100.00% <ø> (ø)
src/OpenTelemetry.Api/Logs/LoggerProvider.cs 100.00% <ø> (ø)
...rc/OpenTelemetry.Api/Logs/LoggerProviderBuilder.cs 100.00% <ø> (ø)

... and 8 files with indirect coverage changes


* Added [Logs Bridge
API](https://github.com/open-telemetry/opentelemetry-specification/blob/976432b74c565e8a84af3570e9b82cb95e1d844c/specification/logs/bridge-api.md)
artifacts.
Copy link
Member

Choose a reason for hiding this comment

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

What does "artifact" mean here? (which part of https://en.wikipedia.org/wiki/Artifact_(software_development))

Copy link
Member Author

Choose a reason for hiding this comment

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

"Things" 🤣 I changed the entry to call out the main pieces LMK if you want it to say more.

Copy link
Member

Choose a reason for hiding this comment

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

I guess many folks would interpret "adding ... artifacts" as "introducing a new NuGet package or DLL". I suggest that we simply say "added logs bridge API" ("to the existing API artifact" - which can be easily deduced from the changelog context).

Copy link
Member Author

Choose a reason for hiding this comment

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

Something weird is going on with GitHub. I pushed to the branch behind this PR but the PR isn't updating. Here's the commit if you want to check out the text I'm trying to use 😄

CodeBlanch@20e0221

Copy link
Member

Choose a reason for hiding this comment

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

The new version is much easier to understand 👍

@CodeBlanch CodeBlanch merged commit 9e8c704 into open-telemetry:main Jun 7, 2023
@CodeBlanch CodeBlanch deleted the logs-api-public branch June 7, 2023 19:26
@@ -1,0 +1,79 @@
abstract OpenTelemetry.Logs.Logger.EmitLog(in OpenTelemetry.Logs.LogRecordData data, in OpenTelemetry.Logs.LogRecordAttributeList attributes = default(OpenTelemetry.Logs.LogRecordAttributeList)) -> void
Copy link
Contributor

@utpilla utpilla Jun 7, 2023

Choose a reason for hiding this comment

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

Did we not try to avoid APIs with default parameters earlier?

I would have expected code analysis to complain about this. RS0026: Do not add multiple public overloads with optional parameters

mfogliatto pushed a commit to mfogliatto/opentelemetry-dotnet that referenced this pull request Jun 10, 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.

4 participants