Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare gRPC instrumentation donation for release #1261

Open
7 of 11 tasks
kaylareopelle opened this issue Nov 21, 2024 · 6 comments
Open
7 of 11 tasks

Prepare gRPC instrumentation donation for release #1261

kaylareopelle opened this issue Nov 21, 2024 · 6 comments

Comments

@kaylareopelle
Copy link
Contributor

kaylareopelle commented Nov 21, 2024

Overall, the goal is to update the donated gRPC gem to match the other contrib projects' structure and tooling. This will allow us to use our existing CI that runs tests and releases gems with this new instrumentation.

TODOs:

  • Create a gRPC-specific example to replace the Gruf example
  • Move from Standard.rb to Rubocop and Rubocop-Performance to match our other gems
  • Migrate the tests from RSpec to Minitest
  • Add the gRPC gem to the relevant CI workflows (ci-instrumentation.yml)
  • Add the gRPC gem to dependabot.yml
  • Add the gRPC gem to the opentelemetry-instrumentation-all gem
  • Update the README to match our style
  • Update the Changelog for compatibility with toys
  • Update code of conduct to match OTel docs
  • Remove RBS
  • Remove conflicting Code of Conduct file

Relates to the code merged in #1164

@kaylareopelle kaylareopelle changed the title WIP - Get gRPC instrumentation donation ready for release Prepare gRPC instrumentation donation for release Nov 26, 2024
Copy link
Contributor

github-actions bot commented Jan 3, 2025

👋 This issue has been marked as stale because it has been open with no activity. You can: comment on the issue or remove the stale label to hold stale off for a while, add the keep label to hold stale off permanently, or do nothing. If you do nothing this issue will be closed eventually by the stale bot.

@github-actions github-actions bot added the stale Marks an issue/PR stale label Jan 3, 2025
@kaylareopelle kaylareopelle removed the stale Marks an issue/PR stale label Jan 10, 2025
@michal-kazmierczak
Copy link
Contributor

I believe we should now have completed the following tasks:

By the way, I wanted to ask about Update code of conduct to match OTel docs - do instrumentation gems have a separate code of conduct? From what I can see, there is one global file in the root directory. I'm not sure if anything else than removing the conflicting file needs to be done.

@kaylareopelle
Copy link
Contributor Author

Hi @michal-kazmierczak! Thanks for your gRPC example PR! I updated the issue to reflect the remaining TODOs.

By the way, I wanted to ask about Update code of conduct to match OTel docs - do instrumentation gems have a separate code of conduct? From what I can see, there is one global file in the root directory. I'm not sure if anything else than removing the conflicting file needs to be done.

You're right! Removing the conflicting doc is all that was needed.

@michal-kazmierczak
Copy link
Contributor

Thank you for the update @kaylareopelle.

I've now posted another PR, I believe the last one before the release. It addresses the following points:

  • Add the gRPC gem to dependabot.yml
  • Update the README to match our style
  • Update the Changelog for compatibility with toys

Once it gets merged, I'll prepare a PR with the release.

@kaylareopelle
Copy link
Contributor Author

That sounds great, @michal-kazmierczak!

Forgive me if we've talked about this already, but would you be interested in becoming a code owner for the gRPC instrumentation going forward?

By becoming a code owner, you would be added as a reviewer to any PR opened to update the instrumentation/grpc code. We may also tag you directly in issues related to gRPC instrumentation.

The OpenTelemetry Ruby team needs help from end users and other experts in the community to maintain our instrumentation. Your work on the gRPC instrumentation is invaluable, and we'd love to continue working with you.

@michal-kazmierczak
Copy link
Contributor

Forgive me if we've talked about this already, but would you be interested in becoming a code owner for the gRPC instrumentation going forward?

Absolutely! I use gRPC in Ruby in my day-to-day work, and I’d be happy to help maintain and improve the instrumentation.

Please feel free to add me as a code owner - I’d be glad to review PRs and assist with any gRPC-related issues.

Looking forward to continuing to collaborate with the team. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants