Added code for identifiying anomalies with metrics stored in InfluxDB

5 files changed, 186 insertions, 2 deletions

diff --git a/configure.ac b/configure.ac
index 058bd869c..bd2488e78 100644
--- a/configure.ac
+++ b/configure.ac
@@ -285,7 +285,7 @@ dnl>   ADDITIONAL_LIBS="${ADDITIONAL_LIBS} -lcurl"
 dnl>   AC_DEFINE_UNQUOTED(HAVE_CURL, 1, [curl is present])
 dnl> fi
 
-AC_CONFIG_FILES([Makefile example/Makefile example/Makefile.dpdk tests/Makefile tests/unit/Makefile tests/performance/Makefile tests/dga/Makefile rrdtool/Makefile libndpi.pc src/include/ndpi_define.h src/lib/Makefile fuzz/Makefile src/include/ndpi_api.h])
+AC_CONFIG_FILES([Makefile example/Makefile example/Makefile.dpdk tests/Makefile tests/unit/Makefile tests/performance/Makefile tests/dga/Makefile rrdtool/Makefile influxdb/Makefile libndpi.pc src/include/ndpi_define.h src/lib/Makefile fuzz/Makefile src/include/ndpi_api.h])
 AC_CONFIG_FILES([tests/do.sh], [chmod +x tests/do.sh])
 AC_CONFIG_HEADERS(src/include/ndpi_config.h)
 AC_SUBST(GIT_RELEASE)
