Class: Sapience::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/sapience/base.rb

Overview

rubocop:disable ClassLength

Direct Known Subclasses

Formatters::Raw, Logger, Subscriber

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#filter ⇒ Object

Class name to be logged



5
6
7
 
# File 'lib/sapience/base.rb', line 5

def filter
  @filter
end

#name ⇒ Object

Class name to be logged



5
6
7
 
# File 'lib/sapience/base.rb', line 5

def name
  @name
end

Instance Method Details

#application ⇒ Object

Allow application name to be set globally or per subscriber



154
155
156
 
# File 'lib/sapience/base.rb', line 154

def application
  Sapience.config.application
end

#default_formatter ⇒ Object

Returns [Sapience::Formatters::Default] formatter default for this subscriber



149
150
151
 
# File 'lib/sapience/base.rb', line 149

def default_formatter
  Sapience::Formatters::Default.new
end

#fast_tag(tag, &block) ⇒ Object

:nodoc:



144
145
146
 
# File 'lib/sapience/base.rb', line 144

def fast_tag(tag, &block)
  Sapience.fast_tag(tag, &block)
end

#host ⇒ Object

Allow host name to be set globally or per subscriber



159
160
161
 
# File 'lib/sapience/base.rb', line 159

def host
  Sapience.config.host
end

#level ⇒ Object

Returns the current log level if set, otherwise it returns the global default log level



22
23
24
 
# File 'lib/sapience/base.rb', line 22

def level
  @level || Sapience.config.default_level
end

#level=(level) ⇒ Object

Set the logging level for this logger

Note: This level is only for this particular instance. It does not override

the log level in any logging instance or the default log level
Sapience.config.default_level

Must be one of the values in Sapience::LEVELS, or nil if this logger instance should use the global default level



15
16
17
18
 
# File 'lib/sapience/base.rb', line 15

def level=(level)
  @level_index = Sapience.config.level_to_index(level)
  @level       = Sapience.config.index_to_level(@level_index)
end

#measure(level, message, params = {}, &block) ⇒ Object Also known as: benchmark

Dynamically supply the log level with every measurement call



103
104
105
106
107
108
109
110
 
# File 'lib/sapience/base.rb', line 103

def measure(level, message, params = {}, &block)
  index = Sapience.config.level_to_index(level)
  if level_index <= index
    measure_internal(level, index, message, params, &block)
  else
    block.call(params) if block
  end
end

#payload ⇒ Object

Returns [Hash] payload to be added to every log entry in the current scope on this thread. Returns nil if no payload is currently set



188
189
190
 
# File 'lib/sapience/base.rb', line 188

def payload
  Thread.current[:sapience_payload]
end

#pop_tags(quantity = 1) ⇒ Object

:nodoc:



134
135
136
 
# File 'lib/sapience/base.rb', line 134

def pop_tags(quantity = 1)
  Sapience.pop_tags(quantity)
end

#push_tags(*tags) ⇒ Object Also known as: tags=

:nodoc:



128
129
130
 
# File 'lib/sapience/base.rb', line 128

def push_tags(*tags)
  Sapience.push_tags(*tags)
end

#silence(new_level = :error, &block) ⇒ Object

:nodoc:



139
140
141
 
# File 'lib/sapience/base.rb', line 139

def silence(new_level = :error, &block)
  Sapience.silence(new_level, &block)
end

#tagged(*tags, &block) ⇒ Object Also known as: with_tags

:nodoc:



115
116
117
 
# File 'lib/sapience/base.rb', line 115

def tagged(*tags, &block)
  Sapience.tagged(*tags, &block)
end

#tags ⇒ Object

:nodoc:



123
124
125
 
# File 'lib/sapience/base.rb', line 123

def tags
  Sapience.tags
end

#with_payload(payload) ⇒ Object

Thread specific context information to be logged with every log entry

Add a payload to all log calls on This Thread within the supplied block

logger.with_payload(tracking_number: 12345) do
  logger.debug('Hello World')
end

If a log call already includes a pyload, this payload will be merged with the supplied payload, with the supplied payload taking precedence

logger.with_payload(tracking_number: 12345) do
  logger.debug('Hello World', result: 'blah')
end



177
178
179
180
181
182
183
 
# File 'lib/sapience/base.rb', line 177

def with_payload(payload)
  current_payload                          = self.payload
  Thread.current[:sapience_payload] = current_payload ? current_payload.merge(payload) : payload
  yield
ensure
  Thread.current[:sapience_payload] = current_payload
end