Add example listening for sigterm to docs (APMSP-15340) #2978
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.
What does this PR do?
Add an example so customers know they can listen for SIGTERM and shutdown the tracer to avoid lost data.
I debated adding more complexity here like enforcing a timeout, or supporting a context cancellation so this go routine doesn't just hang around forever but that seems like something that "can be left as an exercise to the reader" perhaps? If others feel strongly I'm happy to update this example to be more in depth though.
Motivation
See #2976 for some motivation, at some point we may attach this sort of listener automatically but there doesn't seem to be a clean way to do so currently without risking altering some customer application behavior.
Reviewer's Checklist
Unsure? Have a question? Request a review!