Module: Ougai::Logging

Includes:
Severity
Included in:
ChildLogger, Logger
Defined in:
lib/ougai/logging.rb

Overview

Common Logging features

Defined Under Namespace

Modules: Severity

Constant Summary

Constants included from Severity

Severity::SEV_LABEL, Severity::TRACE

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Severity

#from_label, #to_label

Instance Attribute Details

#before_log=(value) ⇒ Object (writeonly)

Sets the attribute before_log

Parameters:

  • value —

    the value to set the attribute before_log to.



7
8
9
 
# File 'lib/ougai/logging.rb', line 7

def before_log=(value)
  @before_log = value
end

#with_fields ⇒ Object

Returns the value of attribute with_fields.



6
7
8
 
# File 'lib/ougai/logging.rb', line 6

def with_fields
  @with_fields
end

Instance Method Details

#_log(severity, *args) ⇒ Object 



100
101
102
103
104
 
# File 'lib/ougai/logging.rb', line 100

def _log(severity, *args)
  severity ||= UNKNOWN
  return true if level > severity
  append(severity, block_given? ? yield : args)
end

#add(severity, message = nil, ex = nil, data = nil, &block) ⇒ Boolean Also known as: log

Log any one or more of a message, an exception and structured data as specified log level. If the block is given for delay evaluation, it returns them as an array or the one of them as a value.

Parameters:

  • severity (Integer) —

    The log level.

  • message (String) (defaults to: nil) —

    The message to log. Use default_message if not specified.

  • ex (Exception) (defaults to: nil) —

    The exception or the error

  • data (Object) (defaults to: nil) —

    Any structured data

Yield Returns:

  • (String|Exception|Object|Array) —

    Any one or more of former parameters

Returns:

  • (Boolean) —

    true



94
95
96
 
# File 'lib/ougai/logging.rb', line 94

def add(severity, message = nil, ex = nil, data = nil, &block)
  _log(severity, message, ex, data, &block)
end

#chain(_severity, _args, _fields, _hooks) ⇒ Object

Raises:

  • (NotImplementedError) 


107
108
109
 
# File 'lib/ougai/logging.rb', line 107

def chain(_severity, _args, _fields, _hooks)
  raise NotImplementedError
end

#debug(message = nil, ex = nil, data = nil, &block) ⇒ Boolean

Log any one or more of a message, an exception and structured data as DEBUG. If the block is given for delay evaluation, it returns them as an array or the one of them as a value.

Parameters:

  • message (String) (defaults to: nil) —

    The message to log. Use default_message if not specified.

  • ex (Exception) (defaults to: nil) —

    The exception or the error

  • data (Object) (defaults to: nil) —

    Any structured data

Yield Returns:

  • (String|Exception|Object|Array) —

    Any one or more of former parameters

Returns:

  • (Boolean) —

    true



41
42
43
 
# File 'lib/ougai/logging.rb', line 41

def debug(message = nil, ex = nil, data = nil, &block)
  _log(DEBUG, message, ex, data, &block)
end

#error(message = nil, ex = nil, data = nil, &block) ⇒ Boolean

Log any one or more of a message, an exception and structured data as ERROR.

Returns:

  • (Boolean) —

    true

See Also:



62
63
64
 
# File 'lib/ougai/logging.rb', line 62

def error(message = nil, ex = nil, data = nil, &block)
  _log(ERROR, message, ex, data, &block)
end

#fatal(message = nil, ex = nil, data = nil, &block) ⇒ Boolean

Log any one or more of a message, an exception and structured data as FATAL.

Returns:

  • (Boolean) —

    true

See Also:



69
70
71
 
# File 'lib/ougai/logging.rb', line 69

def fatal(message = nil, ex = nil, data = nil, &block)
  _log(FATAL, message, ex, data, &block)
end

#info(message = nil, ex = nil, data = nil, &block) ⇒ Boolean

Log any one or more of a message, an exception and structured data as INFO.

Returns:

  • (Boolean) —

    true

See Also:



48
49
50
 
# File 'lib/ougai/logging.rb', line 48

def info(message = nil, ex = nil, data = nil, &block)
  _log(INFO, message, ex, data, &block)
end

#trace(message = nil, ex = nil, data = nil, &block) ⇒ Boolean

Log any one or more of a message, an exception and structured data as TRACE.

Returns:

  • (Boolean) —

    true

See Also:



30
31
32
 
# File 'lib/ougai/logging.rb', line 30

def trace(message = nil, ex = nil, data = nil, &block)
  _log(TRACE, message, ex, data, &block)
end

#trace? ⇒ Boolean

Whether the current severity level allows for logging TRACE.

Returns:

  • (Boolean) —

    true if allows



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

def trace?
  level <= TRACE
end

#unknown(message = nil, ex = nil, data = nil, &block) ⇒ Boolean

Log any one or more of a message, an exception and structured data as UNKNOWN.

Returns:

  • (Boolean) —

    true

See Also:



76
77
78
 
# File 'lib/ougai/logging.rb', line 76

def unknown(message = nil, ex = nil, data = nil, &block)
  _log(UNKNOWN, message, ex, data, &block)
end

#warn(message = nil, ex = nil, data = nil, &block) ⇒ Boolean

Log any one or more of a message, an exception and structured data as WARN.

Returns:

  • (Boolean) —

    true

See Also:



55
56
57
 
# File 'lib/ougai/logging.rb', line 55

def warn(message = nil, ex = nil, data = nil, &block)
  _log(WARN, message, ex, data, &block)
end