elastic-recheck/elastic_recheck/cmd/query.py

157 lines
4.5 KiB
Python
Executable File

#!/usr/bin/env python
# All Rights Reserved.
#
# 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 argparse
import base64
import itertools
import json
import time
import requests
import yaml
from elastic_recheck import log as logging
LOG = logging.getLogger('erquery')
ENDPOINT = 'http://logstash.openstack.org/api'
DEFAULT_NUMBER_OF_DAYS = 10
DEFAULT_MAX_QUANTITY = 5
IGNORED_ATTRIBUTES = [
'build_master',
'build_patchset',
'build_ref',
'build_short_uuid',
'build_uuid',
'error_pr',
'host',
'received_at',
'type',
]
def _GET(path):
r = requests.get(ENDPOINT + path)
if r.status_code != requests.codes.ok:
LOG.info('Got HTTP %s, retrying...' % r.status_code)
# retry once
r = requests.get(ENDPOINT + path)
try:
return r.json()
except Exception:
raise SystemExit(r.text)
def _encode(q):
"""Encode a JSON dict for inclusion in a URL."""
return base64.b64encode(json.dumps(q))
def _unix_time_in_microseconds():
return int(time.time() * 1000)
def search(q, days):
search = {
'search': q,
'fields': [],
'offset': 0,
'timeframe': str(days * 86400),
'graphmode': 'count',
'time': {
'user_interval': 0},
'stamp': _unix_time_in_microseconds()}
return _GET('/search/%s' % _encode(search))
def analyze_attributes(attributes):
analysis = {}
for attribute, values in attributes.iteritems():
if attribute[0] == '@' or attribute == 'message':
# skip meta attributes and raw messages
continue
analysis[attribute] = []
total_hits = sum(values.values())
for value_hash, hits in values.iteritems():
value = json.loads(value_hash)
analysis[attribute].append((100.0 * hits / total_hits, value))
# sort by hit percentage descending, and then by value ascending
analysis[attribute] = sorted(
analysis[attribute],
key=lambda x: (1 - x[0], x[1]))
return analysis
def query(query_file_name, days=DEFAULT_NUMBER_OF_DAYS,
quantity=DEFAULT_MAX_QUANTITY, verbose=False):
with open(query_file_name) as f:
query_file = yaml.load(f.read())
query = query_file['query']
r = search(q=query, days=days)
print('total hits: %s' % r['hits']['total'])
attributes = {}
for hit in r['hits']['hits']:
for key, value in hit['_source'].iteritems():
value_hash = json.dumps(value)
attributes.setdefault(key, {}).setdefault(value_hash, 0)
attributes[key][value_hash] += 1
analysis = analyze_attributes(attributes)
for attribute, results in sorted(analysis.iteritems()):
if not verbose and attribute in IGNORED_ATTRIBUTES:
# skip less-than-useful attributes to reduce noise in the report
continue
print(attribute)
for percentage, value in itertools.islice(results, None, quantity):
if isinstance(value, list):
value = ' '.join(unicode(x) for x in value)
print(' %d%% %s' % (percentage, value))
def main():
parser = argparse.ArgumentParser(
description='Execute elastic-recheck query files and analyze the '
'results.')
parser.add_argument(
'query_file', type=argparse.FileType('r'),
help='Path to an elastic-recheck YAML query file.')
parser.add_argument(
'--quantity', '-q', type=int, default=DEFAULT_MAX_QUANTITY,
help='Maximum quantity of values to show for each attribute.')
parser.add_argument(
'--days', '-d', type=float, default=DEFAULT_NUMBER_OF_DAYS,
help='Timespan to query, in days (may be a decimal).')
parser.add_argument(
'--verbose', '-v', action='store_true', default=False,
help='Report on additional query metadata.')
args = parser.parse_args()
query(args.query_file.name, args.days, args.quantity, args.verbose)
if __name__ == "__main__":
main()