| 1 | { |
| 2 | "jsonSchema": { |
| 3 | "$schema": "http://json-schema.org/draft-07/schema#", |
| 4 | "title": "Portcheck collector configuration.", |
| 5 | "description": "Collector for monitoring TCP service availability and response time.", |
| 6 | "type": "object", |
| 7 | "properties": { |
| 8 | "update_every": { |
| 9 | "title": "Update every", |
| 10 | "description": "Data collection interval, measured in seconds.", |
| 11 | "type": "integer", |
| 12 | "minimum": 1, |
| 13 | "default": 5 |
| 14 | }, |
| 15 | "timeout": { |
| 16 | "title": "Timeout", |
| 17 | "description": "Timeout for establishing a connection, including domain name resolution, in seconds.", |
| 18 | "type": "number", |
| 19 | "minimum": 0.5, |
| 20 | "default": 2 |
| 21 | }, |
| 22 | "host": { |
| 23 | "title": "Network host", |
| 24 | "description": "The IP address or domain name of the network host.", |
| 25 | "type": "string", |
| 26 | "default": "127.0.0.1" |
| 27 | }, |
| 28 | "vnode": { |
| 29 | "title": "Vnode", |
| 30 | "description": "Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes).", |
| 31 | "type": "string" |
| 32 | }, |
| 33 | "ports": { |
| 34 | "title": "TCP ports", |
| 35 | "description": "A list of ports to monitor for TCP service availability and response time.", |
| 36 | "type": [ |
| 37 | "array", |
| 38 | "null" |
| 39 | ], |
| 40 | "items": { |
| 41 | "title": "Port", |
| 42 | "type": "integer", |
| 43 | "minimum": 1 |
| 44 | }, |
| 45 | "uniqueItems": true |
| 46 | }, |
| 47 | "udp_ports": { |
| 48 | "title": "UDP ports", |
| 49 | "description": "A list of ports to monitor for UDP service availability.", |
| 50 | "type": [ |
| 51 | "array", |
| 52 | "null" |
| 53 | ], |
| 54 | "items": { |
| 55 | "title": "Port", |
| 56 | "type": "integer", |
| 57 | "minimum": 1 |
| 58 | }, |
| 59 | "uniqueItems": true |
| 60 | } |
| 61 | }, |
| 62 | "required": [ |
| 63 | "host" |
| 64 | ] |
| 65 | }, |
| 66 | "uiSchema": { |
| 67 | "ui:flavour": "tabs", |
| 68 | "ui:options": { |
| 69 | "tabs": [ |
| 70 | { |
| 71 | "title": "Base", |
| 72 | "fields": [ |
| 73 | "update_every", |
| 74 | "timeout", |
| 75 | "host", |
| 76 | "vnode" |
| 77 | ] |
| 78 | }, |
| 79 | { |
| 80 | "title": "TCP", |
| 81 | "fields": [ |
| 82 | "ports" |
| 83 | ] |
| 84 | }, |
| 85 | { |
| 86 | "title": "UDP", |
| 87 | "fields": [ |
| 88 | "udp_ports" |
| 89 | ] |
| 90 | } |
| 91 | ] |
| 92 | }, |
| 93 | "uiOptions": { |
| 94 | "fullPage": true |
| 95 | }, |
| 96 | "vnode": { |
| 97 | "ui:placeholder": "To use this option, first create a Virtual Node and then reference its name here." |
| 98 | }, |
| 99 | "timeout": { |
| 100 | "ui:help": "Accepts decimals for precise control (e.g., type 1.5 for 1.5 seconds)." |
| 101 | }, |
| 102 | "host": { |
| 103 | "ui:placeholder": "127.0.0.1" |
| 104 | }, |
| 105 | "ports": { |
| 106 | "ui:listFlavour": "list" |
| 107 | }, |
| 108 | "udp_ports": { |
| 109 | "ui:help": "The collector sends 0-byte UDP packets to each port on the target system. If an ICMP Destination Unreachable message is received, the port is considered closed. Otherwise, it is assumed to be open or filtered (if no response is received within the timeout). This approach is similar to the behavior of the `close`/`open/filtered` states reported by `nmap`. However, note that the `open/filtered` state is a best-effort determination, as the collector does not actually exchange data with the application on the target system.", |
| 110 | "ui:listFlavour": "list" |
| 111 | } |
| 112 | } |
| 113 | } |