File: dispatcher.rb

package info (click to toggle)
ruby-dry-logger 1.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 156 kB
  • sloc: ruby: 802; makefile: 4
file content (308 lines) | stat: -rw-r--r-- 7,850 bytes parent folder | download | duplicates (2)
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# frozen_string_literal: true

require "logger"
require "pathname"

require "dry/logger/constants"
require "dry/logger/backends/proxy"
require "dry/logger/entry"

module Dry
  module Logger
    # Logger dispatcher routes log entries to configured logging backends
    #
    # @since 1.0.0
    # @api public
    class Dispatcher
      # @since 1.0.0
      # @api private
      attr_reader :id

      # (EXPERIMENTAL) Shared payload context
      #
      # @example
      #   logger.context[:component] = "test"
      #
      #   logger.info "Hello World"
      #   # Hello World component=test
      #
      # @since 1.0.0
      # @api public
      attr_reader :context

      # @since 1.0.0
      # @api private
      attr_reader :backends

      # @since 1.0.0
      # @api private
      attr_reader :options

      # @since 1.0.0
      # @api private
      attr_reader :clock

      # @since 1.0.0
      # @api private
      attr_reader :on_crash

      # @since 1.0.0
      # @api private
      attr_reader :mutex

      # @since 1.0.0
      # @api private
      CRASH_LOGGER = ::Logger.new($stdout).tap { |logger|
        logger.formatter = -> (_, _, _, message) { "#{message}#{NEW_LINE}" }
        logger.level = FATAL
      }.freeze

      # @since 1.0.0
      # @api private
      ON_CRASH = -> (progname:, exception:, message:, payload:) {
        CRASH_LOGGER.fatal(Logger.templates[:crash] % {
          severity: "FATAL",
          progname: progname,
          time: Time.now,
          log_entry: [message, payload].map(&:to_s).reject(&:empty?).join(SEPARATOR),
          exception: exception.class,
          message: exception.message,
          backtrace: TAB + exception.backtrace.join(NEW_LINE + TAB)
        })
      }

      # Set up a dispatcher
      #
      # @since 1.0.0
      # @api private
      #
      # @return [Dispatcher]
      def self.setup(id, **options)
        dispatcher = new(id, **DEFAULT_OPTS, **options)
        yield(dispatcher) if block_given?
        dispatcher.add_backend if dispatcher.backends.empty?
        dispatcher
      end

      # @since 1.0.0
      # @api private
      def self.default_context
        Thread.current[:__dry_logger__] ||= {}
      end

      # @since 1.0.0
      # @api private
      def initialize(
        id, backends: [], tags: [], context: self.class.default_context, **options
      )
        @id = id
        @backends = backends
        @options = {**options, progname: id}
        @mutex = Mutex.new
        @context = context
        @tags = tags
        @clock = Clock.new(**(options[:clock] || EMPTY_HASH))
        @on_crash = options[:on_crash] || ON_CRASH
      end

      # Log an entry with UNKNOWN severity
      #
      # @see Dispatcher#log
      # @api public
      # @return [true]
      def unknown(message = nil, **payload, &block)
        log(:unknown, message, **payload, &block)
      end

      # Log an entry with DEBUG severity
      #
      # @see Dispatcher#log
      # @api public
      # @return [true]
      def debug(message = nil, **payload, &block)
        log(:debug, message, **payload, &block)
      end

      # Log an entry with INFO severity
      #
      # @see Dispatcher#log
      # @api public
      # @return [true]
      def info(message = nil, **payload, &block)
        log(:info, message, **payload, &block)
      end

      # Log an entry with WARN severity
      #
      # @see Dispatcher#log
      # @api public
      # @return [true]
      def warn(message = nil, **payload, &block)
        log(:warn, message, **payload, &block)
      end

      # Log an entry with ERROR severity
      #
      # @see Dispatcher#log
      # @api public
      # @return [true]
      def error(message = nil, **payload, &block)
        log(:error, message, **payload, &block)
      end

      # Log an entry with FATAL severity
      #
      # @see Dispatcher#log
      # @api public
      # @return [true]
      def fatal(message = nil, **payload, &block)
        log(:fatal, message, **payload, &block)
      end

      BACKEND_METHODS.each do |name|
        define_method(name) do
          forward(name)
        end
      end

      # Return severity level
      #
      # @since 1.0.0
      # @return [Integer]
      # @api public
      def level
        LEVELS[options[:level]]
      end

      # Pass logging to all configured backends
      #
      # @example logging a message
      #   logger.log(:info, "Hello World")
      #
      # @example logging a message by passing a block
      #   logger.log(:debug, "Sidecar") { "Hello World" }
      #
      # @example logging payload
      #   logger.log(:info, verb: "GET", path: "/users")
      #
      # @example logging message and payload
      #   logger.log(:info, "User index request", verb: "GET", path: "/users")
      #
      # @example logging exception
      #   begin
      #     # things that may raise
      #   rescue => e
      #     logger.log(:error, e)
      #     raise e
      #   end
      #
      # @param [Symbol] severity The log severity name
      # @param [String] message Optional message
      # @param [Hash] payload Optional log entry payload
      # @yield
      # @yieldreturn [String] Message to be logged
      #
      # @since 1.0.0
      # @return [true]
      # @api public
      def log(severity, message = nil, **payload, &block)
        case message
        when Hash then log(severity, **message, &block)
        else
          if block
            progname = message
            message = block.call
          end
          progname ||= id

          entry = Entry.new(
            clock: clock,
            progname: progname,
            severity: severity,
            tags: @tags,
            message: message,
            payload: {**context, **payload}
          )

          each_backend do |backend|
            backend.__send__(severity, entry) if backend.log?(entry)
          rescue StandardError => e
            on_crash.(progname: id, exception: e, message: message, payload: payload)
          end
        end

        true
      rescue StandardError => e
        on_crash.(progname: id, exception: e, message: message, payload: payload)
        true
      end

      # (EXPERIMENTAL) Tagged logging withing the provided block
      #
      # @example
      #   logger.tagged("red") do
      #     logger.info "Hello World"
      #     # Hello World tag=red
      #   end
      #
      #   logger.info "Hello Again"
      #   # Hello Again
      #
      # @since 1.0.0
      # @api public
      def tagged(*tags)
        @tags.concat(tags)
        yield
      ensure
        @tags = []
      end

      # Add a new backend to an existing dispatcher
      #
      # @example
      #   logger.add_backend(template: "ERROR: %<message>s") { |b|
      #     b.log_if = -> entry { entry.error? }
      #   }
      #
      # @since 1.0.0
      # @return [Dispatcher]
      # @api public
      def add_backend(instance = nil, **backend_options)
        backend =
          case (instance ||= Dry::Logger.new(**options, **backend_options))
          when Backends::Stream then instance
          else Backends::Proxy.new(instance, **options, **backend_options)
          end

        yield(backend) if block_given?

        backends << backend
        self
      end

      # @since 1.0.0
      # @api public
      def inspect
        %(#<#{self.class} id=#{id} options=#{options} backends=#{backends}>)
      end

      # @since 1.0.0
      # @api private
      def each_backend(&block)
        mutex.synchronize do
          backends.each(&block)
        end
      end

      # Pass logging to all configured backends
      #
      # @since 1.0.0
      # @return [true]
      # @api private
      def forward(meth, ...)
        each_backend { |backend| backend.public_send(meth, ...) }
        true
      end
    end
  end
end