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
390 lines
14 KiB
Python
390 lines
14 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 test import unit
|
|
import unittest
|
|
import tempfile
|
|
import os
|
|
import time
|
|
from shutil import rmtree
|
|
from hashlib import md5
|
|
from tempfile import mkdtemp
|
|
from test.unit import FakeLogger
|
|
from swift.obj import auditor
|
|
from swift.obj import server as object_server
|
|
from swift.obj.server import DiskFile, write_metadata, DATADIR
|
|
from swift.common.utils import hash_path, mkdirs, normalize_timestamp, \
|
|
renamer, storage_directory
|
|
from swift.obj.replicator import invalidate_hash
|
|
from swift.common.exceptions import AuditException
|
|
|
|
|
|
class TestAuditor(unittest.TestCase):
|
|
|
|
def setUp(self):
|
|
self.testdir = os.path.join(mkdtemp(), 'tmp_test_object_auditor')
|
|
self.devices = os.path.join(self.testdir, 'node')
|
|
self.logger = FakeLogger()
|
|
rmtree(self.testdir, ignore_errors=1)
|
|
mkdirs(os.path.join(self.devices, 'sda'))
|
|
self.objects = os.path.join(self.devices, 'sda', 'objects')
|
|
|
|
os.mkdir(os.path.join(self.devices, 'sdb'))
|
|
self.objects_2 = os.path.join(self.devices, 'sdb', 'objects')
|
|
|
|
os.mkdir(self.objects)
|
|
self.parts = {}
|
|
for part in ['0', '1', '2', '3']:
|
|
self.parts[part] = os.path.join(self.objects, part)
|
|
os.mkdir(os.path.join(self.objects, part))
|
|
|
|
self.conf = dict(
|
|
devices=self.devices,
|
|
mount_check='false')
|
|
self.disk_file = DiskFile(self.devices, 'sda', '0', 'a', 'c', 'o',
|
|
self.logger)
|
|
|
|
def tearDown(self):
|
|
rmtree(os.path.dirname(self.testdir), ignore_errors=1)
|
|
unit.xattr_data = {}
|
|
|
|
def test_object_audit_extra_data(self):
|
|
self.auditor = auditor.AuditorWorker(self.conf)
|
|
data = '0' * 1024
|
|
etag = md5()
|
|
with self.disk_file.mkstemp() as (fd, tmppath):
|
|
os.write(fd, data)
|
|
etag.update(data)
|
|
etag = etag.hexdigest()
|
|
timestamp = str(normalize_timestamp(time.time()))
|
|
metadata = {
|
|
'ETag': etag,
|
|
'X-Timestamp': timestamp,
|
|
'Content-Length': str(os.fstat(fd).st_size),
|
|
}
|
|
self.disk_file.put(fd, tmppath, metadata)
|
|
pre_quarantines = self.auditor.quarantines
|
|
|
|
self.auditor.object_audit(
|
|
os.path.join(self.disk_file.datadir, timestamp + '.data'),
|
|
'sda', '0')
|
|
self.assertEquals(self.auditor.quarantines, pre_quarantines)
|
|
|
|
os.write(fd, 'extra_data')
|
|
self.auditor.object_audit(
|
|
os.path.join(self.disk_file.datadir, timestamp + '.data'),
|
|
'sda', '0')
|
|
self.assertEquals(self.auditor.quarantines, pre_quarantines + 1)
|
|
|
|
def test_object_audit_diff_data(self):
|
|
self.auditor = auditor.AuditorWorker(self.conf)
|
|
data = '0' * 1024
|
|
etag = md5()
|
|
timestamp = str(normalize_timestamp(time.time()))
|
|
with self.disk_file.mkstemp() as (fd, tmppath):
|
|
os.write(fd, data)
|
|
etag.update(data)
|
|
etag = etag.hexdigest()
|
|
metadata = {
|
|
'ETag': etag,
|
|
'X-Timestamp': timestamp,
|
|
'Content-Length': str(os.fstat(fd).st_size),
|
|
}
|
|
self.disk_file.put(fd, tmppath, metadata)
|
|
pre_quarantines = self.auditor.quarantines
|
|
# remake so it will have metadata
|
|
self.disk_file = DiskFile(self.devices, 'sda', '0', 'a', 'c', 'o',
|
|
self.logger)
|
|
|
|
self.auditor.object_audit(
|
|
os.path.join(self.disk_file.datadir, timestamp + '.data'),
|
|
'sda', '0')
|
|
self.assertEquals(self.auditor.quarantines, pre_quarantines)
|
|
etag = md5()
|
|
etag.update('1' + '0' * 1023)
|
|
etag = etag.hexdigest()
|
|
metadata['ETag'] = etag
|
|
write_metadata(fd, metadata)
|
|
|
|
self.auditor.object_audit(
|
|
os.path.join(self.disk_file.datadir, timestamp + '.data'),
|
|
'sda', '0')
|
|
self.assertEquals(self.auditor.quarantines, pre_quarantines + 1)
|
|
|
|
def test_object_audit_no_meta(self):
|
|
timestamp = str(normalize_timestamp(time.time()))
|
|
path = os.path.join(self.disk_file.datadir, timestamp + '.data')
|
|
mkdirs(self.disk_file.datadir)
|
|
fp = open(path, 'w')
|
|
fp.write('0' * 1024)
|
|
fp.close()
|
|
invalidate_hash(os.path.dirname(self.disk_file.datadir))
|
|
self.auditor = auditor.AuditorWorker(self.conf)
|
|
pre_quarantines = self.auditor.quarantines
|
|
self.auditor.object_audit(
|
|
os.path.join(self.disk_file.datadir, timestamp + '.data'),
|
|
'sda', '0')
|
|
self.assertEquals(self.auditor.quarantines, pre_quarantines + 1)
|
|
|
|
def test_object_audit_bad_args(self):
|
|
self.auditor = auditor.AuditorWorker(self.conf)
|
|
pre_errors = self.auditor.errors
|
|
self.auditor.object_audit(5, 'sda', '0')
|
|
self.assertEquals(self.auditor.errors, pre_errors + 1)
|
|
pre_errors = self.auditor.errors
|
|
self.auditor.object_audit('badpath', 'sda', '0')
|
|
self.assertEquals(self.auditor.errors, pre_errors) # just returns
|
|
|
|
def test_object_run_once_pass(self):
|
|
self.auditor = auditor.AuditorWorker(self.conf)
|
|
self.auditor.log_time = 0
|
|
timestamp = str(normalize_timestamp(time.time()))
|
|
pre_quarantines = self.auditor.quarantines
|
|
data = '0' * 1024
|
|
etag = md5()
|
|
with self.disk_file.mkstemp() as (fd, tmppath):
|
|
os.write(fd, data)
|
|
etag.update(data)
|
|
etag = etag.hexdigest()
|
|
metadata = {
|
|
'ETag': etag,
|
|
'X-Timestamp': timestamp,
|
|
'Content-Length': str(os.fstat(fd).st_size),
|
|
}
|
|
self.disk_file.put(fd, tmppath, metadata)
|
|
self.disk_file.close()
|
|
self.auditor.audit_all_objects()
|
|
self.assertEquals(self.auditor.quarantines, pre_quarantines)
|
|
|
|
def test_object_run_once_no_sda(self):
|
|
self.auditor = auditor.AuditorWorker(self.conf)
|
|
timestamp = str(normalize_timestamp(time.time()))
|
|
pre_quarantines = self.auditor.quarantines
|
|
data = '0' * 1024
|
|
etag = md5()
|
|
with self.disk_file.mkstemp() as (fd, tmppath):
|
|
os.write(fd, data)
|
|
etag.update(data)
|
|
etag = etag.hexdigest()
|
|
metadata = {
|
|
'ETag': etag,
|
|
'X-Timestamp': timestamp,
|
|
'Content-Length': str(os.fstat(fd).st_size),
|
|
}
|
|
self.disk_file.put(fd, tmppath, metadata)
|
|
self.disk_file.close()
|
|
os.write(fd, 'extra_data')
|
|
self.auditor.audit_all_objects()
|
|
self.assertEquals(self.auditor.quarantines, pre_quarantines + 1)
|
|
|
|
def test_object_run_once_multi_devices(self):
|
|
self.auditor = auditor.AuditorWorker(self.conf)
|
|
timestamp = str(normalize_timestamp(time.time()))
|
|
pre_quarantines = self.auditor.quarantines
|
|
data = '0' * 10
|
|
etag = md5()
|
|
with self.disk_file.mkstemp() as (fd, tmppath):
|
|
os.write(fd, data)
|
|
etag.update(data)
|
|
etag = etag.hexdigest()
|
|
metadata = {
|
|
'ETag': etag,
|
|
'X-Timestamp': timestamp,
|
|
'Content-Length': str(os.fstat(fd).st_size),
|
|
}
|
|
self.disk_file.put(fd, tmppath, metadata)
|
|
self.disk_file.close()
|
|
self.auditor.audit_all_objects()
|
|
self.disk_file = DiskFile(self.devices, 'sdb', '0', 'a', 'c',
|
|
'ob', self.logger)
|
|
data = '1' * 10
|
|
etag = md5()
|
|
with self.disk_file.mkstemp() as (fd, tmppath):
|
|
os.write(fd, data)
|
|
etag.update(data)
|
|
etag = etag.hexdigest()
|
|
metadata = {
|
|
'ETag': etag,
|
|
'X-Timestamp': timestamp,
|
|
'Content-Length': str(os.fstat(fd).st_size),
|
|
}
|
|
self.disk_file.put(fd, tmppath, metadata)
|
|
self.disk_file.close()
|
|
os.write(fd, 'extra_data')
|
|
self.auditor.audit_all_objects()
|
|
self.assertEquals(self.auditor.quarantines, pre_quarantines + 1)
|
|
|
|
def test_object_run_fast_track_non_zero(self):
|
|
self.auditor = auditor.ObjectAuditor(self.conf)
|
|
self.auditor.log_time = 0
|
|
data = '0' * 1024
|
|
etag = md5()
|
|
with self.disk_file.mkstemp() as (fd, tmppath):
|
|
os.write(fd, data)
|
|
etag.update(data)
|
|
etag = etag.hexdigest()
|
|
metadata = {
|
|
'ETag': etag,
|
|
'X-Timestamp': str(normalize_timestamp(time.time())),
|
|
'Content-Length': str(os.fstat(fd).st_size),
|
|
}
|
|
self.disk_file.put(fd, tmppath, metadata)
|
|
etag = md5()
|
|
etag.update('1' + '0' * 1023)
|
|
etag = etag.hexdigest()
|
|
metadata['ETag'] = etag
|
|
write_metadata(fd, metadata)
|
|
|
|
quarantine_path = os.path.join(self.devices,
|
|
'sda', 'quarantined', 'objects')
|
|
self.auditor.run_once(zero_byte_fps=50)
|
|
self.assertFalse(os.path.isdir(quarantine_path))
|
|
self.auditor.run_once()
|
|
self.assertTrue(os.path.isdir(quarantine_path))
|
|
|
|
def setup_bad_zero_byte(self, with_ts=False):
|
|
self.auditor = auditor.ObjectAuditor(self.conf)
|
|
self.auditor.log_time = 0
|
|
ts_file_path = ''
|
|
if with_ts:
|
|
|
|
name_hash = hash_path('a', 'c', 'o')
|
|
dir_path = os.path.join(self.devices, 'sda',
|
|
storage_directory(DATADIR, '0', name_hash))
|
|
ts_file_path = os.path.join(dir_path, '99999.ts')
|
|
if not os.path.exists(dir_path):
|
|
mkdirs(dir_path)
|
|
fp = open(ts_file_path, 'w')
|
|
fp.close()
|
|
|
|
etag = md5()
|
|
with self.disk_file.mkstemp() as (fd, tmppath):
|
|
etag = etag.hexdigest()
|
|
metadata = {
|
|
'ETag': etag,
|
|
'X-Timestamp': str(normalize_timestamp(time.time())),
|
|
'Content-Length': 10,
|
|
}
|
|
self.disk_file.put(fd, tmppath, metadata)
|
|
etag = md5()
|
|
etag = etag.hexdigest()
|
|
metadata['ETag'] = etag
|
|
write_metadata(fd, metadata)
|
|
if self.disk_file.data_file:
|
|
return self.disk_file.data_file
|
|
return ts_file_path
|
|
|
|
def test_object_run_fast_track_all(self):
|
|
self.setup_bad_zero_byte()
|
|
self.auditor.run_once()
|
|
quarantine_path = os.path.join(self.devices,
|
|
'sda', 'quarantined', 'objects')
|
|
self.assertTrue(os.path.isdir(quarantine_path))
|
|
|
|
def test_object_run_fast_track_zero(self):
|
|
self.setup_bad_zero_byte()
|
|
self.auditor.run_once(zero_byte_fps=50)
|
|
quarantine_path = os.path.join(self.devices,
|
|
'sda', 'quarantined', 'objects')
|
|
self.assertTrue(os.path.isdir(quarantine_path))
|
|
|
|
def test_with_tombstone(self):
|
|
ts_file_path = self.setup_bad_zero_byte(with_ts=True)
|
|
self.auditor.run_once()
|
|
quarantine_path = os.path.join(self.devices,
|
|
'sda', 'quarantined', 'objects')
|
|
self.assertTrue(ts_file_path.endswith('ts'))
|
|
self.assertTrue(os.path.exists(ts_file_path))
|
|
|
|
def test_sleeper(self):
|
|
auditor.SLEEP_BETWEEN_AUDITS = 0.10
|
|
my_auditor = auditor.ObjectAuditor(self.conf)
|
|
start = time.time()
|
|
my_auditor._sleep()
|
|
delta_t = time.time() - start
|
|
self.assert_(delta_t > 0.08)
|
|
self.assert_(delta_t < 0.12)
|
|
|
|
def test_object_run_fast_track_zero_check_closed(self):
|
|
rat = [False]
|
|
|
|
class FakeFile(DiskFile):
|
|
|
|
def close(self, verify_file=True):
|
|
rat[0] = True
|
|
DiskFile.close(self, verify_file=verify_file)
|
|
self.setup_bad_zero_byte()
|
|
was_df = object_server.DiskFile
|
|
try:
|
|
object_server.DiskFile = FakeFile
|
|
self.auditor.run_once(zero_byte_fps=50)
|
|
quarantine_path = os.path.join(self.devices,
|
|
'sda', 'quarantined', 'objects')
|
|
self.assertTrue(os.path.isdir(quarantine_path))
|
|
self.assertTrue(rat[0])
|
|
finally:
|
|
object_server.DiskFile = was_df
|
|
|
|
def test_run_forever(self):
|
|
|
|
class StopForever(Exception):
|
|
pass
|
|
|
|
class ObjectAuditorMock(object):
|
|
check_args = ()
|
|
check_kwargs = {}
|
|
fork_called = 0
|
|
fork_res = 0
|
|
|
|
def mock_run(self, *args, **kwargs):
|
|
self.check_args = args
|
|
self.check_kwargs = kwargs
|
|
|
|
def mock_sleep(self):
|
|
raise StopForever('stop')
|
|
|
|
def mock_fork(self):
|
|
self.fork_called += 1
|
|
return self.fork_res
|
|
|
|
my_auditor = auditor.ObjectAuditor(dict(devices=self.devices,
|
|
mount_check='false',
|
|
zero_byte_files_per_second=89))
|
|
mocker = ObjectAuditorMock()
|
|
my_auditor.run_once = mocker.mock_run
|
|
my_auditor._sleep = mocker.mock_sleep
|
|
was_fork = os.fork
|
|
try:
|
|
os.fork = mocker.mock_fork
|
|
self.assertRaises(StopForever,
|
|
my_auditor.run_forever, zero_byte_fps=50)
|
|
self.assertEquals(mocker.check_kwargs['zero_byte_fps'], 50)
|
|
self.assertEquals(mocker.fork_called, 0)
|
|
|
|
self.assertRaises(StopForever, my_auditor.run_forever)
|
|
self.assertEquals(mocker.fork_called, 1)
|
|
self.assertEquals(mocker.check_args, ())
|
|
|
|
mocker.fork_res = 1
|
|
self.assertRaises(StopForever, my_auditor.run_forever)
|
|
self.assertEquals(mocker.fork_called, 2)
|
|
self.assertEquals(mocker.check_kwargs['zero_byte_fps'], 89)
|
|
|
|
finally:
|
|
os.fork = was_fork
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main()
|