Skip to content

Commit

Permalink
docs: Describe Tracer#in_span arguments (open-telemetry#1474)
Browse files Browse the repository at this point in the history
These descriptions are based on the comments in the
OpenTelemetry::SDK::Trace::SpanData struct
  • Loading branch information
kaylareopelle authored Jun 27, 2023
1 parent 848c512 commit 1159ec0
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions api/lib/opentelemetry/trace/tracer.rb
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@ class Tracer
# On exit, the Span that was active before calling this method will be reactivated. If an
# exception occurs during the execution of the provided block, it will be recorded on the
# span and reraised.
#
# @param name [String] the name of the span
# @param attributes [optional Hash] attributes to attach to the span {String => String,
# Numeric, Boolean, Array<String, Numeric, Boolean>}
# @param links [optional Array] an array of OpenTelemetry::Trace::Link instances
# @param start_timestamp [optional Integer] nanoseconds since Epoch
# @param kind [optional Symbol] One of :internal, :server, :client, :producer, :consumer
#
# @yield [span, context] yields the newly created span and a context containing the
# span to the block.
def in_span(name, attributes: nil, links: nil, start_timestamp: nil, kind: nil, &block)
Expand Down

0 comments on commit 1159ec0

Please sign in to comment.