66 lines
2.9 KiB
Python
66 lines
2.9 KiB
Python
"""
|
|
Test hook for verifying $queryStats collects expected metrics and can redact query shapes.
|
|
|
|
This runs in the background as other tests are ongoing.
|
|
"""
|
|
|
|
from buildscripts.resmokelib.testing.hooks.interface import Hook
|
|
from bson import binary
|
|
import pymongo.errors
|
|
|
|
QUERY_FEATURE_NOT_ALLOWED_CODE = 224
|
|
QUERY_STATS_NOT_ENABLED_CODE = 7373500
|
|
|
|
|
|
class RunQueryStats(Hook):
|
|
"""Runs $queryStats after every test, and clears the query stats store before every test."""
|
|
|
|
IS_BACKGROUND = False
|
|
|
|
def __init__(self, hook_logger, fixture, allow_feature_not_supported=False):
|
|
"""Initialize the RunQueryStats hook.
|
|
|
|
Args:
|
|
hook_logger: the logger instance for this hook.
|
|
fixture: the target fixture (replica sets or a sharded cluster).
|
|
allow_feature_not_supported: absorb 'QueryFeatureNotAllowed' errors when calling
|
|
$queryStats. This is to support fuzzer suites that may manipulate the FCV.
|
|
"""
|
|
description = "Read query stats data after each test."
|
|
super().__init__(hook_logger, fixture, description)
|
|
self.client = self.fixture.mongo_client()
|
|
self.hmac_key = binary.Binary(("0" * 32).encode('utf-8'), 8)
|
|
self.allow_feature_not_supported = allow_feature_not_supported
|
|
|
|
def verify_query_stats(self, querystats_spec):
|
|
"""Verify a $queryStats call has all the right properties."""
|
|
try:
|
|
with self.client.admin.aggregate([{"$queryStats": querystats_spec}]) as cursor:
|
|
for operation in cursor:
|
|
assert "key" in operation
|
|
assert "metrics" in operation
|
|
assert "asOf" in operation
|
|
except pymongo.errors.OperationFailure as err:
|
|
if not self.allow_feature_not_supported or err.code != QUERY_FEATURE_NOT_ALLOWED_CODE:
|
|
raise err
|
|
else:
|
|
self.logger.info("Encountered a 'QueryFeatureNotAllowed' error. "
|
|
"$queryStats will not be run for this test.")
|
|
|
|
def after_test(self, test, test_report):
|
|
self.verify_query_stats({})
|
|
self.verify_query_stats(
|
|
{"transformIdentifiers": {"algorithm": "hmac-sha-256", "hmacKey": self.hmac_key}})
|
|
|
|
def before_test(self, test, test_report):
|
|
try:
|
|
# Clear out all existing entries, then reset the size cap.
|
|
self.client.admin.command("setParameter", 1, internalQueryStatsCacheSize="0%")
|
|
self.client.admin.command("setParameter", 1, internalQueryStatsCacheSize="1%")
|
|
except pymongo.errors.OperationFailure as err:
|
|
if not self.allow_feature_not_supported or err.code != QUERY_STATS_NOT_ENABLED_CODE:
|
|
raise err
|
|
else:
|
|
self.logger.info("Encountered an error while configuring the query stats store. "
|
|
"Query stats will not be collected for this test.")
|