Ethon instrumentation #2260
Merged
Ethon instrumentation #2260
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
add instrumentation for Ethon resolves #2187
- add Ethon instrumentation to default source - regenerate `newrelic.yml`
have the Ethon suite included in the http clients 2 list
2 of the shared HTTP client tests that Ethon was failing on have been re-enabled. The tests were failing because of a stray typo made in the shared tests file that had since been corrected.
- headers: seeing as we don't operate directly on the libcurl object, we need to propagate any added headers down to that object via `Ethon::Easy#headers=` - errors: use the `Tracer` wrapper around `yield` to automatically notice any errors With those changes, the 2 temporarily skipped tests are now enabled
- Define a response wrapper. It makes sense to have all HTTP client instrumentation follow this pattern. - Enable Ethon instrumentation while using Typhoeus. When Typhoeus engages with Ethon, the child nodes will show up where expected - Restore testing of the majority of cross HTTP client tests with Ethon
Response wrapper headers are different from request wrapper headers. Parse the response headers string to set the response wrapper headers properly
When `Ethon::Multi#perform` is invoked, create a parent segment for the `Ethon::Multi` instance and a child segment for each `Ethon::Easy` instance that exists in the `Ethon::Multi#easy_handles` array.
entry for Ethon instrumentation
Accommodate for both the Typhoeus and Ethon instrumentation being active at the same time (the default)
fallwith
requested review from
hannahramadan,
kaylareopelle and
tannalynn
as code owners
kaylareopelle
requested changes
Oct 18, 2023
For an instance of `Ethon::Easy`, consider a `#return_code` result not equal to `:ok` to be the indicator of an error instead of the `#response_code` being equal to `0`. With direct Ethon usage, these equality checks seem interchangeable but with Typhoeus the underyling easy object is left with a 0 for its response code on success.
- pass 'Ethon::Easy' as a string to `prepend_instrument` to ensure that the gem's class name is referred to with the `::` bit intact - given that `Ethon::Easy` doesn't bother setting an HTTP action/verb in many cases and defers to Curl, let's just use `'GET'` as a default value - convert 'unknownhost' to 'UNKNOWN_HOST' to fit our naming standards
|
|
||
| executes do | ||
| if use_prepend? | ||
| # NOTE: to prevent a string like 'Ethon::Easy' from being converted into |
There was a problem hiding this comment.
nice comment I didn't know prepend_instrument supported a 3rd arg
The shared http client tests will cover gleaning the host from the request headers. Tests have been added to test the other two branches for obtaining a host - the URI instance, and a default string value.
hannahramadan
previously approved these changes
Oct 19, 2023
kaylareopelle
previously approved these changes
Oct 19, 2023
After some extensive testing (thanks, @kaylareopelle) we've decided to disable Ethon instrumentation in the presence of Typhoeus. We already create `Typhoeus/GET` segments for each instance of `Typhoeus::Request` and seeing an additional `Ethon::Easy/GET` segment really just seems to duplicate the number of HTTP requests the app performed. Given that all of the information from an `Ethon::Easy/GET` segment is already contained in the `Typhoeus/GET` segment, it's better to prevent the duplication.
fallwith
dismissed stale reviews from kaylareopelle and hannahramadan
via
bbf0a2f
We've decided to disable Ethon instrumentation when Typhoeus is used and to allow the higher level segments to exist without confusion of seemingly duplicate lower level ones. Fix the shared test cases accordingly.
kaylareopelle
previously approved these changes
Oct 20, 2023
- correct `prepend_instrumentation` comment - revert `typhoeus?` helper now that only a lone caller remains
Thanks very much! Cleanup addressed with 285de8a |
SimpleCov Report
|
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.
add instrumentation for Ethon
resolves #2187