summaryrefslogtreecommitdiffstats
path: root/src/go/collectors/go.d.plugin/modules/snmp/config_schema.json
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-08-26 08:15:20 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-08-26 08:15:20 +0000
commit87d772a7d708fec12f48cd8adc0dedff6e1025da (patch)
tree1fee344c64cc3f43074a01981e21126c8482a522 /src/go/collectors/go.d.plugin/modules/snmp/config_schema.json
parentAdding upstream version 1.46.3. (diff)
downloadnetdata-upstream.tar.xz
netdata-upstream.zip
Adding upstream version 1.47.0.upstream/1.47.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--src/go/plugin/go.d/modules/snmp/config_schema.json (renamed from src/go/collectors/go.d.plugin/modules/snmp/config_schema.json)67
1 files changed, 55 insertions, 12 deletions
diff --git a/src/go/collectors/go.d.plugin/modules/snmp/config_schema.json b/src/go/plugin/go.d/modules/snmp/config_schema.json
index a83a2da36..8deb4f6c8 100644
--- a/src/go/collectors/go.d.plugin/modules/snmp/config_schema.json
+++ b/src/go/plugin/go.d/modules/snmp/config_schema.json
@@ -8,7 +8,7 @@
"description": "Data collection interval, measured in seconds.",
"type": "integer",
"minimum": 1,
- "default": 1
+ "default": 10
},
"hostname": {
"title": "Hostname",
@@ -21,6 +21,26 @@
"type": "string",
"default": "public"
},
+ "network_interface_filter": {
+ "title": "Network interface filter",
+ "description": "Configuration for filtering specific network interfaces. If left empty, no interfaces will be filtered. You can filter interfaces by name or type using [simple patterns](/src/libnetdata/simple_pattern/README.md#simple-patterns).",
+ "type": [
+ "object",
+ "null"
+ ],
+ "properties": {
+ "by_name": {
+ "title": "By Name",
+ "description": "Specify the interface name or a pattern to match against the [ifName](https://cric.grenoble.cnrs.fr/Administrateurs/Outils/MIBS/?oid=1.3.6.1.2.1.31.1.1.1.1) label.",
+ "type": "string"
+ },
+ "by_type": {
+ "title": "By Type",
+ "description": "Specify the interface type or a pattern to match against the [ifType](https://cric.grenoble.cnrs.fr/Administrateurs/Outils/MIBS/?oid=1.3.6.1.2.1.2.2.1.3) label.",
+ "type": "string"
+ }
+ }
+ },
"options": {
"title": "Options",
"description": "Configuration options for SNMP monitoring.",
@@ -46,23 +66,30 @@
"exclusiveMinimum": 0,
"default": 161
},
+ "timeout": {
+ "title": "Timeout",
+ "description": "The timeout duration in seconds for SNMP requests.",
+ "type": "integer",
+ "minimum": 1,
+ "default": 5
+ },
"retries": {
"title": "Retries",
"description": "The number of retries to attempt for SNMP requests.",
"type": "integer",
"minimum": 0,
- "default": 161
+ "default": 1
},
- "timeout": {
- "title": "Timeout",
- "description": "The timeout duration in seconds for SNMP requests.",
+ "max_repetitions": {
+ "title": "Max repetitions",
+ "description": "Controls how many SNMP variables to retrieve in a single GETBULK request.",
"type": "integer",
"minimum": 1,
- "default": 1
+ "default": 25
},
"max_request_size": {
- "title": "Max OIDs in request",
- "description": "The maximum number of OIDs allowed in a single SNMP request.",
+ "title": "Max OIDs",
+ "description": "The maximum number of OIDs allowed in a single GET request.",
"type": "integer",
"minimum": 1,
"default": 60
@@ -144,7 +171,6 @@
"null"
],
"uniqueItems": true,
- "minItems": 1,
"items": {
"title": "Chart",
"type": [
@@ -284,8 +310,7 @@
"required": [
"hostname",
"community",
- "options",
- "charts"
+ "options"
],
"additionalProperties": false,
"patternProperties": {
@@ -296,15 +321,27 @@
"uiOptions": {
"fullPage": true
},
+ "network_interface_filter": {
+ "ui:collapsible": true
+ },
+ "community": {
+ "ui:widget": "password"
+ },
"options": {
"version": {
"ui:widget": "radio",
"ui:options": {
"inline": true
}
+ },
+ "max_repetitions": {
+ "ui:help": "A higher value retrieves more data in fewer round trips, potentially improving efficiency. This reduces network overhead compared to sending multiple individual requests. **Important**: Setting a value too high might cause the target device to return no data."
}
},
"user": {
+ "name": {
+ "ui:widget": "password"
+ },
"level": {
"ui:widget": "radio",
"ui:options": {
@@ -357,7 +394,13 @@
"fields": [
"update_every",
"hostname",
- "community",
+ "community"
+ ]
+ },
+ {
+ "title": "Options",
+ "fields": [
+ "network_interface_filter",
"options"
]
},