Class: RubySmart::SimpleLogger::Logger

Inherits:
Logger
  • Object
show all
Includes:
ActionView::Helpers::DateHelper, Extensions::Helper, Extensions::Logs, Extensions::Mask, Extensions::Processed, Extensions::Scene, Extensions::Severity, Extensions::SimpleLog, Extensions::Timer, Scenes
Defined in:
lib/ruby_smart/simple_logger/logger.rb

Constant Summary collapse

PAYLOAD_DATA_KEY =

defines a uniq key to parse the data

:__data__

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Logger

initializes a new Logger

Parameters:

  • args (Array) —

    (,) OR () OR ()

  • args[Symbol,Array] (Hash) —

    a customizable set of options

  • args[Hash] (Hash) —

    a customizable set of options



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
 
# File 'lib/ruby_smart/simple_logger/logger.rb', line 49

def initialize(*args)
  # transform args to opts
  opts = args.last.is_a?(Hash) ? args.pop : {}
  opts[:builtin] = args if args.length > 0

  # assign logdev to opts
  assign_logdev!(opts)

  # assign formatter to opts
  assign_formatter!(opts)

  # assign default opts
  assign_defaults!(opts)

  # initialize with a nil +logdev+ to prevent any nested +LogDevice+ creation.
  # we already arranged device & formatter to be able to respond to ther required methods
  super(nil)

  # level must be set through the *_level* method, to prevent invalid values
  self.level = opts[:level]

  # use the provided formatter
  self.formatter = opts[:formatter]

  # ignore payload and send data directly to the logdev
  @ignore_payload = true if opts[:payload] == false

  # ignore processed logging and send data without 'leveling' & PCD-char to the logdev
  @ignore_processed = true if opts[:processed] == false

  # ignore tagged logging and send data without 'tags' to the logdev
  @ignore_tagged = true if opts[:tagged] == false

  # set custom inspector (used for data inspection)
  # 'disable' inspector, if false was provided - which simply results in +#to_s+
  @inspector = (opts[:inspect] == false) ? :to_s : opts[:inspector]

  # set resolved logdev
  @logdev = opts[:logdev]
end

Instance Attribute Details

#logdev ⇒ Object (readonly)

enable access to the logdev



39
40
41
 
# File 'lib/ruby_smart/simple_logger/logger.rb', line 39

def logdev
  @logdev
end

Instance Method Details

#level=(sev) ⇒ Object

overwrite level setter, to accept every available (also newly defined) Severity

Parameters:

  • sev (Numeric, String, Symbol) —
    • severity to resolve


92
93
94
 
# File 'lib/ruby_smart/simple_logger/logger.rb', line 92

def level=(sev)
  @level = _level(sev)
end

#log_stats ⇒ Hash Originally defined in module Extensions::Logs

returns a hash with total amounts per logged type (key)

Returns:

  • (Hash)

#logs ⇒ Array Originally defined in module Extensions::Logs

returns the logdev logs

Returns:

  • (Array)

#logs_to_h ⇒ Hash Originally defined in module Extensions::Logs

transforms the logs-array into a hash of logs, grouped by level (:error, :success, ...)

Returns:

  • (Hash) —

    logs

#timer(action, key = :default, opts = {}) ⇒ Object Originally defined in module Extensions::Timer