Class: InfluxDB::Rails::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/influxdb/rails/configuration.rb

Constant Summary collapse

DEFAULTS =
{
  :influxdb_host => "localhost",
  :influxdb_port => 8086,
  :ignored_exceptions => %w{ActiveRecord::RecordNotFound
                            ActionController::RoutingError},
  :ignored_exception_messages => [],
  :ignored_reports => [],
  :ignored_environments => %w{test cucumber selenium},
  :ignored_user_agents => %w{GoogleBot},
  :environment_variable_filters => [
    /password/i,
    /key/i,
    /secret/i,
    /ps1/i,
    /rvm_.*_clr/i,
    /color/i
  ],
  :backtrace_filters => [
    lambda { |line| line.gsub(/^\.\//, "") },
    lambda { |line|
      return line if InfluxDB::Rails.configuration.application_root.to_s.empty?
      line.gsub(/#{InfluxDB::Rails.configuration.application_root}/, "[APP_ROOT]")
    },
    lambda { |line|
      if defined?(Gem) && !Gem.path.nil? && !Gem.path.empty?
        Gem.path.each { |path| line = line.gsub(/#{path}/, "[GEM_ROOT]") }
      end
      line
    }
  ]
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeConfiguration

Returns a new instance of Configuration.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/influxdb/rails/configuration.rb', line 62

def initialize
  @influxdb_host = DEFAULTS[:influxdb_host]
  @influxdb_port = DEFAULTS[:influxdb_port]
  @ignored_exceptions = DEFAULTS[:ignored_exceptions].dup
  @ignored_exception_messages = DEFAULTS[:ignored_exception_messages].dup
  @ignored_reports = DEFAULTS[:ignored_reports].dup
  @ignored_environments = DEFAULTS[:ignored_environments].dup
  @ignored_user_agents = DEFAULTS[:ignored_user_agents].dup
  @backtrace_filters = DEFAULTS[:backtrace_filters].dup
  @environment_variable_filters = DEFAULTS[:environment_variable_filters]
  @aggregated_exception_classes = []
  @debug = false
  @rescue_global_exceptions = false
  @instrumentation_enabled = true
end

Instance Attribute Details

#aggregated_exception_classesObject

Returns the value of attribute aggregated_exception_classes.



22
23
24
# File 'lib/influxdb/rails/configuration.rb', line 22

def aggregated_exception_classes
  @aggregated_exception_classes
end

#application_idObject

Returns the value of attribute application_id.



6
7
8
# File 'lib/influxdb/rails/configuration.rb', line 6

def application_id
  @application_id
end

#application_nameObject

Returns the value of attribute application_name.



7
8
9
# File 'lib/influxdb/rails/configuration.rb', line 7

def application_name
  @application_name
end

#application_rootObject

Returns the value of attribute application_root.



8
9
10
# File 'lib/influxdb/rails/configuration.rb', line 8

def application_root
  @application_root
end

#backtrace_filtersObject

Returns the value of attribute backtrace_filters.



21
22
23
# File 'lib/influxdb/rails/configuration.rb', line 21

def backtrace_filters
  @backtrace_filters
end

#debugObject

Returns the value of attribute debug.



27
28
29
# File 'lib/influxdb/rails/configuration.rb', line 27

def debug
  @debug
end

#environmentObject

Returns the value of attribute environment.



11
12
13
# File 'lib/influxdb/rails/configuration.rb', line 11

def environment
  @environment
end

#environment_variable_filtersObject

Returns the value of attribute environment_variable_filters.



24
25
26
# File 'lib/influxdb/rails/configuration.rb', line 24

def environment_variable_filters
  @environment_variable_filters
end

#environment_variablesObject

Returns the value of attribute environment_variables.



23
24
25
# File 'lib/influxdb/rails/configuration.rb', line 23

def environment_variables
  @environment_variables
end

#frameworkObject

Returns the value of attribute framework.



12
13
14
# File 'lib/influxdb/rails/configuration.rb', line 12

def framework
  @framework
end

#framework_versionObject

Returns the value of attribute framework_version.



13
14
15
# File 'lib/influxdb/rails/configuration.rb', line 13

def framework_version
  @framework_version
end

#ignored_environmentsObject

Returns the value of attribute ignored_environments.



19
20
21
# File 'lib/influxdb/rails/configuration.rb', line 19

def ignored_environments
  @ignored_environments
end

#ignored_exception_messagesObject

Returns the value of attribute ignored_exception_messages.



17
18
19
# File 'lib/influxdb/rails/configuration.rb', line 17

def ignored_exception_messages
  @ignored_exception_messages
end

#ignored_exceptionsObject

Returns the value of attribute ignored_exceptions.



16
17
18
# File 'lib/influxdb/rails/configuration.rb', line 16

def ignored_exceptions
  @ignored_exceptions
end

#ignored_reportsObject

Returns the value of attribute ignored_reports.



18
19
20
# File 'lib/influxdb/rails/configuration.rb', line 18

def ignored_reports
  @ignored_reports
end

#ignored_user_agentsObject

Returns the value of attribute ignored_user_agents.



20
21
22
# File 'lib/influxdb/rails/configuration.rb', line 20

def ignored_user_agents
  @ignored_user_agents
end

#influxdb_hostObject

Returns the value of attribute influxdb_host.



4
5
6
# File 'lib/influxdb/rails/configuration.rb', line 4

def influxdb_host
  @influxdb_host
end

#influxdb_portObject

Returns the value of attribute influxdb_port.



5
6
7
# File 'lib/influxdb/rails/configuration.rb', line 5

def influxdb_port
  @influxdb_port
end

#instrumentation_enabledObject

Returns the value of attribute instrumentation_enabled.



26
27
28
# File 'lib/influxdb/rails/configuration.rb', line 26

def instrumentation_enabled
  @instrumentation_enabled
end

#languageObject

Returns the value of attribute language.



14
15
16
# File 'lib/influxdb/rails/configuration.rb', line 14

def language
  @language
end

#language_versionObject

Returns the value of attribute language_version.



15
16
17
# File 'lib/influxdb/rails/configuration.rb', line 15

def language_version
  @language_version
end

#loggerObject

Returns the value of attribute logger.



10
11
12
# File 'lib/influxdb/rails/configuration.rb', line 10

def logger
  @logger
end

#reraise_global_exceptionsObject

Returns the value of attribute reraise_global_exceptions.



28
29
30
# File 'lib/influxdb/rails/configuration.rb', line 28

def reraise_global_exceptions
  @reraise_global_exceptions
end

Instance Method Details

#add_custom_exception_data(exception_presenter) ⇒ Object



103
104
105
# File 'lib/influxdb/rails/configuration.rb', line 103

def add_custom_exception_data(exception_presenter)
  @custom_exception_data_handler.call(exception_presenter) if @custom_exception_data_handler
end

#database_nameObject



107
108
109
# File 'lib/influxdb/rails/configuration.rb', line 107

def database_name
  @application_id.to_s + @environment.to_s
end

#debug?Boolean

Returns:

  • (Boolean)


78
79
80
# File 'lib/influxdb/rails/configuration.rb', line 78

def debug?
  !!@debug
end

#define_custom_exception_data(&block) ⇒ Object



99
100
101
# File 'lib/influxdb/rails/configuration.rb', line 99

def define_custom_exception_data(&block)
  @custom_exception_data_handler = block
end

#ignore_current_environment?Boolean

Returns:

  • (Boolean)


95
96
97
# File 'lib/influxdb/rails/configuration.rb', line 95

def ignore_current_environment?
  self.ignored_environments.include?(self.environment)
end

#ignore_user_agent?(incoming_user_agent) ⇒ Boolean

Returns:

  • (Boolean)


90
91
92
93
# File 'lib/influxdb/rails/configuration.rb', line 90

def ignore_user_agent?(incoming_user_agent)
  return false if self.ignored_user_agents.nil?
  self.ignored_user_agents.any? {|agent| incoming_user_agent =~ /#{agent}/}
end

#instrumentation_enabled?Boolean

Returns:

  • (Boolean)


82
83
84
# File 'lib/influxdb/rails/configuration.rb', line 82

def instrumentation_enabled?
  !!@instrumentation_enabled
end

#reraise_global_exceptions?Boolean

Returns:

  • (Boolean)


86
87
88
# File 'lib/influxdb/rails/configuration.rb', line 86

def reraise_global_exceptions?
  !!@reraise_global_exceptions
end