1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 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 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
|
# Copyright (C) 2015-2017 MongoDB, Inc.
#
# Licensed under the Apache License, Version 2.0 (the 'License');
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an 'AS IS' BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'mongo/monitoring/event'
require 'mongo/monitoring/publishable'
require 'mongo/monitoring/command_log_subscriber'
require 'mongo/monitoring/sdam_log_subscriber'
require 'mongo/monitoring/server_description_changed_log_subscriber'
require 'mongo/monitoring/server_closed_log_subscriber'
require 'mongo/monitoring/server_opening_log_subscriber'
require 'mongo/monitoring/topology_changed_log_subscriber'
require 'mongo/monitoring/topology_opening_log_subscriber'
module Mongo
# The class defines behaviour for the performance monitoring API.
#
# @since 2.1.0
class Monitoring
# The command topic.
#
# @since 2.1.0
COMMAND = 'Command'.freeze
# Server closed topic.
#
# @since 2.4.0
SERVER_CLOSED = 'ServerClosed'.freeze
# Server description changed topic.
#
# @since 2.4.0
SERVER_DESCRIPTION_CHANGED = 'ServerDescriptionChanged'.freeze
# Server opening topic.
#
# @since 2.4.0
SERVER_OPENING = 'ServerOpening'.freeze
# Topology changed topic.
#
# @since 2.4.0
TOPOLOGY_CHANGED = 'TopologyChanged'.freeze
# Topology closed topic.
#
# @since 2.4.0
TOPOLOGY_CLOSED = 'TopologyClosed'.freeze
# Topology opening topic.
#
# @since 2.4.0
TOPOLOGY_OPENING = 'TopologyOpening'.freeze
@@operation_id = 0
@@operation_id_lock = Mutex.new
# Used for generating unique operation ids to link events together.
#
# @example Get the next operation id.
# Monitoring.next_operation_id
#
# @return [ Integer ] The next operation id.
#
# @since 2.1.0
def self.next_operation_id
@@operation_id_lock.synchronize do
@@operation_id += 1
end
end
# Provides behaviour around global subscribers.
#
# @since 2.1.0
module Global
extend self
# Subscribe a listener to an event topic.
#
# @example Subscribe to the topic.
# Monitoring::Global.subscribe(QUERY, subscriber)
#
# @param [ String ] topic The event topic.
# @param [ Object ] subscriber The subscriber to handle the event.
#
# @since 2.1.0
def subscribe(topic, subscriber)
subscribers_for(topic).push(subscriber)
end
# Get all the global subscribers.
#
# @example Get all the global subscribers.
# Monitoring::Global.subscribers
#
# @return [ Hash<String, Object> ] The subscribers.
#
# @since 2.1.0
def subscribers
@subscribers ||= {}
end
private
def subscribers_for(topic)
subscribers[topic] ||= []
end
end
# Initialize the monitoring.
#
# @api private
#
# @example Create the new monitoring.
# Monitoring.new(:monitoring => true)
#
# @param [ Hash ] options The options.
#
# @since 2.1.0
def initialize(options = {})
if options[:monitoring] != false
Global.subscribers.each do |topic, subscribers|
subscribers.each do |subscriber|
subscribe(topic, subscriber)
end
end
subscribe(COMMAND, CommandLogSubscriber.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))
end
end
# Publish a started event.
#
# @example Publish a started event.
# monitoring.started(COMMAND, event)
#
# @param [ String ] topic The event topic.
# @param [ Event ] event The event to publish.
#
# @since 2.1.0
def started(topic, event)
subscribers_for(topic).each{ |subscriber| subscriber.started(event) }
end
# Publish a succeeded event.
#
# @example Publish a succeeded event.
# monitoring.succeeded(COMMAND, event)
#
# @param [ String ] topic The event topic.
# @param [ Event ] event The event to publish.
#
# @since 2.1.0
def succeeded(topic, event)
subscribers_for(topic).each{ |subscriber| subscriber.succeeded(event) }
end
# Publish a failed event.
#
# @example Publish a failed event.
# monitoring.failed(COMMAND, event)
#
# @param [ String ] topic The event topic.
# @param [ Event ] event The event to publish.
#
# @since 2.1.0
def failed(topic, event)
subscribers_for(topic).each{ |subscriber| subscriber.failed(event) }
end
# Subscribe a listener to an event topic.
#
# @example Subscribe to the topic.
# monitoring.subscribe(QUERY, subscriber)
#
# @param [ String ] topic The event topic.
# @param [ Object ] subscriber The subscriber to handle the event.
#
# @since 2.1.0
def subscribe(topic, subscriber)
subscribers_for(topic).push(subscriber)
end
# Get all the subscribers.
#
# @example Get all the subscribers.
# monitoring.subscribers
#
# @return [ Hash<String, Object> ] The subscribers.
#
# @since 2.1.0
def subscribers
@subscribers ||= {}
end
# Determine if there are any subscribers for a particular event.
#
# @example Are there subscribers?
# monitoring.subscribers?(COMMAND)
#
# @param [ String ] topic The event topic.
#
# @return [ true, false ] If there are subscribers for the topic.
#
# @since 2.1.0
def subscribers?(topic)
!subscribers_for(topic).empty?
end
private
def initialize_copy(original)
@subscribers = original.subscribers.dup
end
def subscribers_for(topic)
subscribers[topic] ||= []
end
end
end
|