opendev
/
elastic-recheck
Code Issues Proposed changes

Disambiguate filename:<file> from tag:<file> in query guidelines 

It is not clear what is referred to by 'filename query' when it is
recommended in place of a 'console query'. One might think it is the
query of the form filename:<filename>. But it is then recommended to use
the 'tags' field rather than the 'filename'.

This commit removes the ambiguity.

Related-Bug: #1368877

Change-Id: I980584bf3afba681321318aecffb566bfcf57e8b
This commit is contained in:
Mikhail S Medvedev 2014-09-16 10:18:03 -05:00
parent 67f1a11b96
commit d6e8194e8f
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.rst
View File

@ -34,8 +34,9 @@ keyword which is the query text for elastic search.
Guidelines for good queries:
- Queries should get as close as possible to fingerprinting the root cause. A
filename query is typically better than a console one, as that's matching a
deep failure versus a surface symptom.
screen log query (e.g. ``tags:"screen-n-net.txt"``) is typically better than
a console one (``tags:"console"``), as that's matching a deep failure versus
a surface symptom.
- Queries should not return any hits for successful jobs, this is a sign the
query isn't specific enough. A rule of thumb is > 10% success hits probably