Bring ruby manual instrumentation docs up to par with rest of languages #1994
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
svrnm
approved these changes
Nov 14, 2022
ahayworth
approved these changes
Nov 16, 2022
There was a problem hiding this comment.
Overall it looks pretty good, and I'm going to 👍 it. I left some comments but none of them are technically blocking:
- A lot of little style nits: indentation, stuff with parens, etc
- At least one actual syntax error (although I don't truly think that's a Big Problem given that it's just an example in the docs)
- Some comments about the
in_spanhelper we provide and whether or not it should be mentioned alongside the more manual ways to do things.
Please feel free to take or leave them! ❤️
Co-authored-by: Andrew Hayworth <ahayworth@gmail.com>
|
Thanks @ahayworth for the thorough review - I've addressed everything and will merge. Will also follow up on the linked issue I filed around explaining |
|
Sounds good to me! 😄 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ready for review!
Preview link: https://deploy-preview-1994--opentelemetry.netlify.app/docs/instrumentation/ruby/manual/
App I used to validate things: https://github.com/cartermp/otel-lang-samples/blob/main/ruby/app/app/controllers/app_controller.rb (sent traces to honeycomb)
Remaining: