Class: Rage::Telemetry::SpanResult

Inherits:
Struct
  • Object
show all
Defined in:
lib/rage/telemetry/telemetry.rb

Overview

Contains the result of a span execution.

Examples:

class MyTelemetryHandler < Rage::Telemetry::Handler
  handle "controller.action.process", with: :monitor_500

  def monitor_500
    result = yield

    if result.error?
      MyObservabilitySDK.notify("500 Error Detected", result.exception)
    end
  end
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#exception ⇒ Exception? (readonly)

Returns The exception raised during the span execution, if any.

Returns:

  • (Exception, nil) —

    The exception raised during the span execution, if any.



127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/rage/telemetry/telemetry.rb', line 127

SpanResult = Struct.new(:exception) do
  # Returns `true` if the span resulted in an error.
  def error?
    !!exception
  end

  # Returns `true` if the span executed successfully.
  def success?
    !error?
  end
end

Instance Method Details

#error? ⇒ Boolean

Returns true if the span resulted in an error.

Returns:

  • (Boolean) 


129
130
131
 
# File 'lib/rage/telemetry/telemetry.rb', line 129

def error?
  !!exception
end

#success? ⇒ Boolean

Returns true if the span executed successfully.

Returns:

  • (Boolean) 


134
135
136
 
# File 'lib/rage/telemetry/telemetry.rb', line 134

def success?
  !error?
end