Class: Appdash::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/appdash/client.rb

Constant Summary collapse

DEFAULTS =

Client defaults

{
  host: 'localhost',
  port: 7701,
  max_buffer_size: 1,
}.freeze

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ Client

Initializes a new client

Parameters:

  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :host (String) —

    the hostname, defaults to localhost

  • :port (Integer) —

    the port, defaults to 7701

  • :max_buffer_size (Integer) —

    number of spans in the buffer before flushing, defaults to 1 (= no buffering)



19
20
21
22
23
24
 
# File 'lib/appdash/client.rb', line 19

def initialize(opts = {})
  @config = DEFAULTS.merge(opts)
  @sock   = TCPSocket.new @config[:host], @config[:port]
  @buffer = []
  @mutex  = Mutex.new
end

Instance Method Details

#shutdown ⇒ Object

Shutdown flushes any remaining buffered packets and closes the connection



54
55
56
57
 
# File 'lib/appdash/client.rb', line 54

def shutdown
  flush_buffer!
  @sock.shutdown
end

#span(&block) ⇒ Object

Traces a new span with a series of associated events. Accepts an optional block. If no block is given you must flush to send data to the collector.

Examples:

manual flush


span = client.span
span.name "Request"
span.message "A simple message"
span.flush

with block


client.span do |span|
  span.name "Request"
  span.message "A simple message"
end



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/appdash/client.rb', line 42

def span(&block)
  span = Appdash::Span.new(self)
  return span unless block

  begin
    block.call(span)
  ensure
    span.flush
  end
end