Joe Gordon f3a51c512c Add doc on queries.yaml

Now that people are contributing patches to queries.yaml, we should have
some docs on what we expect. This is a first pass at that.

Change-Id: Ib32ed2a8a24c3d70fe7bedfdf3820e895eed45cf

2013-11-19 20:40:37 -08:00

1.3 KiB

Raw Blame History

elastic-recheck

"Classify tempest-devstack failures using ElasticSearch"

Free software: Apache license
Documentation: http://docs.openstack.org/developer/elastic-recheck

Idea

When a tempest job failure is detected, by monitoring gerrit (using gerritlib), a collection of logstash queries will be run on the failed job to detect what the bug was.

Eventually this can be tied into the rechecker tool and launchpad

queries.yaml

All queries are stored in a yaml file called: queries.yaml

Guidelines for queries.yaml

After a bug is resolved and has no more hits in elasticsearch, it should be removed
Queries should get as close as possible to fingerprinting the root cause
Queries should not return any hits for successful jobs, this is a sign the query isn't specific enough

Future Work

Move config files into a separate directory
Make unit tests robust
Merge both binaries
Add debug mode flag
Split out queries repo
Expand gating testing
Cleanup and document code better
Move away from polling ElasticSearch to discover if its ready or not
Add nightly job to propose a patch to remove bug queries that return no hits -- Bug hasn't been seen in 2 weeks and must be closed

Main Dependencies

gerritlib
pyelasticsearch