summaryrefslogtreecommitdiffstats
path: root/src/web/api/queries/average
diff options
context:
space:
mode:
Diffstat (limited to 'src/web/api/queries/average')
-rw-r--r--src/web/api/queries/average/README.md50
-rw-r--r--src/web/api/queries/average/average.c4
-rw-r--r--src/web/api/queries/average/average.h62
3 files changed, 116 insertions, 0 deletions
diff --git a/src/web/api/queries/average/README.md b/src/web/api/queries/average/README.md
new file mode 100644
index 000000000..1ad78bee5
--- /dev/null
+++ b/src/web/api/queries/average/README.md
@@ -0,0 +1,50 @@
+<!--
+title: "Average or Mean"
+sidebar_label: "Average or Mean"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/queries/average/README.md
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Queries"
+-->
+
+# Average or Mean
+
+> This query is available as `average` and `mean`.
+
+An average is a single number taken as representative of a list of numbers.
+
+It is calculated as:
+
+```
+average = sum(numbers) / count(numbers)
+```
+
+## how to use
+
+Use it in alerts like this:
+
+```
+ alarm: my_alert
+ on: my_chart
+lookup: average -1m unaligned of my_dimension
+ warn: $this > 1000
+```
+
+`average` does not change the units. For example, if the chart units is `requests/sec`, the result
+will be again expressed in the same units.
+
+It can also be used in APIs and badges as `&group=average` in the URL.
+
+## Examples
+
+Examining last 1 minute `successful` web server responses:
+
+- ![](https://registry.my-netdata.io/api/v1/badge.svg?chart=web_log_nginx.response_statuses&options=unaligned&dimensions=success&group=min&after=-60&label=min)
+- ![](https://registry.my-netdata.io/api/v1/badge.svg?chart=web_log_nginx.response_statuses&options=unaligned&dimensions=success&group=average&after=-60&label=average&value_color=orange)
+- ![](https://registry.my-netdata.io/api/v1/badge.svg?chart=web_log_nginx.response_statuses&options=unaligned&dimensions=success&group=max&after=-60&label=max)
+
+## References
+
+- <https://en.wikipedia.org/wiki/Average>.
+
+
diff --git a/src/web/api/queries/average/average.c b/src/web/api/queries/average/average.c
new file mode 100644
index 000000000..f54dcb243
--- /dev/null
+++ b/src/web/api/queries/average/average.c
@@ -0,0 +1,4 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+#include "average.h"
+
diff --git a/src/web/api/queries/average/average.h b/src/web/api/queries/average/average.h
new file mode 100644
index 000000000..2d77cc571
--- /dev/null
+++ b/src/web/api/queries/average/average.h
@@ -0,0 +1,62 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+#ifndef NETDATA_API_QUERY_AVERAGE_H
+#define NETDATA_API_QUERY_AVERAGE_H
+
+#include "../query.h"
+#include "../rrdr.h"
+
+// ----------------------------------------------------------------------------
+// average
+
+struct tg_average {
+ NETDATA_DOUBLE sum;
+ size_t count;
+};
+
+static inline void tg_average_create(RRDR *r, const char *options __maybe_unused) {
+ r->time_grouping.data = onewayalloc_callocz(r->internal.owa, 1, sizeof(struct tg_average));
+}
+
+// resets when switches dimensions
+// so, clear everything to restart
+static inline void tg_average_reset(RRDR *r) {
+ struct tg_average *g = (struct tg_average *)r->time_grouping.data;
+ g->sum = 0;
+ g->count = 0;
+}
+
+static inline void tg_average_free(RRDR *r) {
+ onewayalloc_freez(r->internal.owa, r->time_grouping.data);
+ r->time_grouping.data = NULL;
+}
+
+static inline void tg_average_add(RRDR *r, NETDATA_DOUBLE value) {
+ struct tg_average *g = (struct tg_average *)r->time_grouping.data;
+ g->sum += value;
+ g->count++;
+}
+
+static inline NETDATA_DOUBLE tg_average_flush(RRDR *r, RRDR_VALUE_FLAGS *rrdr_value_options_ptr) {
+ struct tg_average *g = (struct tg_average *)r->time_grouping.data;
+
+ NETDATA_DOUBLE value;
+
+ if(unlikely(!g->count)) {
+ value = 0.0;
+ *rrdr_value_options_ptr |= RRDR_VALUE_EMPTY;
+ }
+ else {
+ if(unlikely(r->time_grouping.resampling_group != 1))
+ value = g->sum / r->time_grouping.resampling_divisor;
+ else
+ value = g->sum / g->count;
+ }
+
+ g->sum = 0.0;
+ g->count = 0;
+
+ return value;
+}
+
+#endif //NETDATA_API_QUERY_AVERAGE_H