Class: SemanticLogger::Appender::NewRelic

Inherits:
Base
  • Object
show all
Defined in:
lib/semantic_logger/appender/new_relic.rb

Overview

Send log messages to NewRelic

The :error and :fatal log entries will show up under “Applications” > “Application Name” > “Events” > “Errors” in New Relic.

Example:

SemanticLogger.add_appender(SemanticLogger::Appender::NewRelic.new)

Instance Attribute Summary

Attributes inherited from Base

#formatter

Attributes inherited from Base

#filter, #name

Instance Method Summary collapse

Methods inherited from Base

colorized_formatter, #flush, json_formatter, #level

Methods inherited from Base

#benchmark, default_level, default_level=, #fast_tag, #level, #level=, #payload, #pop_tags, #push_tags, #silence, #tagged, #tags, #with_payload

Constructor Details

#initialize(options = {}, &block) ⇒ NewRelic

Create Appender

Parameters

level: [:trace | :debug | :info | :warn | :error | :fatal]
  Override the log level for this appender.
  Default: :error

filter: [Regexp|Proc]
  RegExp: Only include log messages where the class name matches the supplied.
  regular expression. All other messages will be ignored.
  Proc: Only include log messages where the supplied Proc returns true
        The Proc must return true or false.



28
29
30
31
32
33
34
35
36
 
# File 'lib/semantic_logger/appender/new_relic.rb', line 28

def initialize(options = {}, &block)
  # Backward compatibility
  options  = {level: options} unless options.is_a?(Hash)
  @options = options.dup
  level    = @options.delete(:level) || :error
  filter   = @options.delete(:filter)

  super(level, filter, &block)
end

Instance Method Details

#default_formatter ⇒ Object

Returns [Hash] of parameters to send to New Relic.



39
40
41
42
43
44
45
46
 
# File 'lib/semantic_logger/appender/new_relic.rb', line 39

def default_formatter
  Proc.new do |log, logger|
    h = log.to_h
    h.delete(:time)
    h.delete(:exception)
    {metric: log.metric, custom_params: h}
  end
end

#log(log) ⇒ Object

Send an error notification to New Relic



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/semantic_logger/appender/new_relic.rb', line 49

def log(log)
  # Ensure minimum log level is met, and check filter
  return false if (level_index > (log.level_index || 0)) || !include_message?(log)

  # Send error messages as Runtime exceptions
  exception =
    if log.exception
      log.exception
    else
      error = RuntimeError.new(log.message)
      error.set_backtrace(log.backtrace) if log.backtrace
      error
    end
  # For more documentation on the NewRelic::Agent.notice_error method see:
  # http://rubydoc.info/github/newrelic/rpm/NewRelic/Agent#notice_error-instance_method
  # and https://docs.newrelic.com/docs/ruby/ruby-agent-api
  NewRelic::Agent.notice_error(exception, formatter.call(log, self))
  true
end