added httpx opentelemetry adapter

[HoneyryderChuck]

httpx is a ruby http client.

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: HoneyryderChuck / name: Tiago (36a1649, 0f6a195)
• ✅ login: simi / name: Josef Šimánek (ce1ccf6, 95d5c7e)

[arielvalentin]

Thank you again for your contribution! We really appreciate your desire to add instrumentation to HTTPX.

This is the first time I am learning about the gem and I think it has a lot of essential features for modern Ruby applications. I most definitely would like to give it a try!
 
Since you are the inventor and maintainer of HTTPX, would you have any interest in being one of the first gem authors to provide First Party support and make OTel one of the official plugins available for your gem?

We could work with you to get the gem listed in the official registry :)

[HoneyryderChuck]

Thx!

would you have any interest in being one of the first gem authors to provide First Party support and make OTel one of the official plugins available for your gem?

What does that entail? FWIW httpx already ships with adapters to other tools, including one for datadog. It seems that in OTel's case every integration ships as its own gem, so not sure if worth deviating frrom that path?

[arielvalentin]

Thx!

would you have any interest in being one of the first gem authors to provide First Party support and make OTel one of the official plugins available for your gem?

What does that entail? FWIW httpx already ships with adapters to other tools, including one for datadog. It seems that in OTel's case every integration ships as its own gem, so not sure if worth deviating frrom that path?

Longer term I think our goal is to have First Party Integration with other gems. We have hesitated doing this in the past because the instrumentation-wg is still immature and semantic conventions is still experimental in quite a few cases.

I am keen on giving first party support soon so that we are able to encourage gem authors to provide first-class support for OTel. We have limited bandwidth and lack a critical mass of experts to have a centralized repo for instrumentations.

This will require maintaining a close partnership with you and other httpx maintainers to ensure we are not inadvertently introducing unreasonable changes.

As for the mechanics of making this happen, here is what I do to create my own instrumentations for our internal libraries at GitHub:

1. Move the instrumentation into the httpx repository. Your instrumentation should inherit from OpenTelemetry::Instrumentation::Base, which should already be done
2. Namespace the gem in your repository under the httpx namespace (as opposed to using OpenTelemetry::Instrumentation)
3. Provide instructions to include the gem in the application's Gemfile.
4. Bundler should take it from there!

The Base gem should register your instrumentation in the registry so there is no need to manually active it if the end user is relying on use_all.

All that being said

I am by no means requiring you to do any of this!

AFAIK, this is the first time a gem author/maintainer is contributing an instrumentation to this repository so I was hoping you may be willing to give a try to First Party instrumentation.

We welcome this contribution and will add you as a CODEOWNER so that we are able to contact you for on-going maintenance in this repo.

[HoneyryderChuck]

I've no problem with providing support for this adapter. I'm not sure what you mean as "first party" though. Does it mean moving the adapter into its own repo? I'm not sure if that would be beneficial at the stage OTel ruby is. But feel free to ping me in any issue and question related to it.

[arielvalentin]

I'm not sure what you mean as "first party" though. Does it mean moving the adapter into its own repo?

Ideally OTel support would be a "first party" instrumentation, meaning maintained by gem authors; and not "third party" meaning maintained in this repository by us.

In this case it would mean residing with the other adapters and included in the httpx like the others are: https://gitlab.com/os85/httpx/-/tree/master/lib/httpx/adapters?ref_type=heads

Then in that ideal world, we would change the instrumentation portion of this repo to provide utilities and tools for gem maintainers.

The challenge we face with third party maintenance is that we have limited capacity and expertise and when upstream changes happen with gems being instrumented in this repo. We have had a few contributions and instrumentations that do not have active maintainers and at some point in the future we will not be able to keep up and have to sunset them.

Hope that clears up what I mean.

[arielvalentin]

@HoneyryderChuck There are a few more steps to ensure tests are passing on multiple versions of Ruby:

Please add the instrumentation to the CI builds:

• https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/.github/workflows/ci-instrumentation.yml#L16
• https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/.github/workflows/ci-instrumentation-canary.yml#L13

Please add the gem to the release list:

• https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/.toys/.data/releases.yml#L193

Once all of the tests are passing I will merge.

[HoneyryderChuck]

@arielvalentin updated

[arielvalentin]

Looks like there are failing specs: https://github.com/open-telemetry/opentelemetry-ruby-contrib/actions/runs/6626632507/job/18000606095?pr=681

[HoneyryderChuck]

fixed.

[HoneyryderChuck]

@arielvalentin any updates on this one? do you think it's ready?