feature/policies

.gitignore

@@ -4,3 +4,4 @@ cmake-build-*/
 docs/html-documentation-generated*
 integration_tests/external
 golang/pkg/client/version.go
+docs/internals/html

docs/CONTROL_PLANE.md

@@ -0,0 +1,114 @@
+# Control Plane
+
+**_Draft_**
+
+pktvisord exposes a control plane over REST API.
+
+## Discovery
+
+pktvisord exposes a method for discovering the available modules, their configurable properties, and their associated
+metrics schema.
+
+All interfaces and schemas are versioned.
+
+```
+/api/v1/inputs
+ {
+  pcap: "1.0",
+  "dnstap": "1.0"
+ }
+/api/v1/inputs/pcap/interface
+ {
+  version: "1.0",
+  "info": {
+    "interfaces": {
+      "eth0": {}
+    }
+  },
+  "defaults": {
+    "interface": eth0
+  },
+  config: {
+   iface: {
+     type: "string",
+     description: "the ethernet interface to capture on"
+   }
+  }
+  filters: {
+    bpf: {
+     type: "string",
+     description: "tcpdump compatible bpf filter expression"
+    }
+  },
+  metric_groups: {
+  }
+ }
+/api/v1/inputs/dnstap/interface
+ {
+  version: "1.0",
+  config: {
+   socket: {
+     type: "string",
+     description: "the dnstap socket to listen to"
+   }
+  }
+  filters: {
+    qname_suffix: {
+     type: "string",
+     description: "match the DNS qname sufix given", 
+     regex: "..."
+    }
+  },
+  metric_groups: {
+  }
+ } 
+/api/v1/handlers
+ { dns: { version: "1.0" }, 
+   net: { version: "1.0" } }
+/api/v1/handlers/dns/interface
+ {
+  version: "1.0",
+  config: {
+    periods: {
+     type: "int",
+     description: "number of metric periods to keep"
+    }
+  }
+  filters: {
+    qname_suffix: {
+     type: "string",
+     description: "match the DNS qname sufix given", 
+     regex: "..."
+    }
+  },
+  metric_groups: {
+    top_error_qnames: {
+      description: "top N qnames with error result codes", 
+      metrics: {,
+       top_refused: {
+        "type": "top_n",
+         "description": "..."
+       },
+       top_srvfail: {
+        "type": "top_n",
+         "description": "..."
+       }, 
+       top_nxdomain: {
+        "type": "top_n",
+         "description": "..."
+       },
+      }
+    }, 
+    transactions: {
+      description: "information on query/reply pairs", 
+      metrics: {
+      ...
+      }
+    }
+  }
+ }
+/api/v1/handlers/net/interface
+ {
+ }
+```
+