Class: Chronos::Agent

Inherits:
Object
  • Object
show all
Defined in:
lib/chronos/agent.rb

Overview

Runtime composition root for the framework-independent Chronos agent.

Examples:

agent.notify(RuntimeError.new("failed"))

Constant Summary collapse

DEFAULT_FLUSH_TIMEOUT = 
5.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config, options = {}) ⇒ Agent

Returns a new instance of Agent.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/chronos/agent.rb', line 19

def initialize(config, options = {})
  @config = config
  @logger = options[:logger] || Internal::SafeLogger.new(config.logger)
  @context_store = options[:context_store] || build_context_store(config.context_store)
  unless Ports::ContextStore.compatible?(@context_store)
    raise ArgumentError, "context store does not implement the Chronos context-store port"
  end
  @transport = options[:transport] || Adapters::NetHttpTransport.new(config, @logger)
  unless Ports::Transport.compatible?(@transport)
    raise ArgumentError, "transport does not implement the Chronos transport port"
  end
  pipeline_options = {}
  pipeline_options[:queue] = options[:queue] if options[:queue]
  pipeline_options[:worker_pool] = options[:worker_pool] if options[:worker_pool]
  @delivery_pipeline = options[:delivery_pipeline] || Application::DeliveryPipeline.new(
    config,
    @transport,
    @logger,
    pipeline_options
  )
  @capture = options[:capture] || Application::CaptureException.new(config, @delivery_pipeline, @logger)
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



17
18
19
 
# File 'lib/chronos/agent.rb', line 17

def config
  @config
end

Instance Method Details

#add_breadcrumb(attributes = {}) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/chronos/agent.rb', line 54

def add_breadcrumb(attributes = {})
  context = @context_store.get
  buffer = context[:__chronos_breadcrumbs]
  buffer ||= Core::BreadcrumbBuffer.new(@config.breadcrumb_capacity, @config.breadcrumb_max_bytes)
  buffer.add(attributes)
  @context_store.set(context.merge(:__chronos_breadcrumbs => buffer))
  true
rescue StandardError => error
  @logger.warn("Chronos breadcrumb failed: #{error.class}")
  false
end

#close(timeout = DEFAULT_FLUSH_TIMEOUT) ⇒ Object 



73
74
75
76
77
78
 
# File 'lib/chronos/agent.rb', line 73

def close(timeout = DEFAULT_FLUSH_TIMEOUT)
  @delivery_pipeline.close(timeout)
rescue StandardError => error
  @logger.warn("Chronos close failed: #{error.class}")
  false
end

#diagnostics ⇒ Object 



80
81
82
83
 
# File 'lib/chronos/agent.rb', line 80

def diagnostics
  details = @delivery_pipeline.diagnostics
  details[:queue].merge(details)
end

#flush(timeout = DEFAULT_FLUSH_TIMEOUT) ⇒ Object 



66
67
68
69
70
71
 
# File 'lib/chronos/agent.rb', line 66

def flush(timeout = DEFAULT_FLUSH_TIMEOUT)
  @delivery_pipeline.flush(timeout)
rescue StandardError => error
  @logger.warn("Chronos flush failed: #{error.class}")
  false
end

#notify(exception, context = {}) ⇒ Object 



42
43
44
 
# File 'lib/chronos/agent.rb', line 42

def notify(exception, context = {})
  @capture.call(exception, context_for_capture(context))
end

#notify_sync(exception, context = {}) ⇒ Object 



46
47
48
 
# File 'lib/chronos/agent.rb', line 46

def notify_sync(exception, context = {})
  @capture.call_sync(exception, context_for_capture(context))
end

#with_context(context = {}, &block) ⇒ Object 



50
51
52
 
# File 'lib/chronos/agent.rb', line 50

def with_context(context = {}, &block)
  @context_store.with_context(context, &block)
end