class NewRelic::EnvironmentReport

The EnvironmentReport is responsible for analyzing the application's environment and generating the data for the Environment Report in New Relic's interface.

It contains useful system information like Ruby version, OS, loaded gems, etc.

Additional logic can be registered by using the ::report_on hook.

Attributes

data[R]

end reporting logic

Public Class Methods

new() click to toggle source

Generate the report based on the class level logic.

# File lib/new_relic/environment_report.rb, line 95
def initialize
  @data = self.class.registered_reporters.inject(Hash.new) do |data, (key, logic)|
    begin
      value = logic.call
      if value
        data[key] = value

        Agent.record_metric("Supportability/EnvironmentReport/success", 0.0)
        Agent.record_metric("Supportability/EnvironmentReport/success/#{key}", 0.0)
      else
        Agent.logger.debug("EnvironmentReport ignoring value for #{key.inspect} which came back falsey: #{value.inspect}")
        Agent.record_metric("Supportability/EnvironmentReport/empty", 0.0)
        Agent.record_metric("Supportability/EnvironmentReport/empty/#{key}", 0.0)
      end
    rescue => e
      Agent.logger.debug("EnvironmentReport failed to retrieve value for #{key.inspect}: #{e}")
      Agent.record_metric("Supportability/EnvironmentReport/error", 0.0)
      Agent.record_metric("Supportability/EnvironmentReport/error/#{key}", 0.0)
    end
    data
  end
end
registered_reporters() click to toggle source
# File lib/new_relic/environment_report.rb, line 34
def self.registered_reporters
  @registered_reporters ||= Hash.new
end
registered_reporters=(logic) click to toggle source

allow the logic to be swapped out in tests

# File lib/new_relic/environment_report.rb, line 39
def self.registered_reporters=(logic)
  @registered_reporters = logic
end
report_on(key, &block) click to toggle source

This is the main interface for registering logic that should be included in the Environment Report. For example:

::report_on “Day of week” do

Time.now.strftime("%A")

end

The passed blocks will be run in EnvironmentReport instances on initialize.

Errors raised in passed blocks will be handled and logged at debug, so it is safe to report on things that may not work in certain environments.

The blocks should only return strings or arrays full of strings. Falsey values will be ignored.

# File lib/new_relic/environment_report.rb, line 30
def self.report_on(key, &block)
  registered_reporters[key] = block
end

Public Instance Methods

[](key) click to toggle source
# File lib/new_relic/environment_report.rb, line 118
def [](key)
  @data[key]
end
[]=(key, value) click to toggle source
# File lib/new_relic/environment_report.rb, line 122
def []=(key, value)
  @data[key] = value
end
to_a() click to toggle source
# File lib/new_relic/environment_report.rb, line 126
def to_a
  @data.to_a
end