638 lines
20 KiB
Ruby
638 lines
20 KiB
Ruby
# encoding: UTF-8
|
||
|
||
# --
|
||
# Copyright (C) 2008-2011 10gen 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.
|
||
# ++
|
||
|
||
module Mongo
|
||
|
||
# Instantiates and manages connections to a MongoDB replica set.
|
||
class ReplSetConnection < Connection
|
||
CLEANUP_INTERVAL = 300
|
||
|
||
attr_reader :replica_set_name, :seeds, :refresh_interval, :refresh_mode,
|
||
:refresh_version
|
||
|
||
# Create a connection to a MongoDB replica set.
|
||
#
|
||
# Once connected to a replica set, you can find out which nodes are primary, secondary, and
|
||
# arbiters with the corresponding accessors: Connection#primary, Connection#secondaries, and
|
||
# Connection#arbiters. This is useful if your application needs to connect manually to nodes other
|
||
# than the primary.
|
||
#
|
||
# @param [Array] args A list of host-port pairs to be used as seed nodes followed by a
|
||
# hash containing any options. See the examples below for exactly how to use the constructor.
|
||
#
|
||
# @option options [String] :rs_name (nil) The name of the replica set to connect to. You
|
||
# can use this option to verify that you're connecting to the right replica set.
|
||
# @option options [Boolean, Hash] :safe (false) Set the default safe-mode options
|
||
# propogated to DB objects instantiated off of this Connection. This
|
||
# default can be overridden upon instantiation of any DB by explicity setting a :safe value
|
||
# on initialization.
|
||
# @option options [:primary, :secondary] :read (:primary) The default read preference for Mongo::DB
|
||
# objects created from this connection object. If +:secondary+ is chosen, reads will be sent
|
||
# to one of the closest available secondary nodes. If a secondary node cannot be located, the
|
||
# read will be sent to the primary.
|
||
# @option options [Logger] :logger (nil) Logger instance to receive driver operation log.
|
||
# @option options [Integer] :pool_size (1) The maximum number of socket connections allowed per
|
||
# connection pool. Note: this setting is relevant only for multi-threaded applications.
|
||
# @option options [Float] :pool_timeout (5.0) When all of the connections a pool are checked out,
|
||
# this is the number of seconds to wait for a new connection to be released before throwing an exception.
|
||
# Note: this setting is relevant only for multi-threaded applications.
|
||
# @option opts [Float] :op_timeout (nil) The number of seconds to wait for a read operation to time out.
|
||
# Disabled by default.
|
||
# @option opts [Float] :connect_timeout (nil) The number of seconds to wait before timing out a
|
||
# connection attempt.
|
||
# @option opts [Boolean] :ssl (false) If true, create the connection to the server using SSL.
|
||
# @option opts [Boolean] :refresh_mode (false) Set this to :async to enable a background thread that
|
||
# periodically updates the state of the connection. If, for example, you initially connect while a secondary
|
||
# is down, this will reconnect to that secondary behind the scenes to
|
||
# prevent you from having to reconnect manually. If set to :sync, refresh will happen
|
||
# synchronously. If +false+, no automatic refresh will occur unless there's a connection failure.
|
||
# @option opts [Integer] :refresh_interval (90) If :refresh_mode is enabled, this is the number of seconds
|
||
# between calls to check the replica set's state.
|
||
# @option opts [Boolean] :require_primary (true) If true, require a primary node for the connection
|
||
# to succeed. Otherwise, connection will succeed as long as there's at least one secondary node.
|
||
#
|
||
# @example Connect to a replica set and provide two seed nodes. Note that the number of seed nodes does
|
||
# not have to be equal to the number of replica set members. The purpose of seed nodes is to permit
|
||
# the driver to find at least one replica set member even if a member is down.
|
||
# ReplSetConnection.new(['localhost', 30000], ['localhost', 30001])
|
||
#
|
||
# @example Connect to a replica set providing two seed nodes and ensuring a connection to the replica set named 'prod':
|
||
# ReplSetConnection.new(['localhost', 30000], ['localhost', 30001], :rs_name => 'prod')
|
||
#
|
||
# @example Connect to a replica set providing two seed nodes and allowing reads from a secondary node:
|
||
# ReplSetConnection.new(['localhost', 30000], ['localhost', 30001], :read_secondary => true)
|
||
#
|
||
# @see http://api.mongodb.org/ruby/current/file.REPLICA_SETS.html Replica sets in Ruby
|
||
#
|
||
# @raise [ReplicaSetConnectionError] This is raised if a replica set name is specified and the
|
||
# driver fails to connect to a replica set with that name.
|
||
def initialize(*args)
|
||
if args.last.is_a?(Hash)
|
||
opts = args.pop
|
||
else
|
||
opts = {}
|
||
end
|
||
|
||
unless args.length > 0
|
||
raise MongoArgumentError, "A ReplSetConnection requires at least one seed node."
|
||
end
|
||
|
||
# The list of seed nodes
|
||
@seeds = args
|
||
|
||
# TODO: get rid of this
|
||
@nodes = @seeds.dup
|
||
|
||
# Refresh
|
||
@refresh_mode = opts.fetch(:refresh_mode, false)
|
||
@refresh_interval = opts[:refresh_interval] || 90
|
||
@last_refresh = Time.now
|
||
|
||
# No connection manager by default.
|
||
@manager = nil
|
||
|
||
if ![:sync, :async, false].include?(@refresh_mode)
|
||
raise MongoArgumentError,
|
||
"Refresh mode must be one of :sync, :async, or false."
|
||
end
|
||
|
||
# Are we allowing reads from secondaries?
|
||
if opts[:read_secondary]
|
||
warn ":read_secondary options has now been deprecated and will " +
|
||
"be removed in driver v2.0. Use the :read option instead."
|
||
@read_secondary = opts.fetch(:read_secondary, false)
|
||
@read = :secondary
|
||
else
|
||
@read = opts.fetch(:read, :primary)
|
||
Mongo::Support.validate_read_preference(@read)
|
||
end
|
||
|
||
@connected = false
|
||
|
||
# Store the refresher thread
|
||
@refresh_thread = nil
|
||
@refresh_version = 0
|
||
|
||
# Maps
|
||
@sockets_to_pools = {}
|
||
@threads_to_sockets = Hash.new { |h, k| h[k] = Hash.new }
|
||
@tag_map = nil
|
||
|
||
# Replica set name
|
||
if opts[:rs_name]
|
||
warn ":rs_name option has been deprecated and will be removed in v2.0. " +
|
||
"Please use :name instead."
|
||
@replica_set_name = opts[:rs_name]
|
||
else
|
||
@replica_set_name = opts[:name]
|
||
end
|
||
|
||
# Require a primary node to connect?
|
||
@require_primary = opts.fetch(:require_primary, true)
|
||
|
||
setup(opts)
|
||
end
|
||
|
||
def inspect
|
||
"<Mongo::ReplSetConnection:0x#{self.object_id.to_s(16)} @seeds=#{@seeds.inspect} " +
|
||
"@connected=#{@connected}>"
|
||
end
|
||
|
||
# Initiate a connection to the replica set.
|
||
def connect
|
||
log(:info, "Connecting...")
|
||
return if @connected
|
||
manager = PoolManager.new(self, @seeds)
|
||
manager.connect
|
||
|
||
update_config(manager)
|
||
initiate_refresh_mode
|
||
|
||
if @require_primary && self.primary.nil? #TODO: in v2.0, we'll let this be optional and do a lazy connect.
|
||
close
|
||
raise ConnectionFailure, "Failed to connect to primary node."
|
||
elsif self.read_pool.nil?
|
||
close
|
||
raise ConnectionFailure, "Failed to connect to any node."
|
||
else
|
||
@connected = true
|
||
end
|
||
end
|
||
|
||
# Determine whether a replica set refresh is
|
||
# required. If so, run a hard refresh. You can
|
||
# force a hard refresh by running
|
||
# ReplSetConnection#hard_refresh!
|
||
#
|
||
# @return [Boolean] +true+ unless a hard refresh
|
||
# is run and the refresh lock can't be acquired.
|
||
def refresh(opts={})
|
||
if !connected?
|
||
log(:info, "Trying to check replica set health but not " +
|
||
"connected...")
|
||
return hard_refresh!
|
||
end
|
||
|
||
log(:debug, "Checking replica set connection health...")
|
||
@manager.check_connection_health
|
||
|
||
if @manager.refresh_required?
|
||
return hard_refresh!
|
||
end
|
||
|
||
return true
|
||
end
|
||
|
||
# Force a hard refresh of this connection's view
|
||
# of the replica set.
|
||
#
|
||
# @return [Boolean] +true+ if hard refresh
|
||
# occurred. +false+ is returned when unable
|
||
# to get the refresh lock.
|
||
def hard_refresh!
|
||
log(:info, "Initiating hard refresh...")
|
||
background_manager = PoolManager.new(self, @seeds)
|
||
background_manager.connect
|
||
|
||
# TODO: make sure that connect has succeeded
|
||
old_manager = @manager
|
||
update_config(background_manager)
|
||
old_manager.close(:soft => true)
|
||
initiate_refresh_mode
|
||
|
||
return true
|
||
end
|
||
|
||
def connected?
|
||
self.primary_pool || self.read_pool
|
||
end
|
||
|
||
# @deprecated
|
||
def connecting?
|
||
warn "ReplSetConnection#connecting? is deprecated and will be removed in v2.0."
|
||
false
|
||
end
|
||
|
||
# The replica set primary's host name.
|
||
#
|
||
# @return [String]
|
||
def host
|
||
self.primary_pool.host
|
||
end
|
||
|
||
# The replica set primary's port.
|
||
#
|
||
# @return [Integer]
|
||
def port
|
||
self.primary_pool.port
|
||
end
|
||
|
||
def nodes
|
||
warn "ReplSetConnection#nodes is DEPRECATED and will be removed in v2.0. " +
|
||
"Please use ReplSetConnection#seeds instead."
|
||
@seeds
|
||
end
|
||
|
||
# Determine whether we're reading from a primary node. If false,
|
||
# this connection connects to a secondary node and @read_secondaries is true.
|
||
#
|
||
# @return [Boolean]
|
||
def read_primary?
|
||
self.read_pool == self.primary_pool
|
||
end
|
||
alias :primary? :read_primary?
|
||
|
||
def read_preference
|
||
@read
|
||
end
|
||
|
||
# Close the connection to the database.
|
||
def close
|
||
@connected = false
|
||
|
||
if @refresh_thread
|
||
@refresh_thread = nil
|
||
end
|
||
|
||
@manager.close if @manager
|
||
@sockets_to_pools.clear
|
||
@threads_to_sockets.clear
|
||
end
|
||
|
||
# If a ConnectionFailure is raised, this method will be called
|
||
# to close the connection and reset connection values.
|
||
# @deprecated
|
||
def reset_connection
|
||
close
|
||
warn "ReplSetConnection#reset_connection is now deprecated and will be removed in v2.0. " +
|
||
"Use ReplSetConnection#close instead."
|
||
end
|
||
|
||
# Returns +true+ if it's okay to read from a secondary node.
|
||
# Since this is a replica set, this must always be true.
|
||
#
|
||
# This method exist primarily so that Cursor objects will
|
||
# generate query messages with a slaveOkay value of +true+.
|
||
#
|
||
# @return [Boolean] +true+
|
||
def slave_ok?
|
||
true
|
||
end
|
||
|
||
def authenticate_pools
|
||
self.primary_pool.authenticate_existing
|
||
self.secondary_pools.each do |pool|
|
||
pool.authenticate_existing
|
||
end
|
||
end
|
||
|
||
def logout_pools(db)
|
||
self.primary_pool.logout_existing(db)
|
||
self.secondary_pools.each do |pool|
|
||
pool.logout_existing(db)
|
||
end
|
||
end
|
||
|
||
def get_local_reader
|
||
self.connections ||= {}
|
||
if !connected? && self.connections[self.object_id]
|
||
self.connections[self.object_id]
|
||
else
|
||
self.connections[self.object_id] = {}
|
||
end
|
||
socket = self.connections[self.object_id][:reader] ||= checkout_reader
|
||
if self.read_pool != @sockets_to_pools[socket]
|
||
checkin(socket)
|
||
socket = self.connections[self.object_id][:reader] = checkout_reader
|
||
end
|
||
|
||
@threads_to_sockets[Thread.current][:reader] = socket
|
||
end
|
||
|
||
def get_local_writer
|
||
self.connections ||= {}
|
||
if !connected? && self.connections[self.object_id]
|
||
self.connections[self.object_id]
|
||
else
|
||
self.connections[self.object_id] = {}
|
||
end
|
||
socket = self.connections[self.object_id][:writer] ||= checkout_writer
|
||
if self.primary_pool != @sockets_to_pools[socket]
|
||
checkin(socket)
|
||
socket = self.connections[self.object_id][:writer] = checkout_writer
|
||
end
|
||
@threads_to_sockets[Thread.current][:writer] = socket
|
||
end
|
||
|
||
# Allow the current thread’s connection to return to the pool.
|
||
#
|
||
# Calling this method allows the socket that has been reserved
|
||
# for this thread to be returned to the pool. Other threads will
|
||
# then be able to re-use that socket. If your application uses many
|
||
# threads, or has long-running threads that infrequently perform MongoDB
|
||
# operations, then judicious use of this method can lead to performance gains.
|
||
# Care should be taken, however, to make sure that end_request is not called
|
||
# in the middle of a sequence of operations in which ordering is important. This
|
||
# could lead to unexpected results.
|
||
#
|
||
# One important case is when a thread is dying permanently. It is best to call
|
||
# end_request when you know a thread is finished, as otherwise its socket will
|
||
# not be reclaimed.
|
||
def end_request
|
||
if socket = self.connections[self.object_id][:reader]
|
||
checkin(socket)
|
||
end
|
||
|
||
if socket = self.connections[self.object_id][:writer]
|
||
checkin(socket)
|
||
end
|
||
end
|
||
|
||
# Used to close, check in, or refresh sockets held
|
||
# in thread-local variables.
|
||
def local_socket_done(socket)
|
||
if self.connections[self.object_id][:reader] == socket
|
||
if self.read_pool.sockets_low? ||
|
||
self.read_pool != @sockets_to_pools[socket]
|
||
checkin(socket)
|
||
self.connections[self.object_id][:reader] = nil
|
||
end
|
||
end
|
||
|
||
if self.connections[self.object_id][:writer] == socket
|
||
if self.primary_pool &&
|
||
(self.primary_pool.sockets_low? ||
|
||
self.primary_pool != @sockets_to_pools[socket])
|
||
checkin(socket)
|
||
self.connections[self.object_id][:writer] = nil
|
||
end
|
||
end
|
||
|
||
if (Time.now - @last_cleanup) > CLEANUP_INTERVAL &&
|
||
@cleanup_lock.try_lock
|
||
@threads_to_sockets.each do |thread, sockets|
|
||
if !thread.alive?
|
||
checkin(sockets[:reader])
|
||
checkin(sockets[:writer])
|
||
@threads_to_sockets.delete(thread)
|
||
end
|
||
end
|
||
|
||
@cleanup_lock.unlock
|
||
end
|
||
end
|
||
|
||
# Checkout a socket for reading (i.e., a secondary node).
|
||
# Note that @read_pool might point to the primary pool
|
||
# if no read pool has been defined.
|
||
def checkout_reader
|
||
connect unless connected?
|
||
socket = get_socket_from_pool(self.read_pool)
|
||
|
||
if !socket
|
||
connect
|
||
socket = get_socket_from_pool(self.primary_pool)
|
||
end
|
||
|
||
if socket
|
||
socket
|
||
else
|
||
raise ConnectionFailure.new("Could not connect to a node for reading.")
|
||
end
|
||
end
|
||
|
||
# Checkout a socket for writing (i.e., a primary node).
|
||
def checkout_writer
|
||
connect unless connected?
|
||
socket = get_socket_from_pool(self.primary_pool)
|
||
|
||
if !socket
|
||
connect
|
||
socket = get_socket_from_pool(self.primary_pool)
|
||
end
|
||
|
||
if socket
|
||
socket
|
||
else
|
||
raise ConnectionFailure.new("Could not connect to primary node.")
|
||
end
|
||
end
|
||
|
||
def checkin(socket)
|
||
if pool = @sockets_to_pools[socket]
|
||
pool.checkin(socket)
|
||
if !@sockets_to_pools[socket]
|
||
close_socket(socket)
|
||
end
|
||
elsif socket
|
||
close_socket(socket)
|
||
end
|
||
|
||
@sockets_to_pools.delete(socket)
|
||
|
||
# Refresh synchronously every @refresh_interval seconds
|
||
# if synchronous refresh mode is enabled.
|
||
if @refresh_mode == :sync &&
|
||
((Time.now - @last_refresh) > @refresh_interval)
|
||
refresh
|
||
@last_refresh = Time.now
|
||
end
|
||
end
|
||
|
||
def close_socket(socket)
|
||
begin
|
||
socket.close
|
||
rescue IOError
|
||
log(:info, "Tried to close socket #{socket} but already closed.")
|
||
end
|
||
end
|
||
|
||
def get_socket_from_pool(pool)
|
||
begin
|
||
if pool
|
||
socket = pool.checkout
|
||
@sockets_to_pools[socket] = pool
|
||
socket
|
||
end
|
||
rescue ConnectionFailure => ex
|
||
log(:info, "Failed to checkout from #{pool} with #{ex.class}; #{ex.message}")
|
||
return nil
|
||
end
|
||
end
|
||
|
||
def arbiters
|
||
@manager.arbiters.nil? ? [] : @manager.arbiters
|
||
end
|
||
|
||
def primary
|
||
@manager.primary
|
||
end
|
||
|
||
# Note: might want to freeze these after connecting.
|
||
def secondaries
|
||
@manager.secondaries
|
||
end
|
||
|
||
def hosts
|
||
@manager.hosts
|
||
end
|
||
|
||
def primary_pool
|
||
@manager.primary_pool
|
||
end
|
||
|
||
def read_pool
|
||
@manager.read_pool
|
||
end
|
||
|
||
def secondary_pools
|
||
@manager.secondary_pools
|
||
end
|
||
|
||
def tag_map
|
||
@manager.tag_map
|
||
end
|
||
|
||
def max_bson_size
|
||
@manager.max_bson_size
|
||
end
|
||
|
||
private
|
||
|
||
# Generic initialization code.
|
||
def setup(opts)
|
||
# Default maximum BSON object size
|
||
@max_bson_size = Mongo::DEFAULT_MAX_BSON_SIZE
|
||
|
||
@safe_mutex_lock = Mutex.new
|
||
@safe_mutexes = Hash.new {|hash, key| hash[key] = Mutex.new}
|
||
|
||
# Determine whether to use SSL.
|
||
@ssl = opts.fetch(:ssl, false)
|
||
if @ssl
|
||
@socket_class = Mongo::SSLSocket
|
||
else
|
||
@socket_class = ::TCPSocket
|
||
end
|
||
|
||
# Authentication objects
|
||
@auths = opts.fetch(:auths, [])
|
||
|
||
# Lock for request ids.
|
||
@id_lock = Mutex.new
|
||
|
||
# Pool size and timeout.
|
||
@pool_size = opts[:pool_size] || 1
|
||
if opts[:timeout]
|
||
warn "The :timeout option has been deprecated " +
|
||
"and will be removed in the 2.0 release. Use :pool_timeout instead."
|
||
end
|
||
@pool_timeout = opts[:pool_timeout] || opts[:timeout] || 5.0
|
||
|
||
# Timeout on socket read operation.
|
||
@op_timeout = opts[:op_timeout] || nil
|
||
|
||
# Timeout on socket connect.
|
||
@connect_timeout = opts[:connect_timeout] || nil
|
||
|
||
# Mutex for synchronizing pool access
|
||
# TODO: remove this.
|
||
@connection_mutex = Mutex.new
|
||
|
||
# Global safe option. This is false by default.
|
||
@safe = opts[:safe] || false
|
||
|
||
# Condition variable for signal and wait
|
||
@queue = ConditionVariable.new
|
||
|
||
@logger = opts[:logger] || nil
|
||
|
||
# Clean up connections to dead threads.
|
||
@last_cleanup = Time.now
|
||
@cleanup_lock = Mutex.new
|
||
|
||
if @logger
|
||
write_logging_startup_message
|
||
end
|
||
|
||
should_connect = opts.fetch(:connect, true)
|
||
connect if should_connect
|
||
end
|
||
|
||
# Given a pool manager, update this connection's
|
||
# view of the replica set.
|
||
def update_config(new_manager)
|
||
old_manager = @manager
|
||
@manager = new_manager
|
||
@seeds = @manager.seeds.dup
|
||
@sockets_to_pools.clear
|
||
@refresh_version += 1
|
||
end
|
||
|
||
# If we're using async refresh, start
|
||
# a background thread to run the refresh method
|
||
# every @refresh_interval seconds.
|
||
def initiate_refresh_mode
|
||
if @refresh_mode == :async
|
||
return if @refresh_thread && @refresh_thread.alive?
|
||
@refresh_thread = Thread.new do
|
||
while true && @connected do
|
||
sleep(@refresh_interval)
|
||
refresh
|
||
end
|
||
end
|
||
end
|
||
|
||
@last_refresh = Time.now
|
||
end
|
||
|
||
# Checkout a socket connected to a node with one of
|
||
# the provided tags. If no such node exists, raise
|
||
# an exception.
|
||
#
|
||
# NOTE: will be available in driver release v2.0.
|
||
def checkout_tagged(tags)
|
||
tags.each do |k, v|
|
||
pool = self.tag_map[{k.to_s => v}]
|
||
if pool
|
||
socket = pool.checkout
|
||
@sockets_to_pools[socket] = pool
|
||
return socket
|
||
end
|
||
end
|
||
|
||
raise NodeWithTagsNotFound,
|
||
"Could not find a connection tagged with #{tags}."
|
||
end
|
||
|
||
# Checkin a socket used for reading.
|
||
def checkin_reader(socket)
|
||
warn "ReplSetConnection#checkin_writer is deprecated and will be removed " +
|
||
"in driver v2.0. Use ReplSetConnection#checkin instead."
|
||
checkin(socket)
|
||
end
|
||
|
||
# Checkin a socket used for writing.
|
||
def checkin_writer(socket)
|
||
warn "ReplSetConnection#checkin_writer is deprecated and will be removed " +
|
||
"in driver v2.0. Use ReplSetConnection#checkin instead."
|
||
checkin(socket)
|
||
end
|
||
end
|
||
end
|