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

Roll the dice for ruby #2655

Merged
merged 11 commits into from
May 10, 2023
Merged

Conversation

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See inline comments, thanks.

content/en/docs/instrumentation/ruby/exporters.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/ruby/exporters.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/ruby/exporters.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/ruby/exporters.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/ruby/exporters.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/ruby/getting-started.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/ruby/getting-started.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/ruby/getting-started.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/ruby/getting-started.md Outdated Show resolved Hide resolved
static/refcache.json Outdated Show resolved Hide resolved
@svrnm
Copy link
Member Author

svrnm commented May 5, 2023

@chalin thanks for reviewing! I addressed all of your comments, anything else or are we good to merge?:-)

lifecycle. For Rails applications, the usual way to initialize OpenTelemetry is
in a Rails initializer. For other Ruby services, perform this initialization as
early as possible in the start-up process.
lifecycle. Perform this initialization as early as possible in the start-up
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My only hesitation here is that the majority of our contributors, maintainers, and support requests are specifically around using OTel with Ruby On Rails.

I suspect removing references to initializing Rails applications vs using Sinatra will increase our support requests for documentation from our user base.

I would like to keep the reference to Rails initializers in the documentation in addition to the Sinatra example.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would agree with this. While it's generally good to be as neutral as possible, I think we should keep mentioning Rails specifically because it's just so prominent in the world of Ruby.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I initially wanted to build the sample app with rails but Sinatra appeared to be easier and less steps involved. I think there are 2 options:

  • Replace sinatra with Rails
  • Add a "Note" for the rails specific initalizers

I can do both, I lean towards the first, although it is a little bit more work

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think in most cases folks will be retrofitting into existing Rails apps, which is one reason our original docs where intended to be copy/paste modify and we didn't build an entire sample app.

Of course if you have the bandwidth to put that together it will be most welcome.

I do realize that the goal here is to have a symmetric example, so I think the Sinatra app is pretty good. I really appreciate you adding this example in the docs. Thank you for doing that!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll try to retrofit it into rails, let me see how far I get :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so... I reworked it and it's now rails, please give it another look, hope the things I did make sense, ruby is not a language I am fluent in ;-)

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haven't stepped through it but LGTM ... pending the issue raised by @arielvalentin.

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See inline for comments. Otherwise LGTM

content/en/docs/instrumentation/ruby/getting-started.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/ruby/getting-started.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/ruby/getting-started.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/ruby/getting-started.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/ruby/getting-started.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/ruby/getting-started.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/ruby/getting-started.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/ruby/exporters.md Outdated Show resolved Hide resolved
Copy link
Contributor

@arielvalentin arielvalentin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assuming @chalin comments are addressed. Thank you for doing this!

@svrnm
Copy link
Member Author

svrnm commented May 8, 2023

thanks for the additional review, @chalin

@svrnm svrnm closed this May 8, 2023
@svrnm svrnm reopened this May 8, 2023
@chalin
Copy link
Contributor

chalin commented May 8, 2023

@cartermp - this good to go from your p.o.v.?

@svrnm
Copy link
Member Author

svrnm commented May 9, 2023

@arielvalentin & @open-telemetry/ruby-approvers: please take another look :-)

@svrnm
Copy link
Member Author

svrnm commented May 10, 2023

Just saw that you already did a review & approval @arielvalentin, thank you very much!

@svrnm svrnm merged commit 1c65eb5 into open-telemetry:main May 10, 2023
@svrnm svrnm deleted the roll-the-dice-for-ruby branch May 11, 2023 08:02
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

Successfully merging this pull request may close these issues.

5 participants