Class: OpenTelemetry::Instrumentation::RSpec::Formatter
- Inherits:
-
Object
- Object
- OpenTelemetry::Instrumentation::RSpec::Formatter
- Defined in:
- lib/opentelemetry/instrumentation/rspec/formatter.rb
Overview
An RSpec Formatter that outputs Otel spans
Instance Attribute Summary collapse
-
#output ⇒ Object
readonly
Returns the value of attribute output.
Class Method Summary collapse
Instance Method Summary collapse
- #current_timestamp ⇒ Object
- #example_finished(notification) ⇒ Object
- #example_group_finished(notification) ⇒ Object
- #example_group_started(notification) ⇒ Object
- #example_started(notification) ⇒ Object
-
#initialize(output = StringIO.new, tracer_provider = OpenTelemetry.tracer_provider) ⇒ Formatter
constructor
A new instance of Formatter.
- #pop_and_finalize_span {|span| ... } ⇒ Object
- #start(notification) ⇒ Object
- #stop(notification) ⇒ Object
- #tracer ⇒ Object
- #track_span(span) ⇒ Object
Constructor Details
#initialize(output = StringIO.new, tracer_provider = OpenTelemetry.tracer_provider) ⇒ Formatter
Returns a new instance of Formatter.
25 26 27 28 29 |
# File 'lib/opentelemetry/instrumentation/rspec/formatter.rb', line 25 def initialize(output = StringIO.new, tracer_provider = OpenTelemetry.tracer_provider) @spans_and_tokens = [] @output = output @tracer_provider = tracer_provider end |
Instance Attribute Details
#output ⇒ Object (readonly)
Returns the value of attribute output.
15 16 17 |
# File 'lib/opentelemetry/instrumentation/rspec/formatter.rb', line 15 def output @output end |
Class Method Details
.current_timestamp ⇒ Object
21 22 23 |
# File 'lib/opentelemetry/instrumentation/rspec/formatter.rb', line 21 def self. @clock.call end |
Instance Method Details
#current_timestamp ⇒ Object
35 36 37 |
# File 'lib/opentelemetry/instrumentation/rspec/formatter.rb', line 35 def self.class. end |
#example_finished(notification) ⇒ Object
69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/opentelemetry/instrumentation/rspec/formatter.rb', line 69 def example_finished(notification) pop_and_finalize_span do |span| result = notification.example.execution_result span.set_attribute('rspec.example.result', result.status.to_s) if (exception = result.exception) span.record_exception(exception) span.set_attribute('rspec.example.failure_message', exception.) if exception.is_a? ::RSpec::Expectations::ExpectationNotMetError span.status = OpenTelemetry::Trace::Status.error(exception.) end end end |
#example_group_finished(notification) ⇒ Object
54 55 56 |
# File 'lib/opentelemetry/instrumentation/rspec/formatter.rb', line 54 def example_group_finished(notification) pop_and_finalize_span end |
#example_group_started(notification) ⇒ Object
48 49 50 51 52 |
# File 'lib/opentelemetry/instrumentation/rspec/formatter.rb', line 48 def example_group_started(notification) description = notification.group.description span = tracer.start_span(description, start_timestamp: ) track_span(span) end |
#example_started(notification) ⇒ Object
58 59 60 61 62 63 64 65 66 67 |
# File 'lib/opentelemetry/instrumentation/rspec/formatter.rb', line 58 def example_started(notification) example = notification.example attributes = { 'rspec.example.location' => example.location.to_s, 'rspec.example.full_description' => example.full_description.to_s, 'rspec.example.described_class' => example.[:described_class].to_s } span = tracer.start_span(example.description, attributes: attributes, start_timestamp: ) track_span(span) end |
#pop_and_finalize_span {|span| ... } ⇒ Object
90 91 92 93 94 95 96 97 98 |
# File 'lib/opentelemetry/instrumentation/rspec/formatter.rb', line 90 def pop_and_finalize_span span, token = *@spans_and_tokens.shift return unless span.recording? yield span if block_given? span.finish(end_timestamp: ) OpenTelemetry::Context.detach(token) end |
#start(notification) ⇒ Object
39 40 41 42 |
# File 'lib/opentelemetry/instrumentation/rspec/formatter.rb', line 39 def start(notification) span = tracer.start_span('RSpec suite', start_timestamp: ) track_span(span) end |
#stop(notification) ⇒ Object
44 45 46 |
# File 'lib/opentelemetry/instrumentation/rspec/formatter.rb', line 44 def stop(notification) pop_and_finalize_span end |
#tracer ⇒ Object
31 32 33 |
# File 'lib/opentelemetry/instrumentation/rspec/formatter.rb', line 31 def tracer @tracer ||= @tracer_provider.tracer('OpenTelemetry::Instrumentation::RSpec', OpenTelemetry::Instrumentation::RSpec::VERSION) end |
#track_span(span) ⇒ Object
83 84 85 86 87 88 |
# File 'lib/opentelemetry/instrumentation/rspec/formatter.rb', line 83 def track_span(span) token = OpenTelemetry::Context.attach( OpenTelemetry::Trace.context_with_span(span) ) @spans_and_tokens.unshift([span, token]) end |