Skip to content

Commit a2f97f9

Browse files
ajdavisajdavis
committed
PYTHON-1105 Configurable heartbeatFrequencyMS.
1 parent 7d81a01 commit a2f97f9

File tree

8 files changed

+62
-6
lines changed

8 files changed

+62
-6
lines changed

‎pymongo/client_options.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,8 @@ def __init__(self, username, password, database, options):
140140
self.__write_concern = _parse_write_concern(options)
141141
self.__read_concern = _parse_read_concern(options)
142142
self.__connect = options.get('connect')
143+
self.__heartbeat_frequency = options.get(
144+
'heartbeatfrequencyms', common.HEARTBEAT_FREQUENCY)
143145

144146
@property
145147
def _options(self):
@@ -171,6 +173,11 @@ def server_selection_timeout(self):
171173
"""The server selection timeout for this instance in seconds."""
172174
return self.__server_selection_timeout
173175

176+
@property
177+
def heartbeat_frequency(self):
178+
"""The monitoring frequency in seconds."""
179+
return self.__heartbeat_frequency
180+
174181
@property
175182
def pool_options(self):
176183
"""A :class:`~pymongo.pool.PoolOptions` instance."""

‎pymongo/common.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -458,6 +458,7 @@ def validate_ok_for_update(update):
458458
'sockettimeoutms': validate_timeout_or_none,
459459
'waitqueuetimeoutms': validate_timeout_or_none,
460460
'serverselectiontimeoutms': validate_timeout_or_zero,
461+
'heartbeatfrequencyms': validate_timeout_or_none,
461462
'maxidletimems': validate_timeout_or_none,
462463
}
463464

‎pymongo/mongo_client.py‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,9 @@ def __init__(
159159
- `socketKeepAlive`: (boolean) Whether to send periodic keep-alive
160160
packets on connected sockets. Defaults to ``False`` (do not send
161161
keep-alive packets).
162+
- `heartbeatFrequencyMS`: (optional) The number of milliseconds
163+
between periodic server checks, or None to accept the default
164+
frequency of 10 seconds.
162165
- `event_listeners`: a list or tuple of event listeners. See
163166
:mod:`~pymongo.monitoring` for details.
164167
@@ -389,7 +392,8 @@ def __init__(
389392
monitor_class=monitor_class,
390393
condition_class=condition_class,
391394
local_threshold_ms=options.local_threshold_ms,
392-
server_selection_timeout=options.server_selection_timeout)
395+
server_selection_timeout=options.server_selection_timeout,
396+
heartbeat_frequency=options.heartbeat_frequency)
393397

394398
self._topology = Topology(self._topology_settings)
395399
if connect:

‎pymongo/monitor.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ def target():
5858
return True
5959

6060
executor = periodic_executor.PeriodicExecutor(
61-
interval=common.HEARTBEAT_FREQUENCY,
61+
interval=self._settings.heartbeat_frequency,
6262
min_interval=common.MIN_HEARTBEAT_INTERVAL,
6363
target=target,
6464
name="pymongo_server_monitor_thread")

‎pymongo/settings.py‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@
1717
import threading
1818

1919
from bson.objectid import ObjectId
20-
from pymongo import monitor, pool
20+
from pymongo import common, monitor, pool
2121
from pymongo.common import LOCAL_THRESHOLD_MS, SERVER_SELECTION_TIMEOUT
22+
from pymongo.errors import ConfigurationError
2223
from pymongo.topology_description import TOPOLOGY_TYPE
2324
from pymongo.pool import PoolOptions
2425
from pymongo.server_description import ServerDescription
@@ -33,11 +34,16 @@ def __init__(self,
3334
monitor_class=None,
3435
condition_class=None,
3536
local_threshold_ms=LOCAL_THRESHOLD_MS,
36-
server_selection_timeout=SERVER_SELECTION_TIMEOUT):
37+
server_selection_timeout=SERVER_SELECTION_TIMEOUT,
38+
heartbeat_frequency=common.HEARTBEAT_FREQUENCY):
3739
"""Represent MongoClient's configuration.
3840
3941
Take a list of (host, port) pairs and optional replica set name.
4042
"""
43+
if heartbeat_frequency < common.MIN_HEARTBEAT_INTERVAL:
44+
raise ConfigurationError("%s cannot be less than %.1f" % (
45+
'heartbeatFrequencyMS', common.MIN_HEARTBEAT_INTERVAL))
46+
4147
self._seeds = seeds or [('localhost', 27017)]
4248
self._replica_set_name = replica_set_name
4349
self._pool_class = pool_class or pool.Pool
@@ -46,6 +52,7 @@ def __init__(self,
4652
self._condition_class = condition_class or threading.Condition
4753
self._local_threshold_ms = local_threshold_ms
4854
self._server_selection_timeout = server_selection_timeout
55+
self._heartbeat_frequency = heartbeat_frequency
4956
self._direct = (len(self._seeds) == 1 and not replica_set_name)
5057
self._topology_id = ObjectId()
5158

@@ -82,6 +89,10 @@ def local_threshold_ms(self):
8289
def server_selection_timeout(self):
8390
return self._server_selection_timeout
8491

92+
@property
93+
def heartbeat_frequency(self):
94+
return self._heartbeat_frequency
95+
8596
@property
8697
def direct(self):
8798
"""Connect directly to a single server, or use a set of servers?

‎test/__init__.py‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,24 +58,31 @@ class client_knobs(object):
5858
def __init__(
5959
self,
6060
heartbeat_frequency=None,
61+
min_heartbeat_interval=None,
6162
kill_cursor_frequency=None,
6263
events_queue_frequency=None):
6364
self.heartbeat_frequency = heartbeat_frequency
65+
self.min_heartbeat_interval = min_heartbeat_interval
6466
self.kill_cursor_frequency = kill_cursor_frequency
6567
self.events_queue_frequency = events_queue_frequency
6668

6769
self.old_heartbeat_frequency = None
70+
self.old_min_heartbeat_interval = None
6871
self.old_kill_cursor_frequency = None
6972
self.old_events_queue_frequency = None
7073

7174
def enable(self):
7275
self.old_heartbeat_frequency = common.HEARTBEAT_FREQUENCY
76+
self.old_min_heartbeat_interval = common.MIN_HEARTBEAT_INTERVAL
7377
self.old_kill_cursor_frequency = common.KILL_CURSOR_FREQUENCY
7478
self.old_events_queue_frequency = common.EVENTS_QUEUE_FREQUENCY
7579

7680
if self.heartbeat_frequency is not None:
7781
common.HEARTBEAT_FREQUENCY = self.heartbeat_frequency
7882

83+
if self.min_heartbeat_interval is not None:
84+
common.MIN_HEARTBEAT_INTERVAL = self.min_heartbeat_interval
85+
7986
if self.kill_cursor_frequency is not None:
8087
common.KILL_CURSOR_FREQUENCY = self.kill_cursor_frequency
8188

@@ -87,6 +94,7 @@ def __enter__(self):
8794

8895
def disable(self):
8996
common.HEARTBEAT_FREQUENCY = self.old_heartbeat_frequency
97+
common.MIN_HEARTBEAT_INTERVAL = self.old_min_heartbeat_interval
9098
common.KILL_CURSOR_FREQUENCY = self.old_kill_cursor_frequency
9199
common.EVENTS_QUEUE_FREQUENCY = self.old_events_queue_frequency
92100

@@ -358,7 +366,8 @@ def setUp(self):
358366
super(MockClientTest, self).setUp()
359367

360368
self.client_knobs = client_knobs(
361-
heartbeat_frequency=0.001)
369+
heartbeat_frequency=0.001,
370+
min_heartbeat_interval=0.001)
362371

363372
self.client_knobs.enable()
364373

‎test/test_client.py‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
OperationFailure,
4141
NetworkTimeout,
4242
InvalidURI)
43+
from pymongo.monitoring import ServerHeartbeatStartedEvent
4344
from pymongo.mongo_client import MongoClient
4445
from pymongo.pool import SocketInfo
4546
from pymongo.read_preferences import ReadPreference
@@ -61,6 +62,7 @@
6162
from test.pymongo_mocks import MockClient
6263
from test.utils import (assertRaisesExactly,
6364
delay,
65+
HeartbeatEventListener,
6466
remove_all_users,
6567
server_is_master_with_slave,
6668
get_pool,
@@ -69,6 +71,7 @@
6971
wait_until,
7072
rs_or_single_client,
7173
rs_or_single_client_noauth,
74+
single_client,
7275
lazy_client_trial,
7376
NTHREADS)
7477

@@ -899,6 +902,25 @@ def test_stale_getmore(self):
899902
101, 1234, client.codec_options),
900903
address=('not-a-member', 27017))
901904

905+
def test_heartbeat_frequency_ms(self):
906+
listener = HeartbeatEventListener()
907+
uri = "mongodb://%s:%d/?heartbeatFrequencyMS=500" % (host, port)
908+
client = single_client(uri, event_listeners=[listener])
909+
time.sleep(3)
910+
started_events = [r for r in listener.results
911+
if isinstance(r, ServerHeartbeatStartedEvent)]
912+
913+
# Frequency is 500ms, expect 5 or 6 events in 3 sec, but be forgiving.
914+
self.assertGreaterEqual(len(started_events), 4)
915+
client.close()
916+
917+
def test_small_heartbeat_frequency_ms(self):
918+
uri = "mongodb://example/?heartbeatFrequencyMS=499"
919+
with self.assertRaises(ConfigurationError) as context:
920+
MongoClient(uri)
921+
922+
self.assertIn('heartbeatFrequencyMS', str(context.exception))
923+
902924

903925
class TestExhaustCursor(IntegrationTest):
904926
"""Test that clients properly handle errors from exhaust cursors."""

‎test/test_heartbeat_monitoring.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,9 @@ def tearDown(cls):
7171
monitoring._LISTENERS = cls.saved_listeners
7272

7373
def create_mock_monitor(self, responses, uri, expected_results):
74-
with client_knobs(heartbeat_frequency=0.1, events_queue_frequency=0.1):
74+
with client_knobs(heartbeat_frequency=0.1,
75+
min_heartbeat_interval=0.1,
76+
events_queue_frequency=0.1):
7577
class MockMonitor(Monitor):
7678
def _check_with_socket(self, sock_info):
7779
if isinstance(responses[1], Exception):

0 commit comments

Comments
 (0)