Guide to Updating Instrumentation

Thanks for your interest in updating the New Relic Ruby agent instrumentation! Your involvement will help ensure that the Ruby agent keeps up with the newest versions of the gems you love.

Whether you've grabbed an existing help wanted issue/good first issue relating to updating instrumentation or submitted your own, here are the steps to follow to address it.

1. Run our multiverse integration test suite locally to see what changes, if any, need to be made to support a new version of your gem. Just add the new version of the gem whose instrumentation you're updating to the envfile for the multiverse suite for that gem. Then, test your changes using rake:test multiverse[name_of_suite].
   Note: Depending on the multiverse suite you're working on, you may need some of the following services running locally: memcached, mongodb, mysql, rabbitmq, redis.
2. If you see any multiverse failures for the new environment you added to the envfile, they'll guide you to the updates that need to be made in our instrumentation to support the new gem version.
3. Open a pull request with your changes and link to the relevant issue. Your PR will then run against our entire continuous integration matrix. If you see any failing checks on your PR, please address those. If you need help or have questions, go ahead and start a discussion on your PR.
4. Once it's ready, we agent engineers will review your pull request and express our gratitude for your contribution!