Class: Google::Cloud::Logging::Logger
- Inherits:
-
Object
- Object
- Google::Cloud::Logging::Logger
- Defined in:
- lib/google/cloud/logging/logger.rb
Overview
Logger
An API-compatible replacement for ruby's Logger that logs to the Stackdriver Logging Service.
Defined Under Namespace
Classes: RequestInfo
Instance Attribute Summary collapse
-
#datetime_format ⇒ Object
This logger does not use a formatter, but it implements this attribute for API compatibility with the standard Logger.
-
#formatter ⇒ Object
This logger does not use a formatter, but it provides a default Logger::Formatter for API compatibility with the standard Logger.
-
#labels ⇒ Object
readonly
The Google Cloud labels to write the log entry with.
-
#level ⇒ Object
(also: #sev_threshold)
The logging severity threshold (e.g.
Logger::INFO
). -
#log_name ⇒ Object
(also: #progname)
readonly
The Google Cloud log_name to write the log entry with.
-
#resource ⇒ Object
readonly
The Google Cloud resource to write the log entry with.
-
#writer ⇒ Object
readonly
The Google Cloud writer object that calls to #write_entries are made on.
Instance Method Summary collapse
-
#<<(msg) ⇒ Object
Logs the given message at UNKNOWN severity.
-
#add(severity, message = nil, progname = nil) { ... } ⇒ Object
(also: #log)
Log a message if the given severity is high enough.
-
#add_request_info(info: nil, trace_id: nil, log_name: nil) ⇒ Object
Associate request data with the current Thread.
-
#add_trace_id(trace_id) ⇒ Object
deprecated
Deprecated.
Use add_request_info
-
#close ⇒ Object
Close the logging "device".
-
#debug(message = nil) { ... } ⇒ Object
Log a
DEBUG
entry. -
#debug? ⇒ Boolean
Returns
true
if the current severity level allows for sendingDEBUG
messages. -
#delete_request_info ⇒ RequestInfo
(also: #delete_trace_id)
Untrack the RequestInfo that's associated with current Thread.
-
#error(message = nil) { ... } ⇒ Object
Log an
ERROR
entry. -
#error? ⇒ Boolean
Returns
true
if the current severity level allows for sendingERROR
messages. -
#fatal(message = nil) { ... } ⇒ Object
Log a
FATAL
entry. -
#fatal? ⇒ Boolean
Returns
true
if the current severity level allows for sendingFATAL
messages. -
#info(message = nil) { ... } ⇒ Object
Log an
INFO
entry. -
#info? ⇒ Boolean
Returns
true
if the current severity level allows for sendingINFO
messages. -
#initialize(writer, log_name, resource, labels = nil) ⇒ Google::Cloud::Logging::Logger
constructor
Create a new Logger instance.
-
#progname=(name) ⇒ Object
This logger treats progname as an alias for log_name.
-
#reopen(_logdev = nil) ⇒ Object
Re-enable logging if the logger has been closed.
-
#request_info ⇒ RequestInfo?
Get the request data for the current Thread.
-
#trace_ids ⇒ Object
deprecated
Deprecated.
Use request_info
-
#unknown(message = nil) { ... } ⇒ Object
Log an
UNKNOWN
entry. -
#warn(message = nil) { ... } ⇒ Object
Log a
WARN
entry. -
#warn? ⇒ Boolean
Returns
true
if the current severity level allows for sendingWARN
messages.
Constructor Details
#initialize(writer, log_name, resource, labels = nil) ⇒ Google::Cloud::Logging::Logger
Create a new Logger instance.
139 140 141 142 143 144 145 146 147 148 149 150 |
# File 'lib/google/cloud/logging/logger.rb', line 139 def initialize writer, log_name, resource, labels = nil @writer = writer @log_name = log_name @resource = resource @labels = labels @level = 0 # DEBUG is the default behavior @request_info = OrderedHash.new @closed = false # Unused, but present for API compatibility @formatter = ::Logger::Formatter.new @datetime_format = "" end |
Instance Attribute Details
#datetime_format ⇒ Object
This logger does not use a formatter, but it implements this attribute for API compatibility with the standard Logger.
84 85 86 |
# File 'lib/google/cloud/logging/logger.rb', line 84 def datetime_format @datetime_format end |
#formatter ⇒ Object
This logger does not use a formatter, but it provides a default Logger::Formatter for API compatibility with the standard Logger.
79 80 81 |
# File 'lib/google/cloud/logging/logger.rb', line 79 def formatter @formatter end |
#labels ⇒ Object (readonly)
The Google Cloud labels to write the log entry with.
69 70 71 |
# File 'lib/google/cloud/logging/logger.rb', line 69 def labels @labels end |
#level ⇒ Object Also known as: sev_threshold
The logging severity threshold (e.g. Logger::INFO
)
73 74 75 |
# File 'lib/google/cloud/logging/logger.rb', line 73 def level @level end |
#log_name ⇒ Object (readonly) Also known as: progname
The Google Cloud log_name to write the log entry with.
60 61 62 |
# File 'lib/google/cloud/logging/logger.rb', line 60 def log_name @log_name end |
#resource ⇒ Object (readonly)
The Google Cloud resource to write the log entry with.
65 66 67 |
# File 'lib/google/cloud/logging/logger.rb', line 65 def resource @resource end |
#writer ⇒ Object (readonly)
The Google Cloud writer object that calls to #write_entries are made on. Either an AsyncWriter or Project object.
56 57 58 |
# File 'lib/google/cloud/logging/logger.rb', line 56 def writer @writer end |
Instance Method Details
#<<(msg) ⇒ Object
Logs the given message at UNKNOWN severity.
298 299 300 301 |
# File 'lib/google/cloud/logging/logger.rb', line 298 def << msg unknown msg self end |
#add(severity, message = nil, progname = nil) { ... } ⇒ Object Also known as: log
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
# File 'lib/google/cloud/logging/logger.rb', line 275 def add severity, = nil, progname = nil severity = derive_severity(severity) || 5 # 5 is UNKNOWN/DEFAULT return true if severity < @level if .nil? if block_given? = yield else = progname # progname = nil # TODO: Figure out what to do with the progname end end write_entry severity, unless @closed true end |
#add_request_info(info: nil, trace_id: nil, log_name: nil) ⇒ Object
Associate request data with the current Thread. You may provide either the individual pieces of data (trace ID, log name) or a populated RequestInfo object.
410 411 412 413 414 415 416 417 418 419 420 421 422 |
# File 'lib/google/cloud/logging/logger.rb', line 410 def add_request_info info: nil, trace_id: nil, log_name: nil info ||= RequestInfo.new trace_id, log_name @request_info[current_thread_id] = info # Start removing old entries if hash gets too large. # This should never happen, because middleware should automatically # remove entries when a request is finished @request_info.shift while @request_info.size > 10_000 info end |
#add_trace_id(trace_id) ⇒ Object
Use add_request_info
Track a given trace_id by associating it with the current Thread
393 394 395 |
# File 'lib/google/cloud/logging/logger.rb', line 393 def add_trace_id trace_id add_request_id trace_id: trace_id end |
#close ⇒ Object
Close the logging "device". This effectively disables logging from this logger; any further log messages will be silently ignored. The logger may be re-enabled by calling #reopen.
370 371 372 373 |
# File 'lib/google/cloud/logging/logger.rb', line 370 def close @closed = true self end |
#debug(message = nil) { ... } ⇒ Object
Log a DEBUG
entry.
162 163 164 165 166 167 168 |
# File 'lib/google/cloud/logging/logger.rb', line 162 def debug = nil, &block if block_given? add 0, nil, , &block else add 0, , nil, &block end end |
#debug? ⇒ Boolean
Returns true
if the current severity level allows for sending
DEBUG
messages.
306 307 308 |
# File 'lib/google/cloud/logging/logger.rb', line 306 def debug? @level <= 0 end |
#delete_request_info ⇒ RequestInfo Also known as: delete_trace_id
Untrack the RequestInfo that's associated with current Thread
439 440 441 |
# File 'lib/google/cloud/logging/logger.rb', line 439 def delete_request_info @request_info.delete current_thread_id end |
#error(message = nil) { ... } ⇒ Object
Log an ERROR
entry.
216 217 218 219 220 221 222 |
# File 'lib/google/cloud/logging/logger.rb', line 216 def error = nil, &block if block_given? add 3, nil, , &block else add 3, , nil, &block end end |
#error? ⇒ Boolean
Returns true
if the current severity level allows for sending
ERROR
messages.
327 328 329 |
# File 'lib/google/cloud/logging/logger.rb', line 327 def error? @level <= 3 end |
#fatal(message = nil) { ... } ⇒ Object
Log a FATAL
entry.
234 235 236 237 238 239 240 |
# File 'lib/google/cloud/logging/logger.rb', line 234 def fatal = nil, &block if block_given? add 4, nil, , &block else add 4, , nil, &block end end |
#fatal? ⇒ Boolean
Returns true
if the current severity level allows for sending
FATAL
messages.
334 335 336 |
# File 'lib/google/cloud/logging/logger.rb', line 334 def fatal? @level <= 4 end |
#info(message = nil) { ... } ⇒ Object
Log an INFO
entry.
180 181 182 183 184 185 186 |
# File 'lib/google/cloud/logging/logger.rb', line 180 def info = nil, &block if block_given? add 1, nil, , &block else add 1, , nil, &block end end |
#info? ⇒ Boolean
Returns true
if the current severity level allows for sending INFO
messages.
313 314 315 |
# File 'lib/google/cloud/logging/logger.rb', line 313 def info? @level <= 1 end |
#progname=(name) ⇒ Object
This logger treats progname as an alias for log_name.
88 89 90 |
# File 'lib/google/cloud/logging/logger.rb', line 88 def progname= name @log_name = name end |
#reopen(_logdev = nil) ⇒ Object
Re-enable logging if the logger has been closed.
Note that this method accepts a "logdev" argument for compatibility with the standard Ruby Logger class; however, this argument is ignored because this logger does not use a log device.
382 383 384 385 |
# File 'lib/google/cloud/logging/logger.rb', line 382 def reopen _logdev = nil @closed = false self end |
#request_info ⇒ RequestInfo?
Get the request data for the current Thread
430 431 432 |
# File 'lib/google/cloud/logging/logger.rb', line 430 def request_info @request_info[current_thread_id] end |
#trace_ids ⇒ Object
Use request_info
A OrderedHash of Thread IDs to Stackdriver request trace ID. The Stackdriver trace ID is a shared request identifier across all Stackdriver services.
99 100 101 |
# File 'lib/google/cloud/logging/logger.rb', line 99 def trace_ids @request_info.inject({}) { |r, (k, v)| r[k] = v.trace_id } end |
#unknown(message = nil) { ... } ⇒ Object
Log an UNKNOWN
entry. This will be printed no matter what the
logger's current severity level is.
253 254 255 256 257 258 259 |
# File 'lib/google/cloud/logging/logger.rb', line 253 def unknown = nil, &block if block_given? add 5, nil, , &block else add 5, , nil, &block end end |
#warn(message = nil) { ... } ⇒ Object
Log a WARN
entry.
198 199 200 201 202 203 204 |
# File 'lib/google/cloud/logging/logger.rb', line 198 def warn = nil, &block if block_given? add 2, nil, , &block else add 2, , nil, &block end end |
#warn? ⇒ Boolean
Returns true
if the current severity level allows for sending WARN
messages.
320 321 322 |
# File 'lib/google/cloud/logging/logger.rb', line 320 def warn? @level <= 2 end |