Skip to content

Commit

Permalink
chore: Update docs about default span status (#1416)
Browse files Browse the repository at this point in the history
chore: Update docs about default span status (#1416)

In the SDK, this defaults to unset https://github.com/open-telemetry/opentelemetry-ruby/blob/48eb8367c2eee15cc59d4f83ee137a9b931695fc/sdk/lib/opentelemetry/sdk/trace/span.rb#L19. In spec, it also notes that default is unset: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#set-status.

I don't think  span status matters in the context of an API span, but this might reduce the chance of confusion.
  • Loading branch information
plantfansam authored Jan 11, 2023
1 parent 48eb836 commit 6623a3e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion api/lib/opentelemetry/trace/span.rb
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ def record_exception(exception, attributes: nil); end

# Sets the Status to the Span
#
# If used, this will override the default Span status. Default is OK.
# If used, this will override the default Span status. Default status is unset.
#
# Only the value of the last call will be recorded, and implementations
# are free to ignore previous calls.
Expand Down

0 comments on commit 6623a3e

Please sign in to comment.