Class: Mongo::Monitoring

Relationships & Source Files
Namespace Children
Modules: `Event`, `Global`, `Publishable`, `Subscribable`
Classes: `CmapLogSubscriber`, `CommandLogSubscriber`, `SDAMLogSubscriber`, `ServerClosedLogSubscriber`, `ServerDescriptionChangedLogSubscriber`, `ServerOpeningLogSubscriber`, `TopologyChangedLogSubscriber`, `TopologyClosedLogSubscriber`, `TopologyOpeningLogSubscriber`, `UnifiedSdamLogSubscriber`
Super Chains via Extension / Inclusion / Inheritance
Instance Chain: self, `Subscribable`, `Id`
Inherits:	Object
Defined in:	lib/mongo/monitoring.rb, lib/mongo/monitoring/cmap_log_subscriber.rb, lib/mongo/monitoring/command_log_subscriber.rb, lib/mongo/monitoring/publishable.rb, lib/mongo/monitoring/sdam_log_subscriber.rb, lib/mongo/monitoring/server_closed_log_subscriber.rb, lib/mongo/monitoring/server_description_changed_log_subscriber.rb, lib/mongo/monitoring/server_opening_log_subscriber.rb, lib/mongo/monitoring/topology_changed_log_subscriber.rb, lib/mongo/monitoring/topology_closed_log_subscriber.rb, lib/mongo/monitoring/topology_opening_log_subscriber.rb, lib/mongo/monitoring/unified_sdam_log_subscriber.rb, lib/mongo/monitoring/event/command_failed.rb, lib/mongo/monitoring/event/command_started.rb, lib/mongo/monitoring/event/command_succeeded.rb, lib/mongo/monitoring/event/secure.rb, lib/mongo/monitoring/event/server_closed.rb, lib/mongo/monitoring/event/server_description_changed.rb, lib/mongo/monitoring/event/server_heartbeat_failed.rb, lib/mongo/monitoring/event/server_heartbeat_started.rb, lib/mongo/monitoring/event/server_heartbeat_succeeded.rb, lib/mongo/monitoring/event/server_opening.rb, lib/mongo/monitoring/event/topology_changed.rb, lib/mongo/monitoring/event/topology_closed.rb, lib/mongo/monitoring/event/topology_opening.rb, lib/mongo/monitoring/event/cmap/base.rb, lib/mongo/monitoring/event/cmap/connection_check_out_failed.rb, lib/mongo/monitoring/event/cmap/connection_check_out_started.rb, lib/mongo/monitoring/event/cmap/connection_checked_in.rb, lib/mongo/monitoring/event/cmap/connection_checked_out.rb, lib/mongo/monitoring/event/cmap/connection_closed.rb, lib/mongo/monitoring/event/cmap/connection_created.rb, lib/mongo/monitoring/event/cmap/connection_ready.rb, lib/mongo/monitoring/event/cmap/pool_cleared.rb, lib/mongo/monitoring/event/cmap/pool_closed.rb, lib/mongo/monitoring/event/cmap/pool_created.rb, lib/mongo/monitoring/event/cmap/pool_ready.rb

Overview

The class defines behavior for the performance monitoring API.

Since:

2.1.0

Constant Summary

COMMAND =

The command topic.
Since:
- 2.1.0
# File 'lib/mongo/monitoring.rb', line 27
```
'Command'
```
CONNECTION_POOL =

The connection pool topic.
Since:
- 2.9.0
# File 'lib/mongo/monitoring.rb', line 32
```
'ConnectionPool'
```
SERVER_CLOSED =

Server closed topic.
Since:
- 2.4.0
# File 'lib/mongo/monitoring.rb', line 37
```
'ServerClosed'
```
SERVER_DESCRIPTION_CHANGED =

Server description changed topic.
Since:
- 2.4.0
# File 'lib/mongo/monitoring.rb', line 42
```
'ServerDescriptionChanged'
```
SERVER_HEARTBEAT =

Server heartbeat started topic.
Since:
- 2.7.0
# File 'lib/mongo/monitoring.rb', line 67
```
'ServerHeartbeat'
```
SERVER_OPENING =

Server opening topic.
Since:
- 2.4.0
# File 'lib/mongo/monitoring.rb', line 47
```
'ServerOpening'
```
TOPOLOGY_CHANGED =

