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

[component] clarifying lifecycle expectation #6535

Merged

Conversation

MovieStoreGuy
Copy link
Contributor

Description:

Extended the documentation of the component to include safe Shutdown expectations.

Link to tracking Issue:
#6507

Testing:
N/A

Documentation:
N/A

Sean (MovieStoreGuy) Marciniak added 2 commits November 12, 2022 21:52
Intentionally adding in a changelog here since this can has significant
impact on implemented components.
@MovieStoreGuy MovieStoreGuy requested review from a team and dmitryax November 12, 2022 11:45
@codecov
Copy link

codecov bot commented Nov 12, 2022

Codecov Report

Base: 91.33% // Head: 91.01% // Decreases project coverage by -0.31% ⚠️

Coverage data is based on head (d56e428) compared to base (d55b152).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6535      +/-   ##
==========================================
- Coverage   91.33%   91.01%   -0.32%     
==========================================
  Files         242      241       -1     
  Lines       13888    13885       -3     
==========================================
- Hits        12684    12637      -47     
- Misses        959     1008      +49     
+ Partials      245      240       -5     
Impacted Files Coverage Δ
component/component.go 25.58% <ø> (-74.42%) ⬇️
component/config.go 0.00% <0.00%> (-40.00%) ⬇️
component/componenttest/nop_factories.go 0.00% <0.00%> (-29.42%) ⬇️
component/extension.go 86.66% <0.00%> (-13.34%) ⬇️
component/exporter.go 96.07% <0.00%> (-3.93%) ⬇️
component/receiver.go 96.07% <0.00%> (-3.93%) ⬇️
component/processor.go 96.07% <0.00%> (-3.93%) ⬇️
service/collector.go 76.31% <0.00%> (ø)
receiver/otlpreceiver/config.go 94.44% <0.00%> (ø)
... and 1 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@MovieStoreGuy
Copy link
Contributor Author

I've include a change log for this PR since this documentation impacts all components of the project and contrib.

Copy link
Contributor

@codeboten codeboten left a comment

Choose a reason for hiding this comment

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

Clarified the comment a bit, as i found it confusing to read, PTAL

.chloggen/msg_update-docs-for-component.yaml Outdated Show resolved Hide resolved
component/component.go Outdated Show resolved Hide resolved
Co-authored-by: Alex Boten <alex@boten.ca>
@codeboten codeboten added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Nov 16, 2022
@codeboten codeboten merged commit ee05613 into open-telemetry:main Nov 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants