Add disclaimer to ForceFlush to recommend calling only when necessary #4359
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dashpole
requested review from
MrAlias,
Aneurysm9,
evantorrie,
XSAM,
MadVikingGod,
pellared,
hanyuancheung and
dmathieu
as code owners
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #4359 +/- ##
=======================================
- Coverage 83.5% 83.4% -0.1%
=======================================
Files 184 184
Lines 14383 14383
=======================================
- Hits 12011 12009 -2
- Misses 2145 2147 +2
Partials 227 227
|
MrAlias
approved these changes
Jul 24, 2023
There was a problem hiding this comment.
I think the specification needs to be updated to make the normative recommendation about having this type of documentation. It cannot recommend to the user in the specification what they should or shouldn't do given they are not the intended audience and the user has not requirement to follow the specification.
|
I am not approving because I have upvoted open-telemetry/opentelemetry-specification#3620 (comment) 😉 |
|
Converting to draft while we decide if this is necessary |
|
closing for now. I'll reopen if it is needed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of #3666
Spec: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#forceflush-1
ForceFlush SHOULD only be called in cases where it is absolutely necessary, such as when using some FaaS providers that may suspend the process after an invocation, but before the exporter exports the completed metrics.This adds the disclaimer from the specification to our interfaces which have ForceFlush