Topology changed topic.
Since:
- 2.4.0
# File 'lib/mongo/monitoring.rb', line 52
```
'TopologyChanged'
```
TOPOLOGY_CLOSED =

Topology closed topic.
Since:
- 2.4.0
# File 'lib/mongo/monitoring.rb', line 57
```
'TopologyClosed'
```
TOPOLOGY_OPENING =

Topology opening topic.
Since:
- 2.4.0
# File 'lib/mongo/monitoring.rb', line 62
```
'TopologyOpening'
```

Class Method Summary

.new(options = {}) ⇒ Monitoring constructor Internal use only

Initialize the monitoring.
.next_operation_id ⇒ Integer

Used for generating unique operation ids to link events together.

Instance Attribute Summary

#monitoring? ⇒ Boolean readonly Internal use only
#options readonly Internal use only

Instance Method Summary

#failed(topic, event)

Publish a failed event.
#publish_heartbeat(server, awaited: false) Internal use only
#published(topic, event)

Publish an event.
#started(topic, event)

Publish a started event.
#succeeded(topic, event)

Publish a succeeded event.
#initialize_copy(original) private

`Subscribable` - Included

#subscribe	Subscribe a listener to an event topic.
#subscribers	Get all the subscribers.
#subscribers?	Determine if there are any subscribers for a particular event.
#unsubscribe	Unsubscribe a listener from an event topic.
#subscribers_for

Constructor Details

.new(options = {}) ⇒ `Monitoring`

Initialize the monitoring.

Examples:

Create the new monitoring.

Monitoring.new(:monitoring => true)

Parameters:

options (Hash) (defaults to: {}) —
Options. Client constructor forwards its options to Monitoring constructor, although Monitoring recognizes only a subset of the options recognized by Client.

Options Hash (options):

:monitoring (true, false) —
If false is given, the Monitoring instance is initialized without global monitoring event subscribers and will not publish SDAM events. Command monitoring events will still be published, and the driver will still perform SDAM and monitor its cluster in order to perform server selection. Built-in driver logging of SDAM events will be disabled because it is implemented through SDAM event subscription. Client#subscribe will succeed for all event types, but subscribers to SDAM events will not be invoked. Values other than false result in default behavior which is to perform normal SDAM event publication.

Since:

2.1.0

[ GitHub ]

# File 'lib/mongo/monitoring.rb', line 218


def initialize(options = {})
  @options = options
  return unless options[:monitoring] != false

  Global.subscribers.each do |topic, subscribers|
    subscribers.each do |subscriber|
      subscribe(topic, subscriber)
    end
  end
  subscribe(COMMAND, CommandLogSubscriber.new(options))
  # CMAP events are not logged by default because this will create
  # log entries for every operation performed by the driver.
  # subscribe(CONNECTION_POOL, CmapLogSubscriber.new(options))
  subscribe(SERVER_OPENING, ServerOpeningLogSubscriber.new(options))
  subscribe(SERVER_CLOSED, ServerClosedLogSubscriber.new(options))
  subscribe(SERVER_DESCRIPTION_CHANGED, ServerDescriptionChangedLogSubscriber.new(options))
  subscribe(TOPOLOGY_OPENING, TopologyOpeningLogSubscriber.new(options))
  subscribe(TOPOLOGY_CHANGED, TopologyChangedLogSubscriber.new(options))
  subscribe(TOPOLOGY_CLOSED, TopologyClosedLogSubscriber.new(options))
end

Class Method Details

.next_operation_id ⇒ `Integer`

Used for generating unique operation ids to link events together.

Examples:

Get the next operation id.

Monitoring.next_operation_id

Returns:

(Integer) —
The next operation id.

Since:

2.1.0

[ GitHub ]

# File 'lib/mongo/monitoring.rb', line 77


def self.next_operation_id
  next_id
end

Instance Attribute Details

#monitoring? ⇒ `Boolean` (readonly)

Since:

2.1.0

[ GitHub ]

# File 'lib/mongo/monitoring.rb', line 243


def monitoring?
  options[:monitoring] != false
end

#options (readonly)

Since:

2.1.0

[ GitHub ]

# File 'lib/mongo/monitoring.rb', line 240


attr_reader :options

Instance Method Details

#failed(topic, event)

Publish a failed event.

