Class: LogBrew::RackMiddleware

Inherits:
Object
  • Object
show all
Includes:
TraceRackMiddlewareMethods
Defined in:
lib/logbrew.rb

Overview

Rack-compatible middleware for Rails, Sinatra, and other Rack-based Ruby apps.

The middleware captures completed requests as span events and unhandled app exceptions as issue plus error-span events. It does not require the rack or rails gems at runtime; any app object that responds to call(env) is enough.

Constant Summary collapse

DEFAULT_EVENT_ID_PREFIX = 
"ruby_rack"
DEFAULT_SPAN_LOGGER = 
"rack"

Instance Method Summary collapse

Constructor Details

#initialize(app, client:, transport: nil, flush_on_response: false, event_id_prefix: DEFAULT_EVENT_ID_PREFIX, metadata: nil, timestamp_provider: nil, include_exception_message: true, include_exception_backtrace: false, on_error: nil, raise_errors: false) ⇒ RackMiddleware

Returns a new instance of RackMiddleware.

Raises:



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/logbrew.rb', line 372

def initialize(
  app,
  client:,
  transport: nil,
  flush_on_response: false,
  event_id_prefix: DEFAULT_EVENT_ID_PREFIX,
  metadata: nil,
  timestamp_provider: nil,
  include_exception_message: true,
  include_exception_backtrace: false,
  on_error: nil,
  raise_errors: false
)
  raise SdkError.new("validation_error", "rack app must respond to call") unless app.respond_to?(:call)
  Validation.require_non_empty("event id prefix", event_id_prefix)
  raise SdkError.new("validation_error", "metadata must be an object") unless metadata.nil? || metadata.is_a?(Hash)

  @app = app
  @client = client
  @transport = transport
  @flush_on_response = flush_on_response
  @event_id_prefix = event_id_prefix
  @metadata = metadata || {}
  @timestamp_provider = timestamp_provider
  @include_exception_message = include_exception_message
  @include_exception_backtrace = include_exception_backtrace
  @on_error = on_error
  @raise_errors = raise_errors
  @next_event_number = 0
  @event_id_mutex = Mutex.new
end

Instance Method Details

#call(env) ⇒ Object 



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/logbrew.rb', line 404

def call(env)
  started_at = monotonic_time
  begin
    response = @app.call(env)
  rescue StandardError => error
    status_code = exception_status_code(error)
    safely_capture do
      capture_exception_issue(env, error) if status_code >= 500
      capture_request_span(env, status_code, duration_ms(started_at), status_code >= 500 ? "error" : "ok")
      flush_if_configured
    end
    raise
  end

  status_code = rack_status(response)
  safely_capture do
    capture_request_span(env, status_code, duration_ms(started_at), status_code >= 500 ? "error" : "ok")
    flush_if_configured
  end
  response
end