bfd29252f5
This patch modifies the way message markers are generated and used, such that Marconi can guarantee FIFO for a single message producer posting to a single queue (FIFO for multiple producers is not guaranteed.) At the same time, these changes guarantee that observer clients will recieve messages once-and-only once by removing race conditions inherent in timestamp-based markers. Along the way, some technical debt was also addressed, particulary regarding style, as well as some minor optimizations. A new service, marconi-mongo-gc, was also added, and is required when using the MongoDB storage driver for Marconi. This service was necessary due to the special requirement that at least the most recent message always remain in each queue, which is an a-priori assumption upon which the FIFO/pagination algorithm is based, and arises from the particular constraints imposed by MongoDB's semantics. Note: While implementing this blueprint, many calculated tradeoffs were made in an attempt to balance performance, risk, readability, and maintainability. The goal was to create a resonable baseline implementation that can be iterated upon pending comprehensive system and performance testing. Due to the many subtleties of solving the FIFO/once-and-only-once problem for the MongoDB driver, future contributors should excercise extreme caution when modifying the algorithm introduced in this patch. Changes include: * Align text in comments * Add counter to queue, messages * Markers are now converted over to using monotonic counter * Handle DuplicateKeyError * Return resources in body as a response to a message POST * Added mongo driver claims tests * Return 503 when no messages were enqueued due to marker conflict * Added backoff sleep between retries * Added marconi-mongo-gc service. This is a new required servi Implements: blueprint message-pagination Change-Id: Ifa0bb9e1bc393545adc4c804d14c6eb2df01848c
104 lines
2.6 KiB
Python
104 lines
2.6 KiB
Python
# Copyright (c) 2013 Rackspace Hosting, 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.
|
|
|
|
import atexit
|
|
import random
|
|
import sys
|
|
import termios
|
|
import time
|
|
|
|
from marconi import bootstrap
|
|
from marconi.common import config
|
|
from marconi.openstack.common import log as logging
|
|
|
|
PROJECT_CFG = config.project('marconi')
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
def _fail(returncode, ex):
|
|
"""Handles terminal errors.
|
|
|
|
:param returncode: process return code to pass to sys.exit
|
|
:param ex: the error that occurred
|
|
"""
|
|
|
|
LOG.exception(ex)
|
|
sys.stderr.write('ERROR: %s\n' % ex)
|
|
sys.exit(returncode)
|
|
|
|
|
|
def _enable_echo(enable):
|
|
"""Enables or disables terminal echo.
|
|
|
|
:param enable: pass True to enable echo, False to disable
|
|
"""
|
|
|
|
fd = sys.stdin.fileno()
|
|
new = termios.tcgetattr(fd)
|
|
if enable:
|
|
new[3] |= termios.ECHO
|
|
else:
|
|
new[3] &= ~termios.ECHO
|
|
|
|
termios.tcsetattr(fd, termios.TCSANOW, new)
|
|
|
|
|
|
def run():
|
|
"""Entry point to start marconi-gc.
|
|
|
|
Operators should run 2-3 instances on different
|
|
boxes for fault-tolerance.
|
|
|
|
Note: This call blocks until the process is killed
|
|
or interrupted.
|
|
"""
|
|
|
|
atexit.register(_enable_echo, True)
|
|
_enable_echo(False)
|
|
|
|
try:
|
|
logging.setup('marconi')
|
|
PROJECT_CFG.load(args=sys.argv[1:])
|
|
|
|
info = _('Starting marconi-gc')
|
|
print(info + _('. Use CTRL+C to exit...\n'))
|
|
LOG.info(info)
|
|
|
|
boot = bootstrap.Bootstrap(cli_args=sys.argv[1:])
|
|
storage_driver = boot.storage
|
|
gc_interval = storage_driver.gc_interval
|
|
|
|
# NOTE(kgriffs): Don't want all garbage collector
|
|
# instances running at the same time (will peg the DB).
|
|
offset = random.random() * gc_interval
|
|
time.sleep(offset)
|
|
|
|
while True:
|
|
storage_driver.gc()
|
|
time.sleep(gc_interval)
|
|
|
|
except NotImplementedError as ex:
|
|
print('The configured storage driver does not support GC.\n')
|
|
|
|
LOG.exception(ex)
|
|
print('')
|
|
|
|
except KeyboardInterrupt:
|
|
LOG.info('Terminating marconi-gc')
|
|
|
|
except Exception as ex:
|
|
_fail(1, ex)
|