Module: Sapience

Defined in:
lib/sapience/logger.rb,
lib/sapience/log.rb,
lib/sapience/base.rb,
lib/sapience/grape.rb,
lib/sapience/rails.rb,
lib/sapience/metrics.rb,
lib/sapience/version.rb,
lib/sapience/appender.rb,
lib/sapience/loggable.rb,
lib/sapience/sapience.rb,
lib/sapience/sneakers.rb,
lib/sapience/subscriber.rb,
lib/sapience/ansi_colors.rb,
lib/sapience/descendants.rb,
lib/sapience/log_methods.rb,
lib/sapience/rails/engine.rb,
lib/sapience/config_loader.rb,
lib/sapience/configuration.rb,
lib/sapience/error_handler.rb,
lib/sapience/rails/railtie.rb,
lib/sapience/formatters/raw.rb,
lib/sapience/appender/stream.rb,
lib/sapience/formatters/base.rb,
lib/sapience/formatters/json.rb,
lib/sapience/metrics/datadog.rb,
lib/sapience/appender/wrapper.rb,
lib/sapience/formatters/color.rb,
lib/sapience/formatters/default.rb,
lib/sapience/loggers/concurrent.rb,
lib/sapience/error_handler/sentry.rb,
lib/sapience/error_handler/silent.rb,
lib/sapience/concerns/compatibility.rb,
lib/sapience/extensions/grape/timings.rb,
lib/sapience/extensions/notifications.rb,
lib/sapience/extensions/grape/notifications.rb,
lib/sapience/extensions/active_job/notifications.rb,
lib/sapience/extensions/grape/middleware/logging.rb,
lib/sapience/extensions/action_view/log_subscriber.rb,
lib/sapience/extensions/active_record/model_metrics.rb,
lib/sapience/extensions/active_record/notifications.rb,
lib/sapience/extensions/grape/request_format_helper.rb,
lib/sapience/extensions/active_record/log_subscriber.rb,
lib/sapience/extensions/action_controller/notifications.rb,
lib/sapience/extensions/action_controller/log_subscriber.rb

Overview

:nodoc:

Defined Under Namespace

Modules: AnsiColors, Appender, Concerns, ConfigLoader, Descendants, Extensions, Formatters, LogMethods, Loggable, Loggers, Rails, Sneakers Classes: Base, Configuration, ErrorHandler, Grape, Log, Logger, Metrics, Subscriber

Constant Summary collapse

VERSION = 
"2.5.4"
UnknownClass = 
Class.new(NameError)
AppNameMissing = 
Class.new(NameError)
TestException = 
Class.new(StandardError)
UnkownLogLevel = 
Class.new(StandardError)
InvalidLogExecutor = 
Class.new(StandardError)
MissingConfiguration = 
Class.new(StandardError)
APP_NAME =

Logging levels in order of most detailed to most severe

"APP_NAME"
DEFAULT_ENV = 
"default"
RACK_ENV = 
"RACK_ENV"
RAILS_ENV = 
"RAILS_ENV"
SAPIENCE_ENV = 
"SAPIENCE_ENV"
LEVELS = 
%i[trace debug info warn error fatal].freeze
APPENDER_NAMESPACE = 
Sapience::Appender
METRICS_NAMESPACE = 
Sapience::Metrics
ERROR_HANDLER_NAMESPACE = 
Sapience::ErrorHandler
DEFAULT_STATSD_URL = 
"udp://localhost:8125"
@@configured = 
false

Class Method Summary collapse

Class Method Details

.[](klass) ⇒ Object

Return a logger for the supplied class or class_name



133
134
135
 
# File 'lib/sapience/sapience.rb', line 133

def self.[](klass)
  Sapience::Logger.new(klass)
end

.add_appender(appender_class_name, options = {}, _deprecated_level = nil, &_block) ⇒ Object

Add a new logging appender as a new destination for all log messages emitted from Sapience

Appenders will be written to in the order that they are added

If a block is supplied then it will be used to customize the format of the messages sent to that appender. See Sapience::Logger.new for more information on custom formatters

