1#@!#!123s

: / opt / td-agent / embedded / lib / ruby / gems / 2.1.0 / gems / mongo-2.2.7 / lib / mongo /
Filename : monitoring.rb
back
# Copyright (C) 2015 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'

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

    @@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))
      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