TT-10821: add support for analytics on MDCB (#242)

* TT-10821: add supoort for analytics on MDCB

* TT-10821: remove env from pump

* TT-10821: add values to umbrella chart

* TT-10821: rebase with main

* TT-10821: uncomment redis pass

Author: olamilekan000

components/tyk-mdcb/templates/deployment-mdcb.yaml

@@ -141,6 +141,23 @@ spec:
             {{- end }}
             - name: TYK_MDCB_FORWARDANALYTICSTOPUMP
               value: "{{ .Values.mdcb.forwardAnalyticsToPump }}"
+            - name: TYK_MDCB_ENABLEMULTIPLEANALYTICSKEYS
+              value: "{{ .Values.mdcb.enableMultipleAnalyticsKey }}"
+            - name: TYK_MDCB_DONTSTORESELECTIVE
+              value: "{{ .Values.mdcb.dontStoreSelective }}"
+            - name: TYK_MDCB_DONTSTOREAGGREGATES
+              value: "{{ .Values.mdcb.dontStoreAggregate }}"            
+          {{- if .Values.mdcb.ignoreTagPrefixList }}
+            - name: TYK_MDCB_IGNORETAGPREFIXLIST
+              value: |
+                {{- range .Values.mdcb.ignoreTagPrefixList }}
+                {{ . }}
+                {{- end }}
+          {{- end }}
+            - name: TYK_MDCB_TRACKALLPATHS
+              value: "{{ .Values.mdcb.trackAllPaths }}"
+            - name: TYK_MDCB_STOREANALYTICSPERMINUTE
+              value: "{{ .Values.mdcb.storeAnalyticsPerMinute }}"                                                     
             - name: TYK_MDCB_LICENSE
               valueFrom:
                 secretKeyRef:

components/tyk-mdcb/values.yaml

@@ -162,7 +162,28 @@ mdcb:
   # MDCB can send analytics to Redis. This will allow tyk-pump to pull
   # analytics from Redis and send to your own data sinks.
   # It is used to set TYK_MDCB_FORWARDANALYTICSTOPUMP
-  forwardAnalyticsToPump: true
+  forwardAnalyticsToPump: false
+
+  # This enables saving analytics in multiple keys as oppose to just having one.
+  # It is useful when using a Redis cluster.
+  # It also only works when TYK_MDCB_FORWARDANALYTICSTOPUMP is set to true.
+  enableMultipleAnalyticsKey: true
+
+  # This should be set to true if you choose not to store selective analytics
+  dontStoreSelective: false
+
+  # This should be set to true if you choose not to store aggregate analytics
+  dontStoreAggregate: false
+
+  # If set to true then it will not store analytics for tags having prefix specified in the list.
+  # NB: Prefix “key-” is added in the list by default. This tag is added by gateway for keys.
+  ignoreTagPrefixList: []
+
+  # If enabled, it will store analytics for all the endpoints, irrespective of Track Endpoint plugin.
+  trackAllPaths: false
+
+  # If enabled, aggregate data will be generated per minute.
+  storeAnalyticsPerMinute: false   
 
   probes:
     # This port lets MDCB allow standard health checks.

components/tyk-pump/README.md

@@ -206,7 +206,7 @@ to it in the `global.remoteControlPlane.useSecretName` field.
   # hybridPump configures Tyk Pump to forward Tyk metrics to a Tyk Control Plane.
   # Please add "hybrid" to .Values.pump.backend in order to enable Hybrid Pump.
   hybridPump: 
-    # Specify the frequency of the aggregation in minutes or simply turn it on by setting it to true
+    # Send aggregated analytics data to Tyk MDCB
     enableAggregateAnalytics: true
     # Hybrid pump RPC calls timeout in seconds. If not specified, default value will be picked up by Tyk Pump.
     callTimeout: 10

components/tyk-pump/values.yaml

@@ -242,7 +242,7 @@ pump:
   # hybridPump configures Tyk Pump to forward Tyk metrics to a Tyk Control Plane.
   # Please add "hybrid" to .Values.pump.backend in order to enable Hybrid Pump.
   hybridPump:
-    # Specify the frequency of the aggregation in minutes or simply turn it on by setting it to true
+    # This wiil allow tyk-pump to pull analytics from Redis and send to your own data sinks.
     enableAggregateAnalytics: true
     # Hybrid pump RPC calls timeout in seconds. If not specified, default value will be picked up by Tyk Pump.
     callTimeout: 10

tyk-control-plane/values.yaml

@@ -1050,7 +1050,28 @@ tyk-mdcb:
     # MDCB can send analytics to Redis. This will allow tyk-pump to pull
     # analytics from Redis and send to your own data sinks.
     # It is used to set TYK_MDCB_FORWARDANALYTICSTOPUMP
-    forwardAnalyticsToPump: true
+    forwardAnalyticsToPump: false
+
+    # This enables saving analytics in multiple keys as oppose to just having one.
+    # It is useful when using a Redis cluster.
+    # It also only works when TYK_MDCB_FORWARDANALYTICSTOPUMP is set to true.
+    enableMultipleAnalyticsKey: true
+
+    # This should be set to true if you choose not to store selective analytics
+    dontStoreSelective: false
+
+    # This should be set to true if you choose not to store aggregate analytics
+    dontStoreAggregate: false
+
+    # If set to true then it will not store analytics for tags having prefix specified in the list.
+    # NB: Prefix “key-” is added in the list by default. This tag is added by gateway for keys.
+    ignoreTagPrefixList: []
+
+    # If enabled, it will store analytics for all the endpoints, irrespective of Track Endpoint plugin.
+    trackAllPaths: false
+
+    # If enabled, aggregate data will be generated per minute.
+    storeAnalyticsPerMinute: true
 
     probes:
       # This port lets MDCB allow standard health checks.

tyk-data-plane/README.md

@@ -418,7 +418,7 @@ Add `hybrid` to `tyk-pump.pump.backend`, and add remoteControlPlane details unde
   # hybridPump configures Tyk Pump to forward Tyk metrics to a Tyk Control Plane.
   # Please add "hybrid" to .Values.pump.backend in order to enable Hybrid Pump.
   hybridPump:
-    # Specify the frequency of the aggregation in minutes or simply turn it on by setting it to true
+    # Send aggregated analytics data to Tyk MDCB
     enableAggregateAnalytics: true
     # Hybrid pump RPC calls timeout in seconds.
     callTimeout: 10

tyk-data-plane/values.yaml

@@ -550,7 +550,7 @@ tyk-pump:
     # hybridPump configures Tyk Pump to forward Tyk metrics to a Tyk Control Plane.
     # Please add "hybrid" to .Values.pump.backend in order to enable Hybrid Pump.
     hybridPump:
-      # Specify the frequency of the aggregation in minutes or simply turn it on by setting it to true
+      # Send aggregated analytics data to Tyk MDCB
       enableAggregateAnalytics: true
       # Hybrid pump RPC calls timeout in seconds. If not specified, default value will be picked up by Tyk Pump.
       callTimeout: 10