class MetricsService

duration(name, duration, **additional_properties) click to toggle source

Given a name and a duration, tracks the milliseconds involved in processing the operation. Outputs `OpDurationMs`

@param [String] name A name for filtering within WHERE queries @param [Time] start The start time of the operation @param [Time] end The end time of the operation

# File lib/metrics_service.rb, line 56
def self.duration(name, duration, **additional_properties)
  properties = { name: name, duration: duration.in_milliseconds }.merge(additional_properties)
  ::NewRelic::Agent.record_custom_event('OpDurationMs', properties)
rescue StandardError => e
  LOGGER.error("Failed reporting duration to NewRelic: #{e}")
end

duration_start_end(name, start, finish, **additional_properties) click to toggle source

Given a name and a start/finish time, tracks the milliseconds involved in processing the operation. Outputs `OpDurationMs`

@param [String] name A name for filtering within WHERE queries @param [Time] start The start time of the operation @param [Time] end The end time of the operation

# File lib/metrics_service.rb, line 44
def self.duration_start_end(name, start, finish, **additional_properties)
  duration(name, (finish - start).seconds, **additional_properties)
rescue StandardError => e
  LOGGER.error("Failed reporting duration to NewRelic: #{e}")
end

error(name, **additional_properties) click to toggle source

Tracks an error for error reporting with arbitrary additional named argument properties. Outputs `Error`

@param [String] name A name for filtering within WHERE queries

# File lib/metrics_service.rb, line 76
def self.error(name, **additional_properties)
  properties = { error_name: name }.merge(additional_properties)
  ::NewRelic::Agent.record_custom_event('Error', properties)
rescue StandardError => e
  LOGGER.error("Failed reporting error to NewRelic: #{e}")
end

event(name, **additional_properties) click to toggle source

Track a basic event; intended for COUNT queries. Outputs `TrackedEvent`

@param [String] name A name for filtering within WHERE queries

# File lib/metrics_service.rb, line 20
def self.event(name, **additional_properties)
  properties = { name: name }.merge(additional_properties)
  ::NewRelic::Agent.record_custom_event('TrackedEvent', properties)
end

exception(name, exception, **additional_properties) click to toggle source

Tracks an exception for error reporting when errors are suppressable for the purpose of HTTP status codes. Outputs `Error`

@param [String] name A name for filtering within WHERE queries

# File lib/metrics_service.rb, line 67
def self.exception(name, exception, **additional_properties)
  properties = { type: exception.class.name, message: exception&.message }.merge(additional_properties)
  error(name, **properties)
end

initialize_logger(new_logger) click to toggle source

Initializes the global logger for this metrics service

# File lib/metrics_service.rb, line 12
def self.initialize_logger(new_logger)
  self.logger = new_logger
end

time_operation(name, **additional_properties) { || ... } click to toggle source

Given a name and a block, tracks the milliseconds involved in processing the operation. Outputs `OpDurationMs`

@param [String] name A name for filtering within WHERE queries

# File lib/metrics_service.rb, line 29
def self.time_operation(name, **additional_properties)
  raise 'A block is required for time_operation calls' unless block_given?

  start = Time.current
  result = yield
  duration_start_end(name, start, Time.current, **additional_properties)
  result
end

Attributes

Public Class Methods