From aa59ef2e8407f79e899507ee497061576b98c5a0 Mon Sep 17 00:00:00 2001 From: Clinton Gormley Date: Wed, 4 Sep 2013 21:11:54 +0200 Subject: [PATCH] [DOCS] Added the human flag --- docs/reference/common-options.asciidoc | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/reference/common-options.asciidoc b/docs/reference/common-options.asciidoc index 9156b9a0791..f6d187544d8 100644 --- a/docs/reference/common-options.asciidoc +++ b/docs/reference/common-options.asciidoc @@ -8,6 +8,18 @@ will be pretty formatted (use it for debugging only!). Another option is to set `format=yaml` which will cause the result to be returned in the (sometimes) more readable yaml format. + +=== Human readable output + +Statistics are returned in a format suitable for humans +(eg `"exists_time": "1h"` or `"size": "1kb"`) and for computers +(eg `"exists_time_in_millis": 3600000`` or `"size_in_bytes": 1024`). +The human readable values can be turned off by adding `?human=false` +to the query string. This makes sense when the stats results are +being consumed by a monitoring tool, rather than intended for human +consumption. The default for the `human` flag is +`false`. added[1.00.Beta,Previously defaulted to `true`] + === Parameters Rest parameters (when using HTTP, map to HTTP URL parameters) follow the