Add site analytics example

config/examples/site_analytics.yaml

@@ -0,0 +1,31 @@
+input:
+  http_server:
+    address: 0.0.0.0:4196
+    path: /poke
+    allowed_verbs: [ POST, HEAD ]
+    cors:
+      enabled: true
+      allowed_origins:
+        - '*'
+  processors:
+    - metric:
+        type: counter
+        name: site_visit
+        labels:
+          host: ${! meta("h") }
+          path: ${! meta("p") }
+          referrer: ${! meta("r") }
+    - bloblang: 'root = deleted()'
+
+metrics:
+  prometheus:
+    prefix: ""
+    path_mapping: |
+      # Undo wonky '_' to '__' replace that's done automatically.
+      # TODO: V4 this won't be necessary
+      let path = this.replace("__", "_")
+
+      # Only emit our custom metric, and no internal Benthos metrics.
+      root = if ![
+        "site_visit",
+      ].contains($path) { deleted() } else { $path }

lib/metrics/prometheus.go

@@ -147,7 +147,7 @@ func NewPrometheus(config Config, opts ...func(Type)) (Type, error) {
 		opt(p)
 	}
 
-	// TODO: Maybe disable this with a config flag.
+	// TODO: V4 Maybe disable this with a config flag.
 	if err := p.reg.Register(collectors.NewProcessCollector(collectors.ProcessCollectorOpts{})); err != nil {
 		return nil, err
 	}

website/docusaurus.config.js

@@ -129,6 +129,7 @@ module.exports = {
     ],
   ],
   plugins: [
+    path.resolve(__dirname, './src/plugins/analytics'),
     path.resolve(__dirname, './src/plugins/cookbooks'),
     path.resolve(__dirname, './src/plugins/redirects'),
   ],

website/src/plugins/analytics/client.js

@@ -0,0 +1,16 @@
+const host = window.location.hostname;
+
+function poke(path) {
+  // TODO: Allow this to be configured
+  fetch(`https://poke.benthos.dev/poke?h=${encodeURIComponent(host)}&p=${encodeURIComponent(path)}`, { method: "POST" })
+    .catch((error) => console.error(error))
+}
+
+module.exports = (() => {
+  poke(window.location.pathname);
+  return {
+    onRouteUpdate({location}) {
+      poke(location.pathname);
+    },
+  };
+})();

website/src/plugins/analytics/index.js

@@ -0,0 +1,12 @@
+const path = require('path');
+
+const isProd = process.env.NODE_ENV === 'production';
+
+module.exports = function(context, options) {
+  return {
+    name: 'blob-analytics',
+    getClientModules() {
+      return isProd ? [path.resolve(__dirname, './client')] : [];
+    },
+  };
+};