feat: support for local mibs in docker compose installation

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

@@ -14,12 +14,12 @@ type: application
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
 
-version: 1.13.0
+version: 1.14.0-beta.1
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "1.13.0"
+appVersion: "1.14.0-beta.1"
 #
 dependencies:
   - name: mongodb

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

@@ -123,6 +123,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: PYSNMP_DEBUG
   value: {{ .Values.pysnmpDebug | default "" | quote }}
 - name: PROFILES_RELOAD_DELAY

charts/splunk-connect-for-snmp/values.schema.json

@@ -362,6 +362,9 @@
         "maxOidToProcess": {
           "type": "integer"
         },
+        "maxRepetitions": {
+          "type": "integer"
+        },
         "usernameSecrets": {
           "type": "array"
         },

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

@@ -239,10 +239,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/microk8s/configuration/poller-configuration/#define-usernamesecrets
   usernameSecrets: []

docker_compose/.env

@@ -1,11 +1,12 @@
 # Deployment configuration
 SC4SNMP_IMAGE=ghcr.io/splunk/splunk-connect-for-snmp/container
-SC4SNMP_TAG="1.13.0"
+SC4SNMP_TAG="1.14.0-beta.1"
 SCHEDULER_CONFIG_FILE_ABSOLUTE_PATH=
 TRAPS_CONFIG_FILE_ABSOLUTE_PATH=
 INVENTORY_FILE_ABSOLUTE_PATH=
 COREFILE_ABS_PATH=
-SC4SNMP_VERSION="1.13.0"
+SC4SNMP_VERSION="1.14.0-beta.1"
+PATH_TO_LOCAL_MIBS=
 
 # Network configuration
 COREDNS_ADDRESS=172.28.0.255
@@ -53,6 +54,7 @@ WORKER_LOG_LEVEL=INFO
 WORKER_DISABLE_MONGO_DEBUG_LOGGING=true
 UDP_CONNECTION_TIMEOUT=3
 MAX_OID_TO_PROCESS=70
+MAX_REPETITIONS=10
 
 # Worker Poller
 WORKER_POLLER_CONCURRENCY=4

docker_compose/docker-compose.yaml

@@ -36,6 +36,7 @@ x-workers_general_setup: &workers_general_setup
   DISABLE_MONGO_DEBUG_LOGGING: ${WORKER_DISABLE_MONGO_DEBUG_LOGGING:-true}
   UDP_CONNECTION_TIMEOUT: ${UDP_CONNECTION_TIMEOUT:-3}
   MAX_OID_TO_PROCESS: ${MAX_OID_TO_PROCESS:-70}
+  MAX_REPETITIONS: ${MAX_REPETITIONS:-10}
   PROFILES_RELOAD_DELAY: ${PROFILES_RELOAD_DELAY:-60}
 
 x-ipv6: &ipv6
@@ -98,6 +99,7 @@ services:
       NGINX_ENTRYPOINT_QUIET_LOGS: ${NGINX_ENTRYPOINT_QUIET_LOGS:-1}
     volumes:
     - snmp-mibserver-tmp:/tmp/
+    - ${PATH_TO_LOCAL_MIBS}:/app/new_mibs/src/vendor
   redis:
     <<: [*dns_and_networks, *dependend_on_core_dns]
     image: ${REDIS_IMAGE}:${REDIS_TAG:-latest}

docs/dockercompose/6-env-file-configuration.md

