3d3ed34f44
Documentation, including a list of metrics reported and their semantics,
is in the Admin Guide in a new section, "Reporting Metrics to StatsD".
An optional "metric prefix" may be configured which will be prepended to
every metric name sent to StatsD.
Here is the rationale for doing a deep integration like this versus only
sending metrics to StatsD in middleware. It's the only way to report
some internal activities of Swift in a real-time manner. So to have one
way of reporting to StatsD and one place/style of configuration, even
some things (like, say, timing of PUT requests into the proxy-server)
which could be logged via middleware are consistently logged the same
way (deep integration via the logger delegate methods).
When log_statsd_host is configured, get_logger() injects a
swift.common.utils.StatsdClient object into the logger as
logger.statsd_client. Then a set of delegate methods on LogAdapter
either pass through to the StatsdClient object or become no-ops. This
allows StatsD logging to look like:
self.logger.increment('some.metric.here')
and do the right thing in all cases and with no messy conditional logic.
I wanted to use the pystatsd module for the StatsD client, but the
version on PyPi is lagging the git repo (and is missing both the prefix
functionality and timing_since() method). So I wrote my
swift.common.utils.StatsdClient. The interface is the same as
pystatsd.Client, but the code was written from scratch. It's pretty
simple, and the tests I added cover it. This also frees Swift from an
optional dependency on the pystatsd module, making this feature easier
to enable.
There's test coverage for the new code and all existing tests continue
to pass.
Refactored out _one_audit_pass() method in swift/account/auditor.py and
swift/container/auditor.py.
Fixed some misc. PEP8 violations.
Misc test cleanups and refactorings (particularly the way "fake logging"
is handled).
Change-Id: Ie968a9ae8771f59ee7591e2ae11999c44bfe33b2
168 lines
6.9 KiB
Python
168 lines
6.9 KiB
Python
# Copyright (c) 2010-2012 OpenStack, LLC.
|
|
#
|
|
# 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.
|
|
|
|
from random import random
|
|
from sys import exc_info
|
|
from time import time
|
|
from urllib import quote
|
|
|
|
from eventlet import sleep, Timeout
|
|
from webob import Request
|
|
|
|
from swift.common.daemon import Daemon
|
|
from swift.common.internal_client import InternalClient
|
|
from swift.common.utils import get_logger
|
|
from swift.common.http import HTTP_NOT_FOUND, HTTP_CONFLICT, \
|
|
HTTP_PRECONDITION_FAILED
|
|
|
|
try:
|
|
import simplejson as json
|
|
except ImportError:
|
|
import json
|
|
|
|
|
|
class ObjectExpirer(Daemon):
|
|
"""
|
|
Daemon that queries the internal hidden expiring_objects_account to
|
|
discover objects that need to be deleted.
|
|
|
|
:param conf: The daemon configuration.
|
|
"""
|
|
|
|
def __init__(self, conf):
|
|
self.conf = conf
|
|
self.logger = get_logger(conf, log_route='object-expirer')
|
|
self.interval = int(conf.get('interval') or 300)
|
|
self.expiring_objects_account = \
|
|
(conf.get('auto_create_account_prefix') or '.') + \
|
|
'expiring_objects'
|
|
conf_path = conf.get('__file__') or '/etc/swift/object-expirer.conf'
|
|
request_tries = int(conf.get('request_tries') or 3)
|
|
self.swift = InternalClient(conf_path, 'Swift Object Expirer',
|
|
request_tries)
|
|
self.report_interval = int(conf.get('report_interval') or 300)
|
|
self.report_first_time = self.report_last_time = time()
|
|
self.report_objects = 0
|
|
|
|
def report(self, final=False):
|
|
"""
|
|
Emits a log line report of the progress so far, or the final progress
|
|
is final=True.
|
|
|
|
:param final: Set to True for the last report once the expiration pass
|
|
has completed.
|
|
"""
|
|
if final:
|
|
elapsed = time() - self.report_first_time
|
|
self.logger.info(_('Pass completed in %ds; %d objects expired') %
|
|
(elapsed, self.report_objects))
|
|
elif time() - self.report_last_time >= self.report_interval:
|
|
elapsed = time() - self.report_first_time
|
|
self.logger.info(_('Pass so far %ds; %d objects expired') %
|
|
(elapsed, self.report_objects))
|
|
self.report_last_time = time()
|
|
|
|
def run_once(self, *args, **kwargs):
|
|
"""
|
|
Executes a single pass, looking for objects to expire.
|
|
|
|
:param args: Extra args to fulfill the Daemon interface; this daemon
|
|
has no additional args.
|
|
:param kwargs: Extra keyword args to fulfill the Daemon interface; this
|
|
daemon has no additional keyword args.
|
|
"""
|
|
self.report_first_time = self.report_last_time = time()
|
|
self.report_objects = 0
|
|
try:
|
|
self.logger.debug(_('Run begin'))
|
|
containers, objects = \
|
|
self.swift.get_account_info(self.expiring_objects_account)
|
|
self.logger.info(_('Pass beginning; %s possible containers; %s '
|
|
'possible objects') % (containers, objects))
|
|
for c in self.swift.iter_containers(self.expiring_objects_account):
|
|
container = c['name']
|
|
timestamp = int(container)
|
|
if timestamp > int(time()):
|
|
break
|
|
for o in self.swift.iter_objects(self.expiring_objects_account,
|
|
container):
|
|
obj = o['name']
|
|
timestamp, actual_obj = obj.split('-', 1)
|
|
timestamp = int(timestamp)
|
|
if timestamp > int(time()):
|
|
break
|
|
start_time = time()
|
|
try:
|
|
self.delete_actual_object(actual_obj, timestamp)
|
|
self.swift.delete_object(self.expiring_objects_account,
|
|
container, obj)
|
|
self.report_objects += 1
|
|
self.logger.increment('objects')
|
|
except (Exception, Timeout), err:
|
|
self.logger.increment('errors')
|
|
self.logger.exception(
|
|
_('Exception while deleting object %s %s %s') %
|
|
(container, obj, str(err)))
|
|
self.logger.timing_since('timing', start_time)
|
|
self.report()
|
|
try:
|
|
self.swift.delete_container(
|
|
self.expiring_objects_account, container,
|
|
acceptable_statuses=(2, HTTP_NOT_FOUND,
|
|
HTTP_CONFLICT))
|
|
except (Exception, Timeout), err:
|
|
self.logger.exception(
|
|
_('Exception while deleting container %s %s') %
|
|
(container, str(err)))
|
|
self.logger.debug(_('Run end'))
|
|
self.report(final=True)
|
|
except (Exception, Timeout):
|
|
self.logger.exception(_('Unhandled exception'))
|
|
|
|
def run_forever(self, *args, **kwargs):
|
|
"""
|
|
Executes passes forever, looking for objects to expire.
|
|
|
|
:param args: Extra args to fulfill the Daemon interface; this daemon
|
|
has no additional args.
|
|
:param kwargs: Extra keyword args to fulfill the Daemon interface; this
|
|
daemon has no additional keyword args.
|
|
"""
|
|
sleep(random() * self.interval)
|
|
while True:
|
|
begin = time()
|
|
try:
|
|
self.run_once()
|
|
except (Exception, Timeout):
|
|
self.logger.exception(_('Unhandled exception'))
|
|
elapsed = time() - begin
|
|
if elapsed < self.interval:
|
|
sleep(random() * (self.interval - elapsed))
|
|
|
|
def delete_actual_object(self, actual_obj, timestamp):
|
|
"""
|
|
Deletes the end-user object indicated by the actual object name given
|
|
'<account>/<container>/<object>' if and only if the X-Delete-At value
|
|
of the object is exactly the timestamp given.
|
|
|
|
:param actual_obj: The name of the end-user object to delete:
|
|
'<account>/<container>/<object>'
|
|
:param timestamp: The timestamp the X-Delete-At value must match to
|
|
perform the actual delete.
|
|
"""
|
|
self.swift.make_request('DELETE', '/v1/%s' % (quote(actual_obj),),
|
|
{'X-If-Delete-At': str(timestamp)}, (2, HTTP_NOT_FOUND,
|
|
HTTP_PRECONDITION_FAILED))
|