Backport "[NO-TICKET] Fix error during telemetry debug logging attempt" to 1.x-stable #3618
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
**What does this PR do?**
This PR fixes the following debug error log that would happen when
enabling debug logging + not having an agent running locally.
```
$ DD_TRACE_DEBUG=true bundle exec ruby -e "require 'datadog'; Datadog.configure {}; sleep 1"
...
DEBUG -- datadog: [datadog] (lib/datadog/core/telemetry/http/adapters/net.rb:47:in `rescue in post') Unable to send telemetry event to agent: Failed to open TCP connection to 127.0.0.1:8126 (Connection refused - connect(2) for "127.0.0.1" port 8126)
DEBUG -- datadog: [datadog] (lib/datadog/core/telemetry/emitter.rb:32:in `rescue in request') Unable to send telemetry request for event `app-started`: undefined method `code' for Datadog::Core::Telemetry::Http::InternalErrorResponse ok?: unsupported?:, not_found?:, client_error?:, server_error?:, internal_error?:true, payload:, error_type:Errno::ECONNREFUSED error:Failed to open TCP connection to 127.0.0.1:8126 (Connection refused - connect(2) for "127.0.0.1" port 8126):Datadog::Core::Telemetry::Http::InternalErrorResponse
Datadog.logger.debug { "Telemetry sent for event `#{event.type}` (status code: #{res.code})" }
^^^^^
```
Specifically, the class used to communicate errors
(`Datadog::Core::Telemetry::Http::Response::InternalErrorResponse`)
did not define a `#code` accessor, thus making the log message that
tries to debug the response code fail.
**Motivation:**
Fix this error.
**Additional Notes:**
The error itself was annoying, but harmless, as we did catch
the exception anyway.
I think the current approach of having a `Response` module that then
gets inserted into a few classes is a bit error prone.
And this is one where we definitely would've been saved by having
type signatures for this part of the code.
**How to test the change?**
I've added unit coverage + you can use the example above to
confirm it no longer happens manually.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## 1.x-stable #3618 +/- ##
===========================================
Coverage 98.24% 98.24%
===========================================
Files 1255 1255
Lines 74569 74579 +10
Branches 3540 3540
===========================================
+ Hits 73262 73272 +10
Misses 1307 1307 ☔ View full report in Codecov by Sentry. |
marcotc
approved these changes
May 1, 2024
AlexJF
approved these changes
May 2, 2024
This was referenced May 9, 2024
Merged
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.
What does this PR do?
This PR backports #3617 to the 1.x-stable branch. See original PR for more details.
Motivation:
This fix also makes sense to apply on the 1.x-stable series.
Additional Notes:
I cherry-picked the upstream commit with no other changes.
How to test the change?
See original PR for details.