opentelemetry-operator icon indicating copy to clipboard operation
opentelemetry-operator copied to clipboard

[autoinstrumentation] add ruby autoinstrumentation

Open xuan-cao-swi opened this issue 10 months ago • 8 comments

Description: <Describe what has changed.>

Add the initial version of autoinstrumentation ruby (image and crd change).

Link to tracking Issue(s): <Issue number if applicable>

Testing: <Describe what testing was performed and which tests were added.>

  • e2e-instrumentation and e2e-multi-instrumentation are performed; but hopefully they can be added after autoinstrumentation-ruby image gets publish first.
  • Also did general local testing (demo 00:13:25 ~ 00:16:44)

Documentation: <Describe the documentation added.> Added doc in docs/api/instrumentations.md

xuan-cao-swi avatar Feb 28 '25 18:02 xuan-cao-swi

@xuan-cao-swi thank you for the contribution! It's clear you put a lot of effort into it.

That said, before we can proceed with code review, we'll need to discuss how exactly we want to go about introducing this new autoinstrumentation to the operator. Could you open an issue and describe how it works? Adding a new instrumentation is a very big change with major implications for the maintainability of this project, and we need to make sure we do it right.

swiatekm avatar Mar 03 '25 12:03 swiatekm

Would it make sense for you to step up as codeowner of those files moving forward to help maintain Ruby auto-instrumentation?

atoulme avatar Mar 12 '25 23:03 atoulme

Would it make sense for you to step up as codeowner of those files moving forward to help maintain Ruby auto-instrumentation?

Yes, I'd like to help maintain the ruby auto-instrumentation.

xuan-cao-swi avatar Mar 13 '25 15:03 xuan-cao-swi

I've added this point to the agenda for today's SIG meeting. Anyone interested is encouraged to join in on the discussion. You can find the calendar here.

swiatekm avatar Mar 13 '25 15:03 swiatekm

Please, add the needed documentation to README.md.

iblancasa avatar Mar 13 '25 16:03 iblancasa

We have a pattern for test e2e-instrumentation apps

Thanks @jaronoff97 , I have the e2e instrumentation test case ready. Once this one get accepted/merged, I will create a follow up PR.

Should we make that change in the ruby auto-inst prior to merging this?

I am still working with otel ruby maintainer to push the script as a new ruby gem.

xuan-cao-swi avatar Mar 25 '25 22:03 xuan-cao-swi

Should we make that change in the ruby auto-inst prior to merging this?

I am still working with otel ruby maintainer to push the script as a new ruby gem.

Did you land the changes @xuan-cao-swi ? That'd help with the injector project.

atoulme avatar Jun 17 '25 20:06 atoulme

We are currently working on the PR to have the autoinstrumentation gem out to replace the autoinstrumention.rb file in this pr

xuan-cao-swi avatar Jun 17 '25 23:06 xuan-cao-swi