summaryrefslogtreecommitdiffstats
path: root/web/api/formatters/value/README.md
blob: 5631d8207a9ec488427f3d3589ecd9950fc7e28e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<!--
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).