meineerde/rackstash
1
0
Fork 0
mirror of https://github.com/meineerde/rackstash.git synced 2026-02-01 01:37:12 +00:00
Code Issues Releases Activity

Improve code documentation for Logger

Browse Source
This commit is contained in:
Holger Just 2017-07-20 00:20:23 +02:00
parent 4e1f6af273
commit 33ee63bffb
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
lib/rackstash/logger.rb
View File

@ -23,9 +23,10 @@ module Rackstash
# Logging formatter, a `Proc`-like object which take four arguments and
# returns the formatted message. The arguments are:
#
# * `severity` - The Severity of the log message.
# * `severity` - The severity of the log message as a String.
# * `time` - A Time instance representing when the message was logged.
# * `progname` - The progname configured passed to the logger method.
# * `progname` - The progname passed to the logger method (or the default
# {#progname}).
# * `msg` - The `Object` the user passed to the log message; not necessarily
# a String.
#
@ -35,8 +36,9 @@ module Rackstash
# @return [#call] the log formatter for each individual buffered line
attr_accessor :formatter
# @return [Integer] a numeric log level, normally you'd use one of the
# `SEVERITIES` constants, i.e. an integer between 0 and 5.
# @return [Integer] a numeric log level. Normally you'd use one of the
# `SEVERITIES` constants, i.e., an integer between 0 and 5. We will only
# log messages with a severity above the configured level.
attr_reader :level
# @return [String] the logger's progname, used as the default for log