| 1 | { |
| 2 | "jsonSchema": { |
| 3 | "$schema": "http://json-schema.org/draft-07/schema#", |
| 4 | "type": "object", |
| 5 | "title": "Ping collector configuration.", |
| 6 | "properties": { |
| 7 | "update_every": { |
| 8 | "title": "Update every", |
| 9 | "description": "Data collection interval, measured in seconds.", |
| 10 | "type": "integer", |
| 11 | "minimum": 1, |
| 12 | "default": 5 |
| 13 | }, |
| 14 | "privileged": { |
| 15 | "title": "Privileged mode", |
| 16 | "description": "If set, sends raw ICMP ping packets; otherwise, sends unprivileged UDP ping packets (require [additional configuration](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/collector/ping#overview)).", |
| 17 | "type": "boolean", |
| 18 | "default": true |
| 19 | }, |
| 20 | "hosts": { |
| 21 | "title": "Network hosts", |
| 22 | "description": "List of network hosts (IP addresses or domain names) to send ping packets.", |
| 23 | "type": [ |
| 24 | "array", |
| 25 | "null" |
| 26 | ], |
| 27 | "items": { |
| 28 | "title": "Host", |
| 29 | "type": "string" |
| 30 | }, |
| 31 | "minItems": 1, |
| 32 | "uniqueItems": true |
| 33 | }, |
| 34 | "network": { |
| 35 | "title": "Network", |
| 36 | "description": "The protocol version used for resolving the specified hosts IP addresses.", |
| 37 | "type": "string", |
| 38 | "default": "ip", |
| 39 | "enum": [ |
| 40 | "ip", |
| 41 | "ip4", |
| 42 | "ip6" |
| 43 | ] |
| 44 | }, |
| 45 | "packets": { |
| 46 | "title": "Packets", |
| 47 | "description": "Number of ping packets to send for each host.", |
| 48 | "type": "integer", |
| 49 | "minimum": 1, |
| 50 | "default": 5 |
| 51 | }, |
| 52 | "interval": { |
| 53 | "title": "Interval", |
| 54 | "description": "Timeout between sending ping packets, in seconds.", |
| 55 | "type": "number", |
| 56 | "minimum": 0.1, |
| 57 | "default": 0.1 |
| 58 | }, |
| 59 | "interface": { |
| 60 | "title": "Interface", |
| 61 | "description": "The network device name (e.g., `eth0`, `wlan0`) used as the source for ICMP echo requests.", |
| 62 | "type": "string", |
| 63 | "default": "" |
| 64 | }, |
| 65 | "jitter_ewma_samples": { |
| 66 | "title": "Jitter EWMA samples", |
| 67 | "description": "EWMA smoothing factor for jitter calculation. Higher values result in smoother but slower-responding jitter metrics.", |
| 68 | "type": "integer", |
| 69 | "minimum": 1, |
| 70 | "default": 16 |
| 71 | }, |
| 72 | "jitter_sma_window": { |
| 73 | "title": "Jitter SMA window", |
| 74 | "description": "Number of iterations for calculating Simple Moving Average jitter.", |
| 75 | "type": "integer", |
| 76 | "minimum": 1, |
| 77 | "default": 10 |
| 78 | }, |
| 79 | "vnode": { |
| 80 | "title": "Vnode", |
| 81 | "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).", |
| 82 | "type": "string" |
| 83 | } |
| 84 | }, |
| 85 | "required": [ |
| 86 | "hosts" |
| 87 | ] |
| 88 | }, |
| 89 | "uiSchema": { |
| 90 | "uiOptions": { |
| 91 | "fullPage": true |
| 92 | }, |
| 93 | "vnode": { |
| 94 | "ui:placeholder": "To use this option, first create a Virtual Node and then reference its name here." |
| 95 | }, |
| 96 | "update_every": { |
| 97 | "ui:help": "Sets the frequency at which a specified number of ping packets (determined by 'packets') are sent to designated hosts." |
| 98 | }, |
| 99 | "network": { |
| 100 | "ui:help": "`ip` selects IPv4 or IPv6 based on system configuration, `ipv4` forces resolution to IPv4 addresses, and `ipv6` forces resolution to IPv6 addresses.", |
| 101 | "ui:widget": "radio", |
| 102 | "ui:options": { |
| 103 | "inline": true |
| 104 | } |
| 105 | }, |
| 106 | "interval": { |
| 107 | "ui:help": "Accepts decimals for precise control (e.g., type 1.5 for 1.5 seconds)." |
| 108 | }, |
| 109 | "hosts": { |
| 110 | "ui:listFlavour": "list" |
| 111 | } |
| 112 | } |
| 113 | } |