diff --git a/influxdb/Makefile.in b/influxdb/Makefile.in
new file mode 100644
index 000000000..17ea45c53
--- /dev/null
+++ b/influxdb/Makefile.in
@@ -0,0 +1,23 @@
+CC=@CC@
+INC=-I ../src/include -I/usr/local/include
+LIBDPI=../src/lib/libndpi.a
+LDFLAGS=@LDFLAGS@
+LIB=$(LIBDPI) -lrrd -lm @LIBS@ @ADDITIONAL_LIBS@
+
+TOOLS=metric_anomaly
+
+all: $(TOOLS)
+
+metric_anomaly: metric_anomaly.c Makefile $(LIBDPI)
+	$(CC) $(CPPFLAGS) -g $(INC) $(LDFLAGS) metric_anomaly.c -o metric_anomaly $(LIB)
+
+clean:
+	/bin/rm -f *.o $(TOOLS) *~
+
+distclean: clean
+	/bin/rm -f Makefile
+
+distdir:
+
+install:
+	@echo -n ""
diff --git a/influxdb/README.txt b/influxdb/README.txt
new file mode 100644
index 000000000..ba1d7bd5f
--- /dev/null
+++ b/influxdb/README.txt
@@ -0,0 +1,4 @@
+
+This directory contains a tool that allows anomalies to be identified with InfluxDB
+
+
diff --git a/influxdb/metric_anomaly.c b/influxdb/metric_anomaly.c
new file mode 100644
index 000000000..d77ba74c0
--- /dev/null
+++ b/influxdb/metric_anomaly.c
@@ -0,0 +1,157 @@
+/*
+ * metric_anomaly.c
+ *
+ * Copyright (C) 2011-22 - ntop.org
+ *
+ * nDPI is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * nDPI is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with nDPI.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <math.h>
+#include <getopt.h>
+#include "ndpi_api.h"
+
+#define  DEFAULT_ALPHA   0.5
+#define  DEFAULT_RO      0.05
+
+/* *************************************************** */
+
+static void help() {
+  printf("Usage: metric_anomaly [-Q][-v][-a <alpha>][-q] -d <database> -q <query>\n"
+	 "-a             | Set alpha. Valid range >0 .. <1. Default %.2f\n"
+	 "-Q             | Quick output (only anomalies are reported)\n"
+	 "-d <database>  | InfluxDB database name\n"
+	 "-q <query>     | InfluxQL query\n"
+	 "-v             | Verbose\n"
+	 ,
+	 DEFAULT_ALPHA);
+
+  printf("\n\nExample: metric_anomaly -d ntopng -q \"%s\"\n",
+	 "SELECT mean(\"cpu0\") FROM \"cpu_load\" WHERE time > 1648634807000000000 GROUP BY time(60s) fill(previous)");
+  exit(0);
+}
+
+/* *************************************************** */
+
+int main(int argc, char *argv[]) {
+  char *database = NULL, *query = NULL, cmd[512], buf[256];
+  u_int i, j, first = 1, quick_mode = 0, verbose = 0;
+  struct ndpi_ses_struct ses;
+  float alpha, ro;
+  char c;
+  FILE *fd;
+  
+  /* Defaults */
+  alpha   = DEFAULT_ALPHA;
+  ro      = DEFAULT_RO;
+  
+  while((c = getopt(argc, argv, "a:Qd:q:v")) != '?') {
+    if(c == -1) break;
+
+    switch(c) {
+    case 'a':
+      {
+	float f = atof(optarg);
+
+	if((f > 0) && (f < 1))
+	  alpha = f;
+	else
+	  printf("Discarding -a: valid range is >0 .. <1\n");
+      }
+      break;
+
+    case 'Q':
+      quick_mode = 1;
+      break;
+
+    case 'd':
+      database = optarg;
+      break;
+
+    case 'q':
+      query = optarg;
+      break;
+
+    case 'v':
+      verbose = 1;
+      break;
+
+    default:
+      help();
+      break;
+    }
+  }
+
+  if((database == NULL) || (query == NULL))
+    help();
+
+  snprintf(cmd, sizeof(cmd), "influx -database '%s' -precision s -execute '%s'", database, query);
+
+  if(verbose) printf("%s\n", cmd);
+
+  if ((fd = popen(cmd, "r")) == NULL) {
+    printf("Unable to execute '%s'\n", cmd);
+    return(-1);
+  }
+
+  ndpi_ses_init(&ses, alpha, ro);
+  
+  while(fgets(buf, sizeof(buf), fd) != NULL) {
+    u_int32_t epoch;
+    float value;
+    double prediction, confidence_band;
+    double lower, upper;
+    int rc;
+    u_int is_anomaly;
+
+    if(sscanf(buf, "%u %f", &epoch, &value) != 2)
+      continue;
+
+    // printf("->>> '%s'", buf);
+      
+    value *= 100; /* trick to avoid dealing with floats */
+    rc = ndpi_ses_add_value(&ses, value, &prediction, &confidence_band);
+    lower = prediction - confidence_band, upper = prediction + confidence_band;
+    is_anomaly = ((rc == 0) || (confidence_band == 0) || ((value >= lower) && (value <= upper))) ? 0 : 1;
+    
+    if(verbose || is_anomaly) {
+      const time_t _t = epoch;
+      struct tm *t_info = localtime((const time_t*)&_t);
+
+      strftime(buf, sizeof(buf), "%d/%b/%Y %H:%M:%S", t_info);
+      
+      if(quick_mode) {
+	if(is_anomaly) {
+	  printf("%u [%s]\n", epoch, buf);
+	}
+      } else {       	
+	if(first) {
+	  first = 0;
+	  printf("%s                       %s\t%s    %s           %s\t %s     [%s]\n",
+		 "When", "Value", "Prediction", "Lower", "Upper", "Out", "Band");
+	}
+	
+	printf("%s %12.3f\t%.3f\t%12.3f\t%12.3f\t %s [%.3f]\n",
+	       buf, value/100., prediction/100., lower/100., upper/100., is_anomaly? "ANOMALY" : "OK",
+	       confidence_band/100.);
+      }
+    }    
+  }
+  
+  (void)pclose(fd);
+  
+  return(0);
+}
diff --git a/rrdtool/README.txt b/rrdtool/README.txt
index ba24e1bc6..44d99032a 100644
--- a/rrdtool/README.txt
+++ b/rrdtool/README.txt
@@ -1,5 +1,5 @@
 
-This directory contains a tool that allows to identify anomalies and similarities in RRD files
+This directory contains a tool that allows anomalies and similarities in RRD files to be identified
 
 
 Prerequisite