diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2018-11-07 12:19:29 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2018-11-07 12:20:17 +0000 |
| commit | a64a253794ac64cb40befee54db53bde17dd0d49 (patch) | |
| tree | c1024acc5f6e508814b944d99f112259bb28b1be /web/api/formatters/value/README.md | |
| parent | New upstream version 1.10.0+dfsg (diff) | |
| download | netdata-a64a253794ac64cb40befee54db53bde17dd0d49.tar.xz netdata-a64a253794ac64cb40befee54db53bde17dd0d49.zip | |
New upstream version 1.11.0+dfsgupstream/1.11.0+dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'web/api/formatters/value/README.md')
| -rw-r--r-- | web/api/formatters/value/README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/web/api/formatters/value/README.md b/web/api/formatters/value/README.md new file mode 100644 index 000000000..5024e74ee --- /dev/null +++ b/web/api/formatters/value/README.md @@ -0,0 +1,17 @@ +# Value formatter + +The Value formatter presents [results of database queries](../../queries) as a single value. + +To calculate the single value to be returned, it sums the values of all dimensions. + +The Value formatter respects the following API `&options=`: + +option|supported|description +:---:|:---:|:--- +`percent`|yes|to replace all values with their percentage over the row total +`abs`|yes|to turn all values positive, before using them +`min2max`|yes|to return the delta from the minimum value to the maximum value (across dimensions) + +The Value formatter is not exposed by the API by itself. +Instead it is used by the [`ssv`](../ssv) formatter +and [health monitoring queries](../../../../health). |