diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-05 11:19:16 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-05 12:07:37 +0000 |
| commit | b485aab7e71c1625cfc27e0f92c9509f42378458 (patch) | |
| tree | ae9abe108601079d1679194de237c9a435ae5b55 /web/api/formatters/value/README.md | |
| parent | Adding upstream version 1.44.3. (diff) | |
| download | netdata-b485aab7e71c1625cfc27e0f92c9509f42378458.tar.xz netdata-b485aab7e71c1625cfc27e0f92c9509f42378458.zip | |
Adding upstream version 1.45.3+dfsg.upstream/1.45.3+dfsgupstream
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 | 28 |
1 files changed, 0 insertions, 28 deletions
diff --git a/web/api/formatters/value/README.md b/web/api/formatters/value/README.md deleted file mode 100644 index 5631d8207..000000000 --- a/web/api/formatters/value/README.md +++ /dev/null @@ -1,28 +0,0 @@ -<!-- -title: "Value formatter" -custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/value/README.md -sidebar_label: "Value formatter" -learn_status: "Published" -learn_topic_type: "References" -learn_rel_path: "Developers/Web/Api/Formatters" ---> - -# Value formatter - -The Value formatter presents [results of database queries](https://github.com/netdata/netdata/blob/master/web/api/queries/README.md) 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`](https://github.com/netdata/netdata/blob/master/web/api/formatters/ssv/README.md) formatter -and [health monitoring queries](https://github.com/netdata/netdata/blob/master/health/README.md). - - |