123456789_123456789_123456789_123456789_123456789_

Class: Mongo::Monitoring::CmapLogSubscriber

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
Inherits: Object
Defined in: lib/mongo/monitoring/cmap_log_subscriber.rb

Overview

Subscribes to CMAP events and logs them.

Since:

  • 2.9.0

Constant Summary

::Mongo::Loggable - Included

PREFIX

Class Method Summary

Instance Attribute Summary

Instance Method Summary

::Mongo::Loggable - Included

#log_debug

Convenience method to log debug messages with the standard prefix.

#log_error

Convenience method to log error messages with the standard prefix.

#log_fatal

Convenience method to log fatal messages with the standard prefix.

#log_info

Convenience method to log info messages with the standard prefix.

#log_warn

Convenience method to log warn messages with the standard prefix.

#logger

Get the logger instance.

#_mongo_log_prefix, #format_message

Constructor Details

.new(options = {}) ⇒ CmapLogSubscriber

Create the new log subscriber.

Examples:

Create the log subscriber.

CmapLogSubscriber.new

Parameters:

  • options (Hash) (defaults to: {})

    The options.

Options Hash (options):

  • :logger (Logger)

    An optional custom logger.

Since:

  • 2.9.0

[ GitHub ]

  
# File 'lib/mongo/monitoring/cmap_log_subscriber.rb', line 42

def initialize(options = {})
  @options = options
end

Instance Attribute Details

#optionsHash (readonly)

Returns:

  • (Hash)

    options The options.

Since:

  • 2.9.0

[ GitHub ]

  
# File 'lib/mongo/monitoring/cmap_log_subscriber.rb', line 30

attr_reader :options

Instance Method Details

#published(event)

Handle a CMAP event.

Parameters:

  • event (Event)

    The event.

Since:

  • 2.9.0

[ GitHub ]

  
# File 'lib/mongo/monitoring/cmap_log_subscriber.rb', line 51

def published(event)
  log_debug("EVENT: #{event.summary}") if logger.debug?
end