Module: Metrics

Defined in:
lib/metrics.rb,
lib/metrics/handler.rb,
lib/metrics/railtie.rb,
lib/metrics/grouping.rb,
lib/metrics/instrumenter.rb,
lib/metrics/configuration.rb,
lib/metrics/instrumentable.rb,
lib/metrics/middleware_helpers.rb

Defined Under Namespace

Modules: Drivers, Helpers, Instrumentable, MiddlewareHelpers Classes: Configuration, Grouping, Handler, Instrumenter, Railtie

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object 



78
79
80
 
# File 'lib/metrics.rb', line 78

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Yields:



82
83
84
 
# File 'lib/metrics.rb', line 82

def configure
  yield configuration
end

.group(namespace = nil, options = {}, &block) ⇒ Object

Public: Group multiple instruments.

Example

Metrics.group 'sidekiq' do |group|
  group.instrument 'request.time' do
    begin
      @app.call(env)
    rescue Exception => e
      instrument 'exceptions', 1
      raise
    end
  end
end

Returns nothing.



69
70
71
72
 
# File 'lib/metrics.rb', line 69

def group(namespace = nil, options = {}, &block)
  instrumenters = Grouping.instrument(namespace, &block)
  Handler.handle(*instrumenters)
end

.instrument(*args, &block) ⇒ Object

Public: Instrument a metric.

Example

# Instrument the duration of an event.
Metrics.instrument 'rack.request' do
  @app.call(env)
end

# Instrument a specific value.
Metrics.instrument 'workers.busy', 10, units: 'workers'

# Instrument something with a specific source.
Metrics.instrument 'sidekiq.queue', source: 'background' do
  yield
end

Returns nothing.



49
50
51
 
# File 'lib/metrics.rb', line 49

def instrument(*args, &block)
  Handler.handle(Instrumenter.instrument(*args, &block))
end

.subscribe ⇒ Object 



74
75
76
 
# File 'lib/metrics.rb', line 74

def subscribe
  $stderr.puts "Metrics#subscribe is deprecated and will be removed in 1.0."
end