Add some notes to the readme about queries that don't hit

We should mention something in the readme about the routine
process for deleting old queries and removing/rejecting
queries related to essentially incomplete bugs.

This has come up a few times in reviews so it's best to
document for expectations.

Change-Id: I2730f4947aa771704fb93fd824aac236d532527c
This commit is contained in:
Matt Riedemann 2014-09-03 20:41:18 -07:00
parent 533b0729d2
commit 9379b35d79

View File

@ -63,6 +63,12 @@ In order to support rapidly added queries, it's considered socially acceptable
to approve changes that only add 1 new bug query, and to even self approve
those changes by core reviewers.
Note that old queries which are no longer hitting in logstash and are
associated with fixed or incomplete bugs are routinely deleted. This is to keep
the load on the elastic-search engine as low as possible when checking a job
failure. If a bug marked as Incomplete does show up again, the bug should be
re-opened with a link to the failure and the e-r query should be restored.
Adding Bug Signatures
---------------------
@ -87,6 +93,13 @@ stack that can cause many tempest tests to fail.
to the bug with the query you identified and a link to the logstash URL for
that query search.
Putting the logstash query link in the bug report is also valuable in the
case of rare failures that fall outside the window of how far back log
results are stored. In such cases the bug might be marked as Incomplete
and the e-r query could be removed, only for the failure to re-surface
later. If a link to the query is in the bug report someone can easily
track when it started showing up again.
#. Add the query to ``elastic-recheck/queries/BUGNUMBER.yaml``
(All queries can be found on `git.openstack.org
<https://git.openstack.org/cgit/openstack-infra/elastic-recheck/tree/queries>`_)