summaryrefslogtreecommitdiffstats
path: root/src/go/collectors/go.d.plugin/modules/portcheck/config_schema.json
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/go/collectors/go.d.plugin/modules/portcheck/config_schema.json66
1 files changed, 66 insertions, 0 deletions
diff --git a/src/go/collectors/go.d.plugin/modules/portcheck/config_schema.json b/src/go/collectors/go.d.plugin/modules/portcheck/config_schema.json
new file mode 100644
index 000000000..025b78f85
--- /dev/null
+++ b/src/go/collectors/go.d.plugin/modules/portcheck/config_schema.json
@@ -0,0 +1,66 @@
+{
+ "jsonSchema": {
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "title": "Portcheck collector configuration.",
+ "description": "Collector for monitoring TCP service availability and response time.",
+ "type": "object",
+ "properties": {
+ "update_every": {
+ "title": "Update every",
+ "description": "Data collection interval, measured in seconds.",
+ "type": "integer",
+ "minimum": 1,
+ "default": 5
+ },
+ "timeout": {
+ "title": "Timeout",
+ "description": "Timeout for establishing a connection, including domain name resolution, in seconds.",
+ "type": "number",
+ "minimum": 0.5,
+ "default": 2
+ },
+ "host": {
+ "title": "Network host",
+ "description": "The IP address or domain name of the network host.",
+ "type": "string"
+ },
+ "ports": {
+ "title": "Ports",
+ "description": "A list of ports to monitor for TCP service availability and response time.",
+ "type": [
+ "array",
+ "null"
+ ],
+ "items": {
+ "title": "Port",
+ "type": "integer",
+ "minimum": 1
+ },
+ "minItems": 1,
+ "uniqueItems": true
+ }
+ },
+ "required": [
+ "host",
+ "ports"
+ ],
+ "additionalProperties": false,
+ "patternProperties": {
+ "^name$": {}
+ }
+ },
+ "uiSchema": {
+ "uiOptions": {
+ "fullPage": true
+ },
+ "timeout": {
+ "ui:help": "Accepts decimals for precise control (e.g., type 1.5 for 1.5 seconds)."
+ },
+ "host": {
+ "ui:placeholder": "127.0.0.1"
+ },
+ "ports": {
+ "ui:listFlavour": "list"
+ }
+ }
+}