Deprecate log; add log_kv #23
Merged
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
Closed
indrekj
reviewed
Feb 21, 2018
lib/opentracing/span.rb
Outdated
| @@ -40,11 +40,20 @@ def get_baggage_item(key) | |||
| nil | |||
| end | |||
|
|
|||
| # ** Deprecated ** | |||
There was a problem hiding this comment.
should be @deprecated with a reason. See http://www.rubydoc.info/gems/yard/file/docs/Tags.md#deprecated
indrekj
reviewed
Feb 21, 2018
| @@ -40,11 +40,20 @@ def get_baggage_item(key) | |||
| nil | |||
| end | |||
|
|
|||
| # ** Deprecated ** | |||
| # Add a log entry to this span | |||
| # @param event [String] event name for the log | |||
| # @param timestamp [Time] time of the log | |||
| # @param fields [Hash] Additional information to log | |||
| def log(event: nil, timestamp: Time.now, **fields) | |||
There was a problem hiding this comment.
Why don't we remove event: nil and not create a new log_kv method? Are we planning to use log for something else? I think this should also be explained in the commit message.
There was a problem hiding this comment.
@indrekj Thanks for the feedback. Added reasons for the method name replacement in the code and commit message.
1. event is an optional log fields defined the the spec, not required 2. be consistent with other OT implementations such as Python and Go
Merged
iredelmeier
added a commit
to lightstep/lightstep-tracer-ruby
that referenced
this pull request
Nov 6, 2018
In 0.4.0, opentracing-ruby deprecated Span#log in favour if Span#log_kv (opentracing/opentracing-ruby#23). (Closes #72)
iredelmeier
added a commit
to lightstep/lightstep-tracer-ruby
that referenced
this pull request
Nov 6, 2018
In 0.4.0, opentracing-ruby deprecated Span#log in favour if Span#log_kv (opentracing/opentracing-ruby#23). (Closes #72)
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.
PR for issue #22
@itsderek23 @mwear I moved the
assert_warnmethod totest_helperfor sharing. There is a structured_warnings gem with more support warning methods. I don't think we need the gem for now but I can include it in the PR if that makes sense.