135 lines
4.5 KiB
Python
135 lines
4.5 KiB
Python
#
|
|
# Copyright 2012 New Dream Network, LLC (DreamHost)
|
|
#
|
|
# 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.
|
|
"""Storage backend management
|
|
"""
|
|
|
|
from oslo_config import cfg
|
|
from oslo_log import log
|
|
import six
|
|
import six.moves.urllib.parse as urlparse
|
|
from stevedore import driver
|
|
import tenacity
|
|
|
|
from panko import utils
|
|
|
|
LOG = log.getLogger(__name__)
|
|
|
|
|
|
OPTS = [
|
|
cfg.IntOpt('event_time_to_live',
|
|
default=-1,
|
|
help=("Number of seconds that events are kept "
|
|
"in the database for (<= 0 means forever).")),
|
|
cfg.IntOpt('events_delete_batch_size',
|
|
default=0,
|
|
min=0,
|
|
help=("Number of events to be deleted in one iteration "
|
|
"from the database for (0 means all).")),
|
|
cfg.StrOpt('event_connection',
|
|
secret=True,
|
|
deprecated_for_removal=True,
|
|
help='The connection string used to connect '
|
|
'to the event database - rather use ${database.connection}'),
|
|
]
|
|
|
|
|
|
class StorageUnknownWriteError(Exception):
|
|
"""Error raised when an unknown error occurs while recording."""
|
|
|
|
|
|
class StorageBadVersion(Exception):
|
|
"""Error raised when the storage backend version is not good enough."""
|
|
|
|
|
|
class StorageBadAggregate(Exception):
|
|
"""Error raised when an aggregate is unacceptable to storage backend."""
|
|
code = 400
|
|
|
|
|
|
class InvalidMarker(Exception):
|
|
"""Invalid pagination marker parameters"""
|
|
|
|
|
|
def get_connection_from_config(conf):
|
|
retries = conf.database.max_retries
|
|
|
|
@tenacity.retry(
|
|
reraise=True,
|
|
wait=tenacity.wait_fixed(conf.database.retry_interval),
|
|
stop=(tenacity.stop_after_attempt(retries) if retries >= 0
|
|
else tenacity.stop_never)
|
|
)
|
|
def _inner():
|
|
url = (conf.database.connection or
|
|
getattr(conf.database, 'event_connection', None))
|
|
return get_connection(url, conf)
|
|
|
|
return _inner()
|
|
|
|
|
|
def get_connection(url, conf):
|
|
"""Return an open connection to the database."""
|
|
connection_scheme = urlparse.urlparse(url).scheme
|
|
# SqlAlchemy connections specify may specify a 'dialect' or
|
|
# 'dialect+driver'. Handle the case where driver is specified.
|
|
engine_name = connection_scheme.split('+')[0]
|
|
# NOTE: translation not applied bug #1446983
|
|
LOG.debug('looking for %(name)r driver in panko.storage',
|
|
{'name': engine_name})
|
|
mgr = driver.DriverManager('panko.storage', engine_name)
|
|
return mgr.driver(url, conf)
|
|
|
|
|
|
class EventFilter(object):
|
|
"""Properties for building an Event query.
|
|
|
|
:param start_timestamp: UTC start datetime (mandatory)
|
|
:param end_timestamp: UTC end datetime (mandatory)
|
|
:param event_type: the name of the event. None for all.
|
|
:param message_id: the message_id of the event. None for all.
|
|
:param admin_proj: the project_id of admin role. None if non-admin user.
|
|
:param traits_filter: the trait filter dicts, all of which are optional.
|
|
This parameter is a list of dictionaries that specify trait values:
|
|
|
|
.. code-block:: python
|
|
|
|
{'key': <key>,
|
|
'string': <value>,
|
|
'integer': <value>,
|
|
'datetime': <value>,
|
|
'float': <value>,
|
|
'op': <eq, lt, le, ne, gt or ge> }
|
|
"""
|
|
|
|
def __init__(self, start_timestamp=None, end_timestamp=None,
|
|
event_type=None, message_id=None, traits_filter=None,
|
|
admin_proj=None):
|
|
self.start_timestamp = utils.sanitize_timestamp(start_timestamp)
|
|
self.end_timestamp = utils.sanitize_timestamp(end_timestamp)
|
|
self.message_id = message_id
|
|
self.event_type = event_type
|
|
self.traits_filter = traits_filter or []
|
|
self.admin_proj = admin_proj
|
|
|
|
def __repr__(self):
|
|
return ("<EventFilter(start_timestamp: %s,"
|
|
" end_timestamp: %s,"
|
|
" event_type: %s,"
|
|
" traits: %s)>" %
|
|
(self.start_timestamp,
|
|
self.end_timestamp,
|
|
self.event_type,
|
|
six.text_type(self.traits_filter)))
|