This method is used for event types which have the started/succeeded/failed events in them, such as command and heartbeat events.

Examples:

Publish a failed event.

monitoring.failed(COMMAND, event)

Parameters:

topic (String) —
The event topic.
event (Event) —
The event to publish.

Since:

2.1.0

[ GitHub ]

# File 'lib/mongo/monitoring.rb', line 304


def failed(topic, event)
  subscribers_for(topic).each { |subscriber| subscriber.failed(event) }
end

#initialize_copy(original) (private)

Since:

2.1.0

[ GitHub ]

# File 'lib/mongo/monitoring.rb', line 358


def initialize_copy(original)
  @subscribers = {}
  original.subscribers.each do |k, v|
    @subscribers[k] = v.dup
  end
end

#publish_heartbeat(server, awaited: false)

Since:

2.1.0

[ GitHub ]

# File 'lib/mongo/monitoring.rb', line 309


def publish_heartbeat(server, awaited: false)
  if monitoring?
    started_event = Event::ServerHeartbeatStarted.new(
      server.address, awaited: awaited
    )
    started(SERVER_HEARTBEAT, started_event)
  end

  # The duration we publish in heartbeat succeeded/failed events is
  # the time spent on the entire heartbeat. This could include time
  # to connect the socket (including TLS handshake), not just time
  # spent on hello call itself.
  # The spec at https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring-logging-and-monitoring.md
  # requires that the duration exposed here start from "sending the
  # message" (hello). This requirement does not make sense if,
  # for example, we were never able to connect to the server at all
  # and thus hello was never sent.
  start_time = Utils.monotonic_time

  begin
    result = yield
  rescue StandardError => e
    if monitoring?
      event = Event::ServerHeartbeatFailed.new(
        server.address,
        Utils.monotonic_time - start_time,
        e,
        awaited: awaited,
        started_event: started_event
      )
      failed(SERVER_HEARTBEAT, event)
    end
    raise
  else
    if monitoring?
      event = Event::ServerHeartbeatSucceeded.new(
        server.address,
        Utils.monotonic_time - start_time,
        awaited: awaited,
        started_event: started_event
      )
      succeeded(SERVER_HEARTBEAT, event)
    end
    result
  end
end

#published(topic, event)

Publish an event.

This method is used for event types which only have a single event in them.

Parameters:

topic (String) —
The event topic.
event (Event) —
The event to publish.

Since:

2.9.0

[ GitHub ]

# File 'lib/mongo/monitoring.rb', line 256


def published(topic, event)
  subscribers_for(topic).each { |subscriber| subscriber.published(event) }
end

#started(topic, event)

Publish a started event.

This method is used for event types which have the started/succeeded/failed events in them, such as command and heartbeat events.

Examples:

Publish a started event.

monitoring.started(COMMAND, event)

Parameters:

topic (String) —
The event topic.
event (Event) —
The event to publish.

Since:

2.1.0

[ GitHub ]

# File 'lib/mongo/monitoring.rb', line 272


def started(topic, event)
  subscribers_for(topic).each { |subscriber| subscriber.started(event) }
end

#succeeded(topic, event)

Publish a succeeded event.

This method is used for event types which have the started/succeeded/failed events in them, such as command and heartbeat events.

Examples:

Publish a succeeded event.

monitoring.succeeded(COMMAND, event)

Parameters:

topic (String) —
The event topic.
event (Event) —
The event to publish.

Since:

2.1.0

[ GitHub ]

# File 'lib/mongo/monitoring.rb', line 288


def succeeded(topic, event)
  subscribers_for(topic).each { |subscriber| subscriber.succeeded(event) }
end

Class: Mongo::Monitoring

Overview

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Subscribable - Included

Constructor Details

.new(options = {}) ⇒ Monitoring

Class Method Details

.next_operation_id ⇒ Integer

Instance Attribute Details

#monitoring? ⇒ Boolean (readonly)

#options (readonly)

Instance Method Details

#failed(topic, event)

#initialize_copy(original) (private)

#publish_heartbeat(server, awaited: false)

#published(topic, event)

#started(topic, event)

#succeeded(topic, event)

`Subscribable` - Included

.new(options = {}) ⇒ `Monitoring`

.next_operation_id ⇒ `Integer`

#monitoring? ⇒ `Boolean` (readonly)