Add delete race subcommand (elastic#186)

With this commit we enhance `night-rally-admin` with a delete race
subcommand which can be used to cleanup broken results from the metrics
store in a consistent manner.

Author: danielmitterdorfer

README.md

@@ -68,6 +68,15 @@ If you have made an error you can also remove specific annotations by id.
 
 For more details, please issue `night-rally-admin delete annotation --help`.
 
+#### Remove a race
+
+Sometimes we need to redo a benchmark run and then we need to cleanup data from the prior run. In order to do so, `night-rally-admin` can delete all relevant data.
+
+1. Issue `night-rally-admin list races --environment=nightly` and find the race id of the race(s) you need to delete. Note that only the 20 most recent races are shown. You can show more, by specifying `--limit=NUMBER`.
+2. Suppose the id of the race that we want to delete is `53f37522-b761-4e46-9a5c-e7f0d9d9258f`. Then issue `night-rally-admin delete race --id=53f37522-b761-4e46-9a5c-e7f0d9d9258f`. This will remove all data about this race from the metrics store.
+
+For more details, please issue `night-rally-admin delete race --help`.
+
 **Note:** The admin tool also supports a dry-run mode for all commands that would change the data store. Just append `--dry-run`.
 
 #### Find logs, telemetry or heapdumps from older nightly runs

night_rally/admin.py

@@ -197,6 +197,52 @@ def delete_annotation(es, args):
                     raise
 
 
+def delete_race(es, args):
+    import elasticsearch
+
+    def do_delete(index, body, race_id):
+        try:
+            return es.delete_by_query(index=index, body=body)
+        except elasticsearch.TransportError as e:
+            if e.status_code == 404:
+                print("Did not find [%s]." % race_id)
+            else:
+                raise
+
+    environment = args.environment
+    races = args.id.split(",")
+    if args.dry_run:
+        if len(races) == 1:
+            print("Would delete race with id [%s] in environment [%s]." % (races[0], environment))
+        else:
+            print("Would delete %s races: %s in environment [%s]." % (len(races), races, environment))
+    else:
+        for race_id in races:
+            selector = {
+                "query": {
+                    "bool": {
+                        "filter": [
+                            {
+                                "term": {
+                                    "environment": environment
+                                }
+                            },
+                            {
+                                "term": {
+                                    "race-id": race_id
+                                }
+                            }
+                        ]
+                    }
+                }
+            }
+            do_delete(index="rally-races-*", body=selector, race_id=race_id)
+            do_delete(index="rally-results-*", body=selector, race_id=race_id)
+            do_delete(index="rally-metrics-*", body=selector, race_id=race_id)
+
+            print("Successfully deleted [%s] in environment [%s]." % (race_id, environment))
+
+
 def arg_parser():
     def positive_number(v):
         value = int(v)
@@ -296,7 +342,7 @@ def positive_number(v):
         "configuration",
         metavar="configuration",
         help="",
-        choices=["annotation"])
+        choices=["annotation", "race"])
     delete_parser.add_argument(
         "--dry-run",
         help="Just show what would be done but do not apply the operation.",
@@ -305,7 +351,7 @@ def positive_number(v):
     )
     delete_parser.add_argument(
         "--id",
-        help="Id of the annotation to delete. Separate multiple ids with a comma.",
+        help="Ids of the items to delete. Separate multiple ids with a comma.",
         required=True
     )
     delete_parser.add_argument(
@@ -333,6 +379,8 @@ def main():
         add_annotation(es, args)
     elif args.subcommand == "delete" and args.configuration == "annotation":
         delete_annotation(es, args)
+    elif args.subcommand == "delete" and args.configuration == "race":
+        delete_race(es, args)
     else:
         parser.print_help(file=sys.stderr)
         exit(1)

night_rally/client.py

@@ -30,4 +30,4 @@ def load():
     http_auth = (cfg["datastore.user"], cfg["datastore.password"]) if secure else None
     certs = certifi.where() if secure else None
 
-    return elasticsearch.Elasticsearch(hosts=hosts, http_auth=http_auth, ca_certs=certs)
+    return elasticsearch.Elasticsearch(hosts=hosts, http_auth=http_auth, ca_certs=certs, timeout=60)