Class: TIMEx::Telemetry::Adapters::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/timex/telemetry/adapters.rb

Overview

No-op base type documenting the adapter protocol.

Instance Method Summary collapse

Instance Method Details

#emit(event:, payload:) ⇒ void

This method returns an undefined value.

Default one-shot implementation pairing #start and #finish.

Parameters:

  • event (Symbol, String)
  • payload (Hash{Symbol => Object}) 


30
31
32
33
 
# File 'lib/timex/telemetry/adapters.rb', line 30

def emit(event:, payload:)
  start(event:, payload:)
  finish(event:, payload:)
end

#finish(event:, payload:) ⇒ void

This method returns an undefined value.

Parameters:

  • event (Symbol, String)
  • payload (Hash{Symbol => Object}) 


23
 
# File 'lib/timex/telemetry/adapters.rb', line 23

def finish(event:, payload:); end

#start(event:, payload:) ⇒ void

This method returns an undefined value.

Parameters:

  • event (Symbol, String)
  • payload (Hash{Symbol => Object}) 


18
 
# File 'lib/timex/telemetry/adapters.rb', line 18

def start(event:, payload:); end