Ensure public apis don't fail after shutdown #1408
Merged
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
ivoanjo
previously approved these changes
Mar 16, 2021
spec/ddtrace_integration_spec.rb
Outdated
| end | ||
|
|
||
| it 'does not error on logging' do | ||
| expect(Datadog.logger.info('test')).to be_truthy |
There was a problem hiding this comment.
Minor: This can be be true, see https://github.com/ruby/ruby/blob/v3_0_0/lib/logger.rb#L477.
|
Looking at the CI failures, at least the JRuby failure seems to be legit. |
Codecov Report
@@ Coverage Diff @@
## master #1408 +/- ##
==========================================
- Coverage 98.16% 98.16% -0.01%
==========================================
Files 768 769 +1
Lines 36667 36714 +47
==========================================
+ Hits 35993 36039 +46
- Misses 674 675 +1
Continue to review full report at Codecov.
|
ivoanjo
previously approved these changes
Mar 17, 2021
ivoanjo
approved these changes
Mar 17, 2021
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.
Our public API can be use permissively across the host application. During the event of a Ruby process shutdown,
ddtracewill invokeDatadog.shutdown!(though anat_exithook) to gracefully flush any pending traces and decommission resources.When this shutdown happens, internal parts of the tracer won't work anymore (new traces won't be captured), which is acceptable, but we must still ensure that calls out public API methods do not raise errors and still behave predictably during a shutdown. We don't want the tracer to interfere with any of the host application's own shutdown routines by introducing uncertain behavior in our tracer public methods.
This PR ensures that our publicly exposed API does not change their interface, nor raise errors after the tracer has been shutdown.