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/version.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/rails/engine.rb,
lib/sapience/config_loader.rb,
lib/sapience/configuration.rb,
lib/sapience/rails/railtie.rb,
lib/sapience/formatters/raw.rb,
lib/sapience/appender/sentry.rb,
lib/sapience/appender/stream.rb,
lib/sapience/formatters/base.rb,
lib/sapience/formatters/json.rb,
lib/sapience/appender/datadog.rb,
lib/sapience/appender/wrapper.rb,
lib/sapience/formatters/color.rb,
lib/sapience/formatters/default.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/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, Loggable, Rails, Sneakers Classes: Base, Configuration, Grape, Log, Logger, Subscriber

Constant Summary collapse

VERSION = 
"1.0.12"
UnknownClass = 
Class.new(NameError)
AppNameMissing = 
Class.new(NameError)
TestException = 
Class.new(StandardError)
LEVELS =

Logging levels in order of most detailed to most severe

[:trace, :debug, :info, :warn, :error, :fatal].freeze
APP_NAME = 
"APP_NAME".freeze
DEFAULT_ENV = 
"default".freeze
RACK_ENV = 
"RACK_ENV".freeze
RAILS_ENV = 
"RAILS_ENV".freeze
SAPIENCE_ENV = 
"SAPIENCE_ENV".freeze
UnkownLogLevel = 
Class.new(StandardError)
InvalidLogExecutor = 
Class.new(StandardError)
@@configured = 
false

Class Method Summary collapse

Class Method Details

.[](klass) ⇒ Object

Return a logger for the supplied class or class_name



130
131
132
 
# File 'lib/sapience/sapience.rb', line 130

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

.add_appender(appender, 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')



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

def self.add_appender(appender, options = {}, _deprecated_level = nil, &_block) # rubocop:disable AbcSize
  fail ArgumentError, "options should be a hash" unless options.is_a?(Hash)
  options = options.dup.deep_symbolize_keyz!
  appender_class = constantize_symbol(appender)
  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
  Sapience.logger = appender if appender.is_a?(Sapience::Appender::Stream)
  Sapience.metrics = appender if appender.is_a?(Sapience::Appender::Datadog)
  appender
end

.add_appenders(*appenders) ⇒ Object

Examples:

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



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

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 



103
104
105
106
107
108
109
110
 
# File 'lib/sapience/sapience.rb', line 103

def self.app_name
  @@app_name ||= config.app_name
  @@app_name ||= config_hash.fetch(environment) { {} }["app_name"]
  @@app_name ||= config_hash.fetch(DEFAULT_ENV) { {} }["app_name"]
  @@app_name ||= ENV[APP_NAME]
  fail AppNameMissing, "app_name is not configured. See documentation for more information" unless @@app_name
  @@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



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

def self.appenders
  @@appenders.clone
end

.clear_tags! ⇒ Object 



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

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

.close ⇒ Object

Close and flush all appenders



306
307
308
 
# File 'lib/sapience/sapience.rb', line 306

def self.close
  Sapience::Logger.close
end

.config ⇒ Object 



51
52
53
54
55
56
57
 
# File 'lib/sapience/sapience.rb', line 51

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

.config_hash ⇒ Object 



47
48
49
 
# File 'lib/sapience/sapience.rb', line 47

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

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

Yields:



37
38
39
40
41
42
43
44
45
 
# File 'lib/sapience/sapience.rb', line 37

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) 


59
60
61
 
# File 'lib/sapience/sapience.rb', line 59

def self.configured?
  @@configured
end

.constantize(class_name) ⇒ Object 



422
423
424
425
426
427
428
429
430
431
 
# File 'lib/sapience/sapience.rb', line 422

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) } # rubocop:disable SingleLineBlockParams
  end
rescue NameError
  raise UnknownClass, "Could not find class: #{class_name}."
end

.constantize_symbol(symbol, namespace = "Sapience::Appender") ⇒ Object 



417
418
419
420
 
# File 'lib/sapience/sapience.rb', line 417

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

.default_options(options = {}) ⇒ Object 



63
64
65
66
67
68
 
# File 'lib/sapience/sapience.rb', line 63

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

.environment ⇒ Object

TODO: Default to SAPIENCE_ENV (if present it should be returned first)



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/sapience/sapience.rb', line 87

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
            warn "Sapience is going to use default configuration"
            DEFAULT_ENV
          end
        end
      end
    end
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



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

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



301
302
303
 
# File 'lib/sapience/sapience.rb', line 301

def self.flush
  Sapience::Logger.flush
end

.known_appenders ⇒ Object 



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

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

.log_executor_class ⇒ Object 



413
414
415
 
# File 'lib/sapience/sapience.rb', line 413

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

.logger ⇒ Object 



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

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

.logger=(logger) ⇒ Object 



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

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

.metrics ⇒ Object 



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

def self.metrics
  @@metrics ||= add_appender(:datadog)
end

.metrics=(metrics) ⇒ Object 



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

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

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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/sapience/sapience.rb', line 112

def self.namify(appname, sep = "_")
  return unless appname.is_a?(String)
  return unless appname.length > 0

  # 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



362
363
364
365
 
# File 'lib/sapience/sapience.rb', line 362

def self.pop_tags(quantity = 1)
  t = Thread.current[:sapience_tags]
  t.pop(quantity) unless t.nil?
end

.push_tags(*tags) ⇒ Object

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



349
350
351
352
353
354
355
 
# File 'lib/sapience/sapience.rb', line 349

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.



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

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

.remove_appenders(appenders = @@appenders) ⇒ Object

Remove specific appenders or all existing



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

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



314
315
316
317
318
 
# File 'lib/sapience/sapience.rb', line 314

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 



70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/sapience/sapience.rb', line 70

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

.reset_appenders! ⇒ Object 



82
83
84
 
# File 'lib/sapience/sapience.rb', line 82

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

.root ⇒ Object 



433
434
435
 
# File 'lib/sapience/sapience.rb', line 433

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



403
404
405
406
407
408
409
 
# File 'lib/sapience/sapience.rb', line 403

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



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

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



341
342
343
344
345
 
# File 'lib/sapience/sapience.rb', line 341

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 



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

def self.test_exception(level = :error)
  fail Sapience::TestException, "Sapience Test Exception"
rescue Sapience::TestException => ex
  Sapience[self].public_send(level, ex)
end

.validate_appender_class!(appender_class) ⇒ Object 



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

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