1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
# frozen_string_literal: true
require "dry/logger/global"
require "dry/logger/constants"
require "dry/logger/clock"
require "dry/logger/dispatcher"
require "dry/logger/formatters/string"
require "dry/logger/formatters/rack"
require "dry/logger/formatters/json"
require "dry/logger/backends/io"
require "dry/logger/backends/file"
module Dry
# Set up a logger dispatcher
#
# @example Basic $stdout string logger
# logger = Dry.Logger(:my_app)
#
# logger.info("Hello World!")
# # Hello World!
#
# @example Customized $stdout string logger
# logger = Dry.Logger(:my_app, template: "[%<severity>][%<time>s] %<message>s")
#
# logger.info("Hello World!")
# # [INFO][2022-11-06 10:55:12 +0100] Hello World!
#
# logger.info(Hello: "World!")
# # [INFO][2022-11-06 10:55:14 +0100] Hello="World!"
#
# logger.warn("Ooops!")
# # [WARN][2022-11-06 10:55:57 +0100] Ooops!
#
# logger.error("Gaaah!")
# # [ERROR][2022-11-06 10:55:57 +0100] Gaaah!
#
# @example Basic $stdout JSON logger
# logger = Dry.Logger(:my_app, formatter: :json)
#
# logger.info(Hello: "World!")
# # {"progname":"my_app","severity":"INFO","time":"2022-11-06T10:11:29Z","Hello":"World!"}
#
# @example Setting up multiple backends
# logger = Dry.Logger(:my_app)
# add_backend(formatter: :string, template: :details)
# add_backend(formatter: :string, template: :details)
#
# @example Setting up conditional logging
# logger = Dry.Logger(:my_app) { |setup|
# setup.add_backend(formatter: :string, template: :details) { |b| b.log_if = :error?.to_proc }
# }
#
# @param [String, Symbol] id The dispatcher id, can be used as progname in log entries
# @param [Hash] options Options for backends and formatters
# @option options [Symbol] :level (:info) The minimum level that should be logged,
# @option options [Symbol] :stream (optional) The output stream, default is $stdout
# @option options [Symbol, Class, #call] :formatter (:string) The default formatter or its id,
# @option options [String, Symbol] :template (:default) The default template that should be used
# @option options [Boolean] :colorize (false) Enable/disable colorized severity
# @option options [Hash<Symbol=>Symbol>] :severity_colors ({}) A severity=>color mapping
# @option options [#call] :on_crash (Dry::Logger::Dispatcher::ON_CRASH) A crash-handling proc.
# This is used whenever logging crashes.
#
# @since 1.0.0
# @api public
# @return [Dispatcher]
def self.Logger(id, **options, &block)
Logger::Dispatcher.setup(id, **options, &block)
end
module Logger
extend Global
# Built-in formatters
register_formatter(:string, Formatters::String)
register_formatter(:rack, Formatters::Rack)
register_formatter(:json, Formatters::JSON)
# Built-in templates
register_template(:default, "%<message>s %<payload>s")
register_template(:details, "[%<progname>s] [%<severity>s] [%<time>s] %<message>s %<payload>s")
register_template(:crash, <<~STR)
[%<progname>s] [%<severity>s] [%<time>s] Logging crashed
%<log_entry>s
%<message>s (%<exception>s)
%<backtrace>s
STR
register_template(:rack, <<~STR)
[%<progname>s] [%<severity>s] [%<time>s] \
%<verb>s %<status>s %<elapsed>s %<ip>s %<path>s %<length>s %<payload>s
%<params>s
STR
end
end
|