@@ -62,7 +62,6 @@ Inside the directory with the docker compose files, there is a `.env`. Variables
 | `SPLUNK_METRIC_NAME_HYPHEN_TO_UNDERSCORE` | Replaces hyphens with underscores in generated metric names to ensure compatibility with Splunk's metric schema                       |
 | `IGNORE_EMPTY_VARBINDS`                   | Details can be found in [empty snmp response message issue](../troubleshooting/polling-issues.md#empty-snmp-response-message-problem) |
 | `SPLUNK_LOG_INDEX`                        | Event index in Splunk where logs from docker containers would be sent                                                                 |
-
 ## Workers
 
 ### General
@@ -76,6 +75,7 @@ Inside the directory with the docker compose files, there is a `.env`. Variables
 | `WORKER_LOG_LEVEL`           | Logging level of the workers, possible options: DEBUG, INFO, WARNING, ERROR, CRITICAL, or FATAL                                                        |
 | `UDP_CONNECTION_TIMEOUT`     | Timeout in seconds for SNMP operations                                                                                                                 |
 | `MAX_OID_TO_PROCESS`         | Sometimes SNMP Agent cannot accept more than X OIDs per once, so if the error "TooBig" is visible in logs, decrease the number of MAX_OID_TO_PROCESS   |
+| `MAX_REPETITIONS`            | The amount of requested next oids in response for each of varbinds in one request sent                                                               |
 
 ### Worker Poller
 | Variable                            | Description                                                                |

docs/mib-request.md

@@ -53,7 +53,7 @@ microk8s kubectl rollout restart deployment snmp-splunk-connect-for-snmp-worker-
 microk8s kubectl rollout restart deployment snmp-splunk-connect-for-snmp-worker-poller -n sc4snmp
 ```
 
-## Beta: use MIB server with local MIBs
+## Use MIB server with local MIBs
 
 From the `1.15.0` version of the MIB server, there is a way to use local MIB files. This may be useful when your MIB 
 files are proprietary, or you use SC4SNMP offline. This way, you can update necessary MIBs by yourself, without having to
@@ -68,7 +68,9 @@ vendor names will not make compilation fail, this is more for the logging purpos
 troubleshooting easier.
 3. MIB files should be named the same as the contained MIB module. The MIB module name is specified at the beginning of
 the MIB file before `::= BEGIN` keyword.
-4. Add the following to the `values.yaml`:
+
+### Configuring path to local MIBs for k8s installation
+Add the following to the `values.yaml`:
 
 ```yaml
 mibserver:
@@ -96,3 +98,21 @@ using `persistence.existingClaim`. If you go with the `localMibs.pathToMibs` sol
 (with `nodeSelector` set up to schedule MIB server pods on the same node where the MIB files are),
 when the Node with the mapped hostPath fails, you will have to access the MIB files on another node.
 
+### Configuring path to local mibs for docker-compose installation
+Add the following to the `.env`:
+
+```
+PATH_TO_LOCAL_MIBS=/home/user/local_mibs
+```
+
+Whenever you add new MIB files, restart MIB service to compile them again, using the following command:
+
+```bash
+sudo docker compose restart snmp-mibserver
+```
+
+To verify that the process of compilation was completed successfully, check the mibserver logs using the following command:
+
+```bash
+sudo docker logs snmp-mibserver
+```

docs/microk8s/configuration/poller-configuration.md

@@ -43,9 +43,6 @@ The log level for poller can be set by changing the value for the key `logLevel`
 The default value is `INFO`.
 
 ### Define maxRepetitions
-!!! info
-    Released only in improved polling package.
-
 The maxRepetitions is a parameter used in SNMP GetBulk call. It is responsible for controlling the
 amount of variables in one request. 
 ```yaml

docs/microk8s/configuration/values-params-description.md

@@ -102,6 +102,7 @@ Detailed documentation about configuring poller can be found in [Poller](poller-
 | `enableFullWalk`                     | Enables full walk of OIDs from device                                                                           | `false` |
 | `usernameSecrets`                    | List of kubernetes secrets name that will be used for polling                                                   |         |
 | `inventory`                          | List of configuration for polling                                                                               |         |
+| `maxRepetitions`                     | the amount of requested next oids in response for each of varbinds in one request sent                          | `10`    |
 | `logLevel`                           | Log level for a poller pod                                                                                      | `INFO`  |
 
 ## Worker

mkdocs.yml

@@ -92,7 +92,6 @@ nav:
           - Apply changes: "microk8s/gui/apply-changes.md"
       - Upgrade SC4SNMP: "microk8s/upgrade.md"
   - High Availability: "ha.md"
-  - Improved polling performance: "improved-polling.md"
   - Lightweight installation: "small-environment.md"
   - Splunk dashboards: "dashboard.md"
   - Releases: "releases.md"

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "splunk-connect-for-snmp"
-version = "1.13.0"
+version = "1.14.0-beta.1"
 description = ""
 authors = ["omrozowicz-splunk <[email protected]>"]
 license = "Apache-2.0"

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

@@ -68,6 +68,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PYSNMP_DEBUG
               value: ""
             - name: PROFILES_RELOAD_DELAY

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

@@ -68,6 +68,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PYSNMP_DEBUG
               value: ""
             - name: PROFILES_RELOAD_DELAY

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

@@ -68,6 +68,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PYSNMP_DEBUG
               value: ""
             - name: PROFILES_RELOAD_DELAY

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

@@ -67,6 +67,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PYSNMP_DEBUG
               value: ""
             - name: PROFILES_RELOAD_DELAY

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

@@ -67,6 +67,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PYSNMP_DEBUG
               value: ""
             - name: PROFILES_RELOAD_DELAY

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

@@ -67,6 +67,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PYSNMP_DEBUG
               value: ""
             - name: PROFILES_RELOAD_DELAY

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

@@ -67,6 +67,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PYSNMP_DEBUG
               value: ""
             - name: PROFILES_RELOAD_DELAY

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

@@ -67,6 +67,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PYSNMP_DEBUG
               value: ""
             - name: PROFILES_RELOAD_DELAY

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

@@ -67,6 +67,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PYSNMP_DEBUG
               value: ""
             - name: PROFILES_RELOAD_DELAY

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

@@ -68,6 +68,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PYSNMP_DEBUG
               value: ""
             - name: PROFILES_RELOAD_DELAY

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

@@ -68,6 +68,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PYSNMP_DEBUG
               value: ""
             - name: PROFILES_RELOAD_DELAY

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

@@ -68,6 +68,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PYSNMP_DEBUG
               value: ""
             - name: PROFILES_RELOAD_DELAY

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

@@ -68,6 +68,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PYSNMP_DEBUG
               value: ""
             - name: PROFILES_RELOAD_DELAY

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

@@ -68,6 +68,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PYSNMP_DEBUG
               value: ""
             - name: PROFILES_RELOAD_DELAY

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

@@ -68,6 +68,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PYSNMP_DEBUG
               value: ""
             - name: PROFILES_RELOAD_DELAY

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

@@ -68,6 +68,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PYSNMP_DEBUG
               value: ""
             - name: PROFILES_RELOAD_DELAY

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

@@ -68,6 +68,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PYSNMP_DEBUG
               value: ""
             - name: PROFILES_RELOAD_DELAY

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

@@ -68,6 +68,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PYSNMP_DEBUG
               value: ""
             - name: PROFILES_RELOAD_DELAY

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

@@ -68,6 +68,8 @@ spec:
               value: "3"
             - name: MAX_OID_TO_PROCESS
               value: "70"
+            - name: MAX_REPETITIONS
+              value: "10"
             - name: PYSNMP_DEBUG
               value: ""
             - name: PROFILES_RELOAD_DELAY