Parameters

file_name: [String]
  File name to write log messages to.

Or,
io: [IO]
  An IO Stream to log to.
  For example STDOUT, STDERR, etc.

Or,
appender: [Symbol|Sapience::Subscriber]
  A symbol identifying the appender to create.
  For example:
    :bugsnag, :elasticsearch, :graylog, :http, :mongodb, :new_relic, :splunk_http, :syslog, :wrapper
       Or,
  An instance of an appender derived from Sapience::Subscriber
  For example:
    Sapience::Appender::Http.new(url: 'http://localhost:8088/path')

Or,
logger: [Logger|Log4r]
  An instance of a Logger or a Log4r logger.

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

formatter: [Symbol|Object|Proc]
  Any of the following symbol values: :default, :color, :json
    Or,
  An instance of a class that implements #call
    Or,
  A Proc to be used to format the output from this appender
  Default: :default

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.

Examples:

# Send all logging output to Standard Out (Screen)
Sapience.add_appender(:stream, io: STDOUT)

# Send all logging output to a file
Sapience.add_appender(:stream, file_name: 'logfile.log')

# Send all logging output to a file and only :info and above to standard output
Sapience.add_appender(:stream, file_name: 'logfile.log')
Sapience.add_appender(:stream, io: STDOUT, level: :info)

Log to log4r, Logger, etc.:

# Send logging output to an existing logger
require 'logger'
require 'sapience'

# Built-in Ruby logger
log = Logger.new(STDOUT)
log.level = Logger::DEBUG

Sapience.config.default_level = :debug
Sapience.add_appender(:wrapper, logger: log)

logger = Sapience['Example']
logger.info "Hello World"
logger.debug("Login time", user: 'Joe', duration: 100, ip_address: '127.0.0.1')



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/sapience/sapience.rb', line 215

def self.add_appender(appender_class_name, options = {}, _deprecated_level = nil, &_block)
  fail ArgumentError, "options should be a hash" unless options.is_a?(Hash)
  options        = options.dup.deep_symbolize_keyz!
  appender_class = constantize_symbol(appender_class_name)
  validate_appender_class!(appender_class)

  appender = appender_class.new(options)
  warn "appender #{appender} with (#{options.inspect}) is not valid" unless appender.valid?
  @@appenders << appender

  # Start appender thread if it is not already running
  Sapience::Logger.start_appender_thread
  Sapience::Logger.start_invalid_appenders_task
  appender
end

.add_appenders(*appenders) ⇒ Object

Examples:

Sapience.add_appenders(
  { file: { io: STDOUT } },
  { sentry: { dsn: "https://app.getsentry.com/" } },
)



247
248
249
250
251
252
253
 
# File 'lib/sapience/sapience.rb', line 247

def self.add_appenders(*appenders)
  appenders.flatten.compact.each do |appender|
    appender.each do |name, options|
      add_appender(name, options)
    end
  end
end

.app_name ⇒ Object 



109
110
111
112
113
 
# File 'lib/sapience/sapience.rb', line 109

def self.app_name
  config.app_name ||= app_name_builder
  fail AppNameMissing, "app_name is not configured. See documentation for more information" unless config.app_name
  config.app_name
end

.app_name_builder ⇒ Object 



472
473
474
475
476
 
# File 'lib/sapience/sapience.rb', line 472

def self.app_name_builder
  config_hash.fetch(environment) { {} }["app_name"] ||
    config_hash.fetch(DEFAULT_ENV) { {} }["app_name"] ||
    ENV[APP_NAME]
end

.appenders ⇒ Object

Returns [Sapience::Subscriber] a copy of the list of active appenders for debugging etc. Use Sapience.add_appender and Sapience.remove_appender to manipulate the active appenders list



274
275
276
 
# File 'lib/sapience/sapience.rb', line 274

def self.appenders
  @@appenders.clone
end

.capture_exception(exception, payload = {}) ⇒ Object 



294
295
296
 
# File 'lib/sapience/sapience.rb', line 294

def self.capture_exception(exception, payload = {})
  error_handler.capture_exception(exception, payload)
end

.capture_message(message, payload = {}) ⇒ Object 



298
299
300
 
# File 'lib/sapience/sapience.rb', line 298

def self.capture_message(message, payload = {})
  error_handler.capture_message(message, payload)
end

.clear_tags! ⇒ Object 



390
391
392
 
# File 'lib/sapience/sapience.rb', line 390

def self.clear_tags!
  Thread.current[:sapience_tags] = []
end

.close ⇒ Object

Close and flush all appenders



339
340
341
 
# File 'lib/sapience/sapience.rb', line 339

def self.close
  Sapience::Logger.close
end

.config ⇒ Object 



59
60
61
62
63
64
65
 
# File 'lib/sapience/sapience.rb', line 59

def self.config
  @@config ||= begin
    options = config_hash[environment]
    options ||= default_options(config_hash)
    Configuration.new(options)
  end
end

.config_hash ⇒ Object 



55
56
57
 
# File 'lib/sapience/sapience.rb', line 55

def self.config_hash
  @@config_hash ||= ConfigLoader.load_from_file
end

.configure(force: false) {|config| ... } ⇒ Object

Yields:



45
46
47
48
49
50
51
52
53
 
# File 'lib/sapience/sapience.rb', line 45

def self.configure(force: false)
  yield config if block_given?
  return config if configured? && force == false
  reset_appenders!
  add_appenders(*config.appenders)
  @@configured = true

  config
end

.configured? ⇒ Boolean

Returns:

  • (Boolean) 


67
68
69
 
# File 'lib/sapience/sapience.rb', line 67

def self.configured?
  @@configured
end

.constantize(class_name) ⇒ Object 



457
458
459
460
461
462
463
464
465
466
 
# File 'lib/sapience/sapience.rb', line 457

def self.constantize(class_name)
  return class_name unless class_name.is_a?(String)
  if RUBY_VERSION.to_i >= 2
    Object.const_get(class_name)
  else
    class_name.split("::").inject(Object) { |o, name| o.const_get(name) }
  end
rescue NameError
  raise UnknownClass, "Could not find class: #{class_name}."
end

.constantize_symbol(symbol, namespace = APPENDER_NAMESPACE) ⇒ Object 



452
453
454
455
 
# File 'lib/sapience/sapience.rb', line 452

def self.constantize_symbol(symbol, namespace = APPENDER_NAMESPACE)
  class_name = "#{namespace}::#{symbol.to_sym.camelize}"
  constantize(class_name)
end

.create_class(config_section, namespace) ⇒ Object 



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/sapience/sapience.rb', line 302

def self.create_class(config_section, namespace)
  namespace_string = namespace.to_s.split("::").last

  fail MissingConfiguration, "No #{namespace_string} configured" unless config_section
  klass_name = config_section.keys.first
  options    = config_section.values.first

  klass = constantize_symbol(klass_name, namespace)

  if namespace.descendants.include?(klass)
    klass.new(options)
  else
    fail NotImplementedError, "Unknown #{namespace_string} '#{klass_name}'"
  end
end

.default_options(options = {}) ⇒ Object 



71
72
73
74
75
76
 
# File 'lib/sapience/sapience.rb', line 71

def self.default_options(options = {})
  unless environment =~ /default|rspec/
    warn "No configuration for environment #{environment}. Using 'default'"
  end
  options[DEFAULT_ENV]
end

.environment ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/sapience/sapience.rb', line 94

def self.environment
  @@environment ||=
    ENV.fetch(SAPIENCE_ENV) do
      ENV.fetch(RAILS_ENV) do
        ENV.fetch(RACK_ENV) do
          if defined?(::Rails) && ::Rails.respond_to?(:env)
            ::Rails.env
          else
            DEFAULT_ENV
          end
        end
      end
    end
end

.error_handler ⇒ Object 



290
291
292
 
# File 'lib/sapience/sapience.rb', line 290

def self.error_handler
  @@error_handler ||= create_class(config.error_handler, ERROR_HANDLER_NAMESPACE)
end

.error_handler=(error_handler) ⇒ Object 



286
287
288
 
# File 'lib/sapience/sapience.rb', line 286

def self.error_handler=(error_handler)
  @@error_handler = error_handler
end

.fast_tag(tag) ⇒ Object

If the tag being supplied is definitely a string then this fast tag api can be used for short lived tags



355
356
357
358
359
360
 
# File 'lib/sapience/sapience.rb', line 355

def self.fast_tag(tag)
  (Thread.current[:sapience_tags] ||= []) << tag
  yield
ensure
  Thread.current[:sapience_tags].pop
end

.flush ⇒ Object

Wait until all queued log messages have been written and flush all active appenders



334
335
336
 
# File 'lib/sapience/sapience.rb', line 334

def self.flush
  Sapience::Logger.flush
end

.known_appenders ⇒ Object 



238
239
240
 
# File 'lib/sapience/sapience.rb', line 238

def self.known_appenders
  @_known_appenders ||= Sapience::Subscriber.descendants
end

.log_executor_class ⇒ Object 



448
449
450
 
# File 'lib/sapience/sapience.rb', line 448

def self.log_executor_class
  constantize_symbol(config.log_executor, "Concurrent")
end

.logger ⇒ Object 



322
323
324
 
# File 'lib/sapience/sapience.rb', line 322

def self.logger
  @@logger ||= Sapience::Logger.logger
end

.logger=(logger) ⇒ Object 



318
319
320
 
# File 'lib/sapience/sapience.rb', line 318

def self.logger=(logger)
  @@logger = Sapience::Logger.logger = logger
end

.metrics ⇒ Object 



282
283
284
 
# File 'lib/sapience/sapience.rb', line 282

def self.metrics
  @@metrics ||= create_class(config.metrics, METRICS_NAMESPACE)
end

.metrics=(metrics) ⇒ Object 



278
279
280
 
# File 'lib/sapience/sapience.rb', line 278

def self.metrics=(metrics)
  @@metrics = metrics
end

.namify(appname, sep = "_") ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/sapience/sapience.rb', line 115

def self.namify(appname, sep = "_")
  return unless appname.is_a?(String)
  return if appname.empty?

  # Turn unwanted chars into the separator
  appname = appname.dup
  appname.gsub!(/[^a-z0-9\-_]+/i, sep)
  unless sep.nil? || sep.empty?
    re_sep = Regexp.escape(sep)
    # No more than one of the separator in a row.
    appname.gsub!(/#{re_sep}{2,}/, sep)
    # Remove leading/trailing separator.
    appname.gsub!(/^#{re_sep}|#{re_sep}$/, "")
  end
  appname.downcase
end

.pop_tags(quantity = 1) ⇒ Object

Remove specified number of tags from the current tag list



395
396
397
398
399
400
 
# File 'lib/sapience/sapience.rb', line 395

def self.pop_tags(quantity = 1)
  t = Thread.current[:sapience_tags]
  return if t.nil?

  t.pop(quantity)
end

.push_tags(*tags) ⇒ Object

Add tags to the current scope Returns the list of tags pushed after flattening them out and removing blanks



382
383
384
385
386
387
388
 
# File 'lib/sapience/sapience.rb', line 382

def self.push_tags(*tags)
  # Need to flatten and reject empties to support calls from Rails 4
  new_tags                       = tags.flatten.collect(&:to_s).reject(&:empty?)
  t                              = Thread.current[:sapience_tags]
  Thread.current[:sapience_tags] = t.nil? ? new_tags : t.concat(new_tags)
  new_tags
end

.remove_appender(appender) ⇒ Object

Remove an existing appender Currently only supports appender instances TODO: Make it possible to remove appenders by type Maybe create a concurrent collection that allows this by inheriting from concurrent array.



259
260
261
 
# File 'lib/sapience/sapience.rb', line 259

def self.remove_appender(appender)
  @@appenders.delete(appender)
end

.remove_appenders(appenders = @@appenders) ⇒ Object

Remove specific appenders or all existing



264
265
266
267
268
 
# File 'lib/sapience/sapience.rb', line 264

def self.remove_appenders(appenders = @@appenders)
  appenders.each do |appender|
    remove_appender(appender)
  end
end

.reopen ⇒ Object

After forking an active process call Sapience.reopen to re-open any open file handles etc to resources

Note: Only appenders that implement the reopen method will be called



347
348
349
350
351
 
# File 'lib/sapience/sapience.rb', line 347

def self.reopen
  @@appenders.each { |appender| appender.reopen if appender.respond_to?(:reopen) }
  # After a fork the appender thread is not running, start it if it is not running
  Sapience::Logger.start_appender_thread
end

.reset! ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/sapience/sapience.rb', line 78

def self.reset!
  @@config        = nil
  @@logger        = nil
  @@metrics       = nil
  @@error_handler = nil
  @@environment   = nil
  @@configured    = false
  @@config_hash   = nil
  clear_tags!
  reset_appenders!
end

.reset_appenders! ⇒ Object 



90
91
92
 
# File 'lib/sapience/sapience.rb', line 90

def self.reset_appenders!
  @@appenders = Concurrent::Array.new
end

.root ⇒ Object 



468
469
470
 
# File 'lib/sapience/sapience.rb', line 468

def self.root
  @_root ||= Gem::Specification.find_by_name("sapience").gem_dir
end

.silence(new_level = :error) ⇒ Object

Silence noisy log levels by changing the default_level within the block

This setting is thread-safe and only applies to the current thread

Any threads spawned within the block will not be affected by this setting

#silence can be used to both raise and lower the log level within the supplied block.

Example:

# Perform trace level logging within the block when the default is higher
Sapience.config.default_level = :info

logger.debug 'this will _not_ be logged'

Sapience.silence(:trace) do
  logger.debug "this will be logged"
end

Parameters

new_level
  The new log level to apply within the block
  Default: :error

Example:

# Silence all logging for this thread below :error level
Sapience.silence do
  logger.info "this will _not_ be logged"
  logger.warn "this neither"
  logger.error "but errors will be logged"
end

Note:

#silence does not affect any loggers which have had their log level set
explicitly. I.e. That do not rely on the global default level



438
439
440
441
442
443
444
 
# File 'lib/sapience/sapience.rb', line 438

def self.silence(new_level = :error)
  current_index                     = Thread.current[:sapience_silence]
  Thread.current[:sapience_silence] = Sapience.config.level_to_index(new_level)
  yield
ensure
  Thread.current[:sapience_silence] = current_index
end

.tagged(*tags) ⇒ Object

Add the supplied tags to the list of tags to log for this thread whilst the supplied block is active. Returns result of block



365
366
367
368
369
370
 
# File 'lib/sapience/sapience.rb', line 365

def self.tagged(*tags)
  new_tags = push_tags(*tags)
  yield self
ensure
  pop_tags(new_tags.size)
end

.tags ⇒ Object

Returns a copy of the [Array] of [String] tags currently active for this thread Returns nil if no tags are set



374
375
376
377
378
 
# File 'lib/sapience/sapience.rb', line 374

def self.tags
  # Since tags are stored on a per thread basis this list is thread-safe
  t = Thread.current[:sapience_tags]
  t.nil? ? [] : t.clone
end

.test_exception(_level = :error) ⇒ Object 



326
327
328
329
330
 
# File 'lib/sapience/sapience.rb', line 326

def self.test_exception(_level = :error)
  fail Sapience::TestException, "Sapience Test Exception"
rescue Sapience::TestException => ex
  Sapience.capture_exception(ex,  test_exception: true)
end

.validate_appender_class!(appender_class) ⇒ Object 



231
232
233
234
235
236
 
# File 'lib/sapience/sapience.rb', line 231

def self.validate_appender_class!(appender_class)
  return if known_appenders.include?(appender_class)

  fail NotImplementedError,
    "Unknown appender '#{appender_class}'. Supported appenders are (#{known_appenders.join(", ")})"
end