feat: change nonReapeater and add maxRepetitions as configurable

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Changed
 - add docker compose deployment
+- change nonReapeater to 0 and add maxRepetitions as configurable
 
 ## [1.10.0]
 

charts/splunk-connect-for-snmp/templates/worker/_helpers.tpl

@@ -111,6 +111,8 @@ Common labels
   value: {{ .Values.worker.udpConnectionTimeout | default "3" | quote }}
 - name: MAX_OID_TO_PROCESS
   value: {{ .Values.poller.maxOidToProcess | default "70" | quote }}
+- name: MAX_REPETITIONS
+  value: {{ .Values.poller.maxRepetitions | default "10" | quote }}
 - name: PROFILES_RELOAD_DELAY
   value: {{ .Values.worker.profilesReloadDelay | default "60" | quote }}
 - name: MIB_SOURCES

charts/splunk-connect-for-snmp/values.yaml

@@ -218,10 +218,14 @@ poller:
   # https://github:com/splunk/splunk-connect-for-snmp/blob/main/splunk_connect_for_snmp/profiles/base.yaml
   pollBaseProfiles: true
 
-  # Sometimes SNMP Agent cannot accept more than X OIDs per once, so if the error "TooBig" is visible in logs,
+  # Sometimes SNMP Agent cannot accept more than X OIDs per once for SNMP GetRequest, so if the error "TooBig" is visible in logs,
   # decrease the number
   maxOidToProcess: 70
 
+  # maxRepetitions is a number of varbinds requested in response for each of the MIB variables in the request
+  # If this number is too high it can cause issues with SNMP response especially for old SNMP devices.
+  maxRepetitions: 10
+
   # list of kubernetes secrets name that will be used for polling
   # https://splunk.github.io/splunk-connect-for-snmp/main/configuration/poller-configuration/#define-usernamesecrets
   usernameSecrets: []

docs/configuration/poller-configuration.md

@@ -3,7 +3,7 @@
 Poller is a service which is responsible for querying 
 SNMP devices using the SNMP GET and WALK functionalities. Poller executes two main types of tasks:
 
-- The Walk task executes SNMP walk. SNMP walk is an SNMP application that uses SNMP GETNEXT requests to 
+- The Walk task executes SNMP walk. SNMP walk is an SNMP application that uses SNMP GETBULK requests to 
 collect SNMP data from the network and infrastructure of SNMP-enabled devices, such as switches and routers. It is a time-consuming task,
 which may overload the SNMP device when executed too often. It is used by the SC4SNMP to collect and push all OID values, which the provided ACL has access to. 
 
@@ -37,6 +37,32 @@ The default value is `WARNING`.
 ### Define usernameSecrets
 Secrets are required to run SNMPv3 polling. To add v3 authentication details, create the k8s Secret object: [SNMPv3 Configuration](snmpv3-configuration.md), and put its name in `poller.usernameSecrets`.
 
+### Define maxRepetitions
+The maxRepetitions is a parameter used in SNMP GetBulk call. It is responsible for controlling the
+amount of variables in one request. 
+```yaml
+poller:
+  maxRepetitions: 10
+```
+`maxRepetitions` variable is the amount of requested next oids in response for each of varbinds in one request sent.
+
+For example:
+
+The configured variables:
+```yaml
+poller:
+  maxRepetitions: 2
+```
+The requested varbinds in one getBulk call:
+```
+IP-MIB.ipNetToMediaNetAddress
+```
+
+[![PDU Request Example](../images/request_pdu_flow.png)](../images/request_pdu_flow.png)
+
+After third ResponsePDU the returned oids are out of scope for requested table, so the call is stopped. 
+It can be spotted on diagram that response for `IP-MIB.ipNetToMediaNetAddress` includes 2 oids as `maxRepetition` was set to 3.
+
 ### Append OID index part to the metrics
 
 Not every SNMP metric object is structured with its index as a one of the field values. We can append the index part of OID with:

rendered/manifests/tests/splunk-connect-for-snmp/templates/worker/poller/deployment.yaml

@@ -66,6 +66,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PROFILES_RELOAD_DELAY
               value: "60"
             - name: MIB_SOURCES

rendered/manifests/tests/splunk-connect-for-snmp/templates/worker/sender/deployment.yaml

@@ -66,6 +66,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PROFILES_RELOAD_DELAY
               value: "60"
             - name: MIB_SOURCES

rendered/manifests/tests/splunk-connect-for-snmp/templates/worker/trap/deployment.yaml

@@ -66,6 +66,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PROFILES_RELOAD_DELAY
               value: "60"
             - name: MIB_SOURCES
@@ -105,6 +107,12 @@ spec:
               value: "4"
             - name: PREFETCH_COUNT
               value: "30"
+            - name: RESOLVE_TRAP_ADDRESS
+              value: "false"
+            - name: MAX_DNS_CACHE_SIZE_TRAPS
+              value: "500"
+            - name: TTL_DNS_CACHE_TRAPS
+              value: "1800"
           volumeMounts:
             - name: config
               mountPath: "/app/config"

rendered/manifests/tests_autoscaling_enabled/splunk-connect-for-snmp/templates/worker/poller/deployment.yaml

@@ -65,6 +65,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PROFILES_RELOAD_DELAY
               value: "60"
             - name: MIB_SOURCES

rendered/manifests/tests_autoscaling_enabled/splunk-connect-for-snmp/templates/worker/sender/deployment.yaml

@@ -65,6 +65,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PROFILES_RELOAD_DELAY
               value: "60"
             - name: MIB_SOURCES

rendered/manifests/tests_autoscaling_enabled/splunk-connect-for-snmp/templates/worker/trap/deployment.yaml

@@ -65,6 +65,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PROFILES_RELOAD_DELAY
               value: "60"
             - name: MIB_SOURCES
@@ -104,6 +106,12 @@ spec:
               value: "4"
             - name: PREFETCH_COUNT
               value: "30"
+            - name: RESOLVE_TRAP_ADDRESS
+              value: "false"
+            - name: MAX_DNS_CACHE_SIZE_TRAPS
+              value: "500"
+            - name: TTL_DNS_CACHE_TRAPS
+              value: "1800"
           volumeMounts:
             - name: config
               mountPath: "/app/config"

rendered/manifests/tests_autoscaling_enabled_deprecated/splunk-connect-for-snmp/templates/worker/poller/deployment.yaml

@@ -65,6 +65,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PROFILES_RELOAD_DELAY
               value: "60"
             - name: MIB_SOURCES

rendered/manifests/tests_autoscaling_enabled_deprecated/splunk-connect-for-snmp/templates/worker/sender/deployment.yaml

@@ -65,6 +65,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PROFILES_RELOAD_DELAY
               value: "60"
             - name: MIB_SOURCES

rendered/manifests/tests_autoscaling_enabled_deprecated/splunk-connect-for-snmp/templates/worker/trap/deployment.yaml

@@ -65,6 +65,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PROFILES_RELOAD_DELAY
               value: "60"
             - name: MIB_SOURCES
@@ -104,6 +106,12 @@ spec:
               value: "4"
             - name: PREFETCH_COUNT
               value: "30"
+            - name: RESOLVE_TRAP_ADDRESS
+              value: "false"
+            - name: MAX_DNS_CACHE_SIZE_TRAPS
+              value: "500"
+            - name: TTL_DNS_CACHE_TRAPS
+              value: "1800"
           volumeMounts:
             - name: config
               mountPath: "/app/config"

rendered/manifests/tests_enable_ui/splunk-connect-for-snmp/templates/worker/poller/deployment.yaml

@@ -66,6 +66,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PROFILES_RELOAD_DELAY
               value: "60"
             - name: MIB_SOURCES

rendered/manifests/tests_enable_ui/splunk-connect-for-snmp/templates/worker/sender/deployment.yaml

@@ -66,6 +66,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PROFILES_RELOAD_DELAY
               value: "60"
             - name: MIB_SOURCES

rendered/manifests/tests_enable_ui/splunk-connect-for-snmp/templates/worker/trap/deployment.yaml

@@ -66,6 +66,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PROFILES_RELOAD_DELAY
               value: "60"
             - name: MIB_SOURCES
@@ -105,6 +107,12 @@ spec:
               value: "4"
             - name: PREFETCH_COUNT
               value: "30"
+            - name: RESOLVE_TRAP_ADDRESS
+              value: "false"
+            - name: MAX_DNS_CACHE_SIZE_TRAPS
+              value: "500"
+            - name: TTL_DNS_CACHE_TRAPS
+              value: "1800"
           volumeMounts:
             - name: config
               mountPath: "/app/config"

rendered/manifests/tests_only_polling/splunk-connect-for-snmp/templates/worker/poller/deployment.yaml

@@ -66,6 +66,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PROFILES_RELOAD_DELAY
               value: "60"
             - name: MIB_SOURCES

rendered/manifests/tests_only_polling/splunk-connect-for-snmp/templates/worker/sender/deployment.yaml

@@ -66,6 +66,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PROFILES_RELOAD_DELAY
               value: "60"
             - name: MIB_SOURCES

rendered/manifests/tests_only_traps/splunk-connect-for-snmp/templates/worker/sender/deployment.yaml

@@ -66,6 +66,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PROFILES_RELOAD_DELAY
               value: "60"
             - name: MIB_SOURCES

rendered/manifests/tests_only_traps/splunk-connect-for-snmp/templates/worker/trap/deployment.yaml

@@ -66,6 +66,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PROFILES_RELOAD_DELAY
               value: "60"
             - name: MIB_SOURCES
@@ -105,6 +107,12 @@ spec:
               value: "4"
             - name: PREFETCH_COUNT
               value: "30"
+            - name: RESOLVE_TRAP_ADDRESS
+              value: "false"
+            - name: MAX_DNS_CACHE_SIZE_TRAPS
+              value: "500"
+            - name: TTL_DNS_CACHE_TRAPS
+              value: "1800"
           volumeMounts:
             - name: config
               mountPath: "/app/config"

rendered/manifests/tests_probes_enabled/splunk-connect-for-snmp/templates/worker/poller/deployment.yaml

@@ -66,6 +66,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PROFILES_RELOAD_DELAY
               value: "60"
             - name: MIB_SOURCES

rendered/manifests/tests_probes_enabled/splunk-connect-for-snmp/templates/worker/sender/deployment.yaml

@@ -66,6 +66,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PROFILES_RELOAD_DELAY
               value: "60"
             - name: MIB_SOURCES

rendered/manifests/tests_probes_enabled/splunk-connect-for-snmp/templates/worker/trap/deployment.yaml

@@ -66,6 +66,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PROFILES_RELOAD_DELAY
               value: "60"
             - name: MIB_SOURCES
@@ -105,6 +107,12 @@ spec:
               value: "4"
             - name: PREFETCH_COUNT
               value: "30"
+            - name: RESOLVE_TRAP_ADDRESS
+              value: "false"
+            - name: MAX_DNS_CACHE_SIZE_TRAPS
+              value: "500"
+            - name: TTL_DNS_CACHE_TRAPS
+              value: "1800"
           volumeMounts:
             - name: config
               mountPath: "/app/config"