mirror of
https://github.com/meineerde/rackstash.git
synced 2025-12-28 18:29:37 +00:00
Holger Just
c4f0b9cdeb
During normal operation, the Flows will rescue all exceptions and log them to the special error_flow. By default, we will write JSON logs to STDERR. The log location and format can either be change globally by setting (or changing) the Rackstash.error_flow or for each Flow for a Logger individually by setting Flow#error_flow.
126 lines
3.5 KiB
Ruby
126 lines
3.5 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
# Copyright 2017 Holger Just
|
|
#
|
|
# This software may be modified and distributed under the terms
|
|
# of the MIT license. See the LICENSE.txt file for details.
|
|
|
|
require 'set'
|
|
|
|
require 'rackstash/version'
|
|
|
|
module Rackstash
|
|
SEVERITIES = [
|
|
DEBUG = 0,
|
|
INFO = 1,
|
|
WARN = 2,
|
|
ERROR = 3,
|
|
FATAL = 4,
|
|
UNKNOWN = 5
|
|
].freeze
|
|
|
|
SEVERITY_NAMES = {
|
|
'debug' => DEBUG,
|
|
'info' => INFO,
|
|
'warn' => WARN,
|
|
'error' => ERROR,
|
|
'fatal' => FATAL,
|
|
'unknown' => UNKNOWN
|
|
}.freeze
|
|
|
|
SEVERITY_LABELS = [
|
|
'DEBUG'.freeze,
|
|
'INFO'.freeze,
|
|
'WARN'.freeze,
|
|
'ERROR'.freeze,
|
|
'FATAL'.freeze,
|
|
'ANY'.freeze
|
|
].freeze
|
|
|
|
PROGNAME = "rackstash/v#{Rackstash::VERSION}".freeze
|
|
|
|
# A class for the {UNDEFINED} object. Generally, there will only be exactly
|
|
# one object of this class.
|
|
#
|
|
# The {UNDEFINED} object can be used as the default value for method arguments
|
|
# to distinguish it from `nil`. See https://holgerjust.de/2016/detecting-default-arguments-in-ruby/#special-default-value
|
|
# for details.
|
|
class UndefinedClass
|
|
# @return [Boolean] `true` iff `other` is the exact same object as `self`
|
|
def ==(other)
|
|
self.equal?(other)
|
|
end
|
|
alias === ==
|
|
alias eql? ==
|
|
|
|
# @return [String] the string `"undefined"`
|
|
def to_s
|
|
'undefined'.freeze
|
|
end
|
|
alias inspect to_s
|
|
end
|
|
|
|
UNDEFINED = UndefinedClass.new
|
|
|
|
EMPTY_STRING = ''.freeze
|
|
EMPTY_SET = Set.new.freeze
|
|
|
|
# How many decimal places to render on ISO 8601 timestamps
|
|
ISO8601_PRECISION = 6
|
|
|
|
FIELD_MESSAGE = 'message'.freeze
|
|
FIELD_TAGS = 'tags'.freeze
|
|
FIELD_TIMESTAMP = '@timestamp'.freeze
|
|
FIELD_VERSION = '@version'.freeze
|
|
|
|
FIELD_ERROR = 'error'.freeze
|
|
FIELD_ERROR_MESSAGE = 'error_message'.freeze
|
|
FIELD_ERROR_TRACE = 'error_trace'.freeze
|
|
|
|
def self.severity_label(severity)
|
|
if severity.is_a?(Integer)
|
|
return SEVERITY_LABELS.last if severity < 0
|
|
SEVERITY_LABELS[severity] || SEVERITY_LABELS.last
|
|
else
|
|
severity = SEVERITY_NAMES.fetch(severity.to_s.downcase, UNKNOWN)
|
|
SEVERITY_LABELS[severity]
|
|
end
|
|
end
|
|
|
|
# Returns a {Flow} which is used by the normal logger {Flow}s to write details
|
|
# about any unexpected errors during interaction with their {Adapters}.
|
|
#
|
|
# By default, this Flow logs JSON-formatted messages to `STDERR`
|
|
#
|
|
# @return [Rackstash::Flow] the default error flow
|
|
def self.error_flow
|
|
@error_flow ||= Rackstash::Flow.new(STDERR)
|
|
end
|
|
|
|
# Set a {Flow} which is used bythe normal logger {Flow}s to write details
|
|
# of any unexpected errors during interaction with their {Adapters}.
|
|
#
|
|
# You can set a different `error_flow` for each {Flow} if required. You can
|
|
# also change this flow to match your desired fallback format and log adapter.
|
|
#
|
|
# To still work in the face of unexpected availability issues like a full
|
|
# filesystem, an unavailable network, broken external loggers, or any other
|
|
# external issues, it is usually desireable to chose a local and mostly
|
|
# relibable log target.
|
|
#
|
|
# @param flow [Flow, Adapters::Adapter, Object] a single {Flow} or an object
|
|
# which can be used as a {Flow}'s adapter. See {Flow#initialize}.
|
|
# @return [Rackstash::Flow] the given `flow`
|
|
def self.error_flow=(flow)
|
|
flow = Flow.new(flow) unless flow.is_a?(Rackstash::Flow)
|
|
@error_flow = flow
|
|
end
|
|
end
|
|
|
|
require 'rackstash/logger'
|
|
|
|
require 'rackstash/adapters/callable'
|
|
require 'rackstash/adapters/file'
|
|
require 'rackstash/adapters/io'
|
|
require 'rackstash/adapters/null'
|