Minor: Improve Datadog::Profiling::HttpTransport error logging #3038
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 tweaks the `HttpTransport` error logging to include the
configuration being used.
For instance, it will now look like:
```
ERROR (lib/datadog/profiling/http_transport.rb:58:in `export') Failed to
report profiling data ({:agent=>"unix:///fake-apm-socket.socket"}):
failed ddog_prof_Exporter_send: error trying to connect: No such file
or directory (os error 2): No such file or directory (os error 2)
```
...I did notice the libdatadog error message seems to be repeated and
isn't particularly great; that's a separate issue for a future fix
(on the libdatadog side).
**Motivation**:
While investigating #3037 I noticed this information was not being
logged when the profiler failed to report, and I thought it would be
come in handy when debugging future issues.
**Additional Notes**:
N/A
**How to test the change?**:
The change includes test coverage. You can also manually trigger an
issue by running dd-trace-rb with an invalid configuration, e.g.
the above error message was triggered by running with
```bash
$ DD_PROFILING_ENABLED=true DD_TRACE_AGENT_URL=unix:///fake-apm-socket.socket \
bundle exec ddtracerb exec ruby -e "sleep 1"
```
Codecov Report
@@ Coverage Diff @@
## master #3038 +/- ##
==========================================
+ Coverage 98.08% 98.12% +0.03%
==========================================
Files 1317 1322 +5
Lines 74362 74644 +282
Branches 3402 3403 +1
==========================================
+ Hits 72941 73247 +306
+ Misses 1421 1397 -24
... and 8 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
marcotc
approved these changes
Aug 9, 2023
ivoanjo
deleted the
ivoanjo/improve-profiling-http-transport-error-logging
branch
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 tweaks the
HttpTransporterror logging to include the configuration being used.For instance, it will now look like:
...I did notice the libdatadog error message seems to be repeated and isn't particularly great; that's a separate issue for a future fix (on the libdatadog side).
Motivation:
While investigating #3037 I noticed this information was not being logged when the profiler failed to report, and I thought it would be come in handy when debugging future issues.
Additional Notes:
N/A
How to test the change?:
The change includes test coverage. You can also manually trigger an issue by running dd-trace-rb with an invalid configuration, e.g. the above error message was triggered by running with