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

[Instrumentation.Runtime] Release Runtime instrumentation version 1.0.0 #553

Merged
merged 6 commits into from
Aug 4, 2022

Conversation

xiang17
Copy link
Contributor

@xiang17 xiang17 commented Aug 1, 2022

Release Runtime instrumentation version 1.0.0.

Changes

Update CHANGELOG.md.

For significant contributions please make sure you have completed the following items:

@xiang17 xiang17 requested a review from a team August 1, 2022 20:34
@xiang17 xiang17 changed the title Release Runtime instrumentation version 1.0.0 [Instrumentation.Runtime] Release Runtime instrumentation version 1.0.0 Aug 1, 2022
@cijothomas
Copy link
Member

Couple of things to check before stable release:

  1. https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/0a7b14d2a7e319cc43ee321a2f705ff85b84c050/src/OpenTelemetry.Instrumentation.Runtime/README.md#troubleshooting dont see any actual logging? is this accurate?
  2. - The name sounds incorrect to me.. RuntimeInstrumentationOptions would be more apt.
  3. There is not much public API, but need to make sure no breaking changes once 1.0.0 is shipped. Consider using public api analyzer before releasing stable version of any component.

@utpilla
Copy link
Contributor

utpilla commented Aug 1, 2022

Please enable CodeAnalysis as well.

@xiang17
Copy link
Contributor Author

xiang17 commented Aug 2, 2022

Couple of things to check before stable release:

1. https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/0a7b14d2a7e319cc43ee321a2f705ff85b84c050/src/OpenTelemetry.Instrumentation.Runtime/README.md#troubleshooting dont see any actual logging? is this accurate?

2. https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/0a7b14d2a7e319cc43ee321a2f705ff85b84c050/src/OpenTelemetry.Instrumentation.Runtime/RuntimeInstrumentOptions.cs#L22
    - The name sounds incorrect to me.. `RuntimeInstrumentationOptions` would be more apt.

3. There is not much public API, but need to make sure no breaking changes once 1.0.0 is shipped. Consider using public api analyzer before releasing stable version of any component.
  1. There is no logging. Removed the description from README.md: pending in [Instrumentation.Runtime] Reword README.md #558.
  2. Updated and merged.
  3. Enabled PublicApiAnalyzer and merged the PR. Also updated this PR to move the PublicAPI from Unshipped to Shipped.

@codecov
Copy link

codecov bot commented Aug 2, 2022

Codecov Report

Merging #553 (cb622c8) into main (5b47fd8) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##            main    #553   +/-   ##
=====================================
  Coverage   0.00%   0.00%           
=====================================
  Files        167     167           
  Lines       5100    5100           
=====================================
  Misses      5100    5100           

@cijothomas cijothomas merged commit 8433846 into open-telemetry:main Aug 4, 2022
@xiang17 xiang17 deleted the xiang17/ReleaseStable branch August 4, 2022 01:23
samimusallam pushed a commit to samimusallam/opentelemetry-dotnet-contrib that referenced this pull request Aug 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
comp:instrumentation.runtime Things related to OpenTelemetry.Instrumentation.Runtime
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants