summaryrefslogtreecommitdiffstats
path: root/src/web/api/queries/min
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-05 12:08:03 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-05 12:08:18 +0000
commit5da14042f70711ea5cf66e034699730335462f66 (patch)
tree0f6354ccac934ed87a2d555f45be4c831cf92f4a /src/web/api/queries/min
parentReleasing debian version 1.44.3-2. (diff)
downloadnetdata-5da14042f70711ea5cf66e034699730335462f66.tar.xz
netdata-5da14042f70711ea5cf66e034699730335462f66.zip
Merging upstream version 1.45.3+dfsg.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/web/api/queries/min')
-rw-r--r--src/web/api/queries/min/README.md42
-rw-r--r--src/web/api/queries/min/min.c7
-rw-r--r--src/web/api/queries/min/min.h59
3 files changed, 108 insertions, 0 deletions
diff --git a/src/web/api/queries/min/README.md b/src/web/api/queries/min/README.md
new file mode 100644
index 000000000..35acb8c9e
--- /dev/null
+++ b/src/web/api/queries/min/README.md
@@ -0,0 +1,42 @@
+<!--
+title: "Min"
+sidebar_label: "Min"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/queries/min/README.md
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Queries"
+-->
+
+# Min
+
+This module finds the min value in the time-frame given.
+
+## how to use
+
+Use it in alerts like this:
+
+```
+ alarm: my_alert
+ on: my_chart
+lookup: min -1m unaligned of my_dimension
+ warn: $this > 1000
+```
+
+`min` 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=min` 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&value_color=orange)
+- ![](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)
+- ![](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/Sample_maximum_and_minimum>.
+
+
diff --git a/src/web/api/queries/min/min.c b/src/web/api/queries/min/min.c
new file mode 100644
index 000000000..cefa7cf31
--- /dev/null
+++ b/src/web/api/queries/min/min.c
@@ -0,0 +1,7 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+#include "min.h"
+
+// ----------------------------------------------------------------------------
+// min
+
diff --git a/src/web/api/queries/min/min.h b/src/web/api/queries/min/min.h
new file mode 100644
index 000000000..3c53dfd1d
--- /dev/null
+++ b/src/web/api/queries/min/min.h
@@ -0,0 +1,59 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+#ifndef NETDATA_API_QUERY_MIN_H
+#define NETDATA_API_QUERY_MIN_H
+
+#include "../query.h"
+#include "../rrdr.h"
+
+struct tg_min {
+ NETDATA_DOUBLE min;
+ size_t count;
+};
+
+static inline void tg_min_create(RRDR *r, const char *options __maybe_unused) {
+ r->time_grouping.data = onewayalloc_callocz(r->internal.owa, 1, sizeof(struct tg_min));
+}
+
+// resets when switches dimensions
+// so, clear everything to restart
+static inline void tg_min_reset(RRDR *r) {
+ struct tg_min *g = (struct tg_min *)r->time_grouping.data;
+ g->min = 0;
+ g->count = 0;
+}
+
+static inline void tg_min_free(RRDR *r) {
+ onewayalloc_freez(r->internal.owa, r->time_grouping.data);
+ r->time_grouping.data = NULL;
+}
+
+static inline void tg_min_add(RRDR *r, NETDATA_DOUBLE value) {
+ struct tg_min *g = (struct tg_min *)r->time_grouping.data;
+
+ if(!g->count || fabsndd(value) < fabsndd(g->min)) {
+ g->min = value;
+ g->count++;
+ }
+}
+
+static inline NETDATA_DOUBLE tg_min_flush(RRDR *r, RRDR_VALUE_FLAGS *rrdr_value_options_ptr) {
+ struct tg_min *g = (struct tg_min *)r->time_grouping.data;
+
+ NETDATA_DOUBLE value;
+
+ if(unlikely(!g->count)) {
+ value = 0.0;
+ *rrdr_value_options_ptr |= RRDR_VALUE_EMPTY;
+ }
+ else {
+ value = g->min;
+ }
+
+ g->min = 0.0;
+ g->count = 0;
+
+ return value;
+}
+
+#endif //NETDATA_API_QUERY_MIN_H