Socorro/ElasticSearch API: Difference between revisions

Socorro/ElasticSearch API (view source)

1,007 bytes added , 5 May 2011

→‎Stats: Adding description & example

Confirmed users

245

edits

@@ Line 155: / Line 155: @@
 Get some statistics around the data. E.g. counting by OS, by product, by ADU, by build... The difference with report is that stats only send back numeric data, counting through the entire data set or in a certain date range.
+This may not be useful for Socorro UI right now, but could be in the future. It may be a good way of extending the information we give to our users. Those stats are very likely to be cached, meaning performance should not be an issue.
+=== Examples of ES queries ===
+<pre>{
+    "size" : 0,
+    "query" : {
+        "match_all" : {}
+    },
+    "facets" : {
+        "os" : {
+            "terms" : { "script_field" : "_source.os_name" }
+        }
+    }
+}</pre>
+Gives the number of crashes by OS. Example result:
+<pre>{
+  "took" : 50,
+  "timed_out" : false,
+  "_shards" : {
+    "total" : 5,
+    "successful" : 5,
+    "failed" : 0
+  },
+  "hits" : {
+    "total" : 229,
+    "max_score" : 1.0,
+    "hits" : [ ]
+  },
+  "facets" : {
+    "os" : {
+      "_type" : "terms",
+      "missing" : 74,
+      "terms" : [ {
+        "term" : "Windows NT",
+        "count" : 134
+      }, {
+        "term" : "Mac OS X",
+        "count" : 13
+      }, {
+        "term" : "Linux",
+        "count" : 8
+      } ]
+    }
+  }
+}</pre>
 = Implementation =
 ''Describe how we are going to implement this...''