| 1 | { |
| 2 | "jsonSchema": { |
| 3 | "$schema": "http://json-schema.org/draft-07/schema#", |
| 4 | "title": "Unbound collector configuration.", |
| 5 | "type": "object", |
| 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": 1 |
| 13 | }, |
| 14 | "autodetection_retry": { |
| 15 | "title": "Detection retry", |
| 16 | "description": "Recheck interval in seconds. Zero means no recheck will be scheduled.", |
| 17 | "type": "integer", |
| 18 | "minimum": 0, |
| 19 | "default": 60 |
| 20 | }, |
| 21 | "address": { |
| 22 | "title": "Address", |
| 23 | "description": "The IP address and port where the Unbound server listens for connections.", |
| 24 | "type": "string", |
| 25 | "default": "127.0.0.1:8953" |
| 26 | }, |
| 27 | "timeout": { |
| 28 | "title": "Timeout", |
| 29 | "description": "The timeout duration, in seconds, for connection, read, write, and SSL handshake operations.", |
| 30 | "type": "number", |
| 31 | "minimum": 0.5, |
| 32 | "default": 1 |
| 33 | }, |
| 34 | "conf_path": { |
| 35 | "title": "Path to unbound.conf", |
| 36 | "description": "The absolute path to the Unbound configuration file. Providing this path enables the tool to make adjustments based on the 'remote-control' section.", |
| 37 | "type": "string", |
| 38 | "default": "/etc/unbound/unbound.conf" |
| 39 | }, |
| 40 | "cumulative_stats": { |
| 41 | "title": "Cumulative stats", |
| 42 | "description": "Specifies whether statistics collection mode is enabled. Should match the 'statistics-cumulative' parameter in unbound.conf.", |
| 43 | "type": "boolean", |
| 44 | "default": false |
| 45 | }, |
| 46 | "vnode": { |
| 47 | "title": "Vnode", |
| 48 | "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).", |
| 49 | "type": "string" |
| 50 | }, |
| 51 | "use_tls": { |
| 52 | "title": "Use TLS", |
| 53 | "description": "Indicates whether TLS should be used for secure communication.", |
| 54 | "type": "boolean", |
| 55 | "default": true |
| 56 | }, |
| 57 | "tls_skip_verify": { |
| 58 | "title": "Skip TLS verification", |
| 59 | "description": "If set, TLS certificate verification will be skipped.", |
| 60 | "type": "boolean", |
| 61 | "default": true |
| 62 | }, |
| 63 | "tls_ca": { |
| 64 | "title": "TLS CA", |
| 65 | "description": "The path to the CA certificate file for TLS verification.", |
| 66 | "type": "string", |
| 67 | "pattern": "^$|^/" |
| 68 | }, |
| 69 | "tls_cert": { |
| 70 | "title": "TLS certificate", |
| 71 | "description": "The path to the client certificate file for TLS authentication.", |
| 72 | "type": "string", |
| 73 | "default": "/etc/unbound/unbound_control.pem", |
| 74 | "pattern": "^$|^/" |
| 75 | }, |
| 76 | "tls_key": { |
| 77 | "title": "TLS key", |
| 78 | "description": "The path to the client key file for TLS authentication.", |
| 79 | "type": "string", |
| 80 | "default": "/etc/unbound/unbound_control.key", |
| 81 | "pattern": "^$|^/" |
| 82 | } |
| 83 | }, |
| 84 | "required": [ |
| 85 | "address" |
| 86 | ] |
| 87 | }, |
| 88 | "uiSchema": { |
| 89 | "uiOptions": { |
| 90 | "fullPage": true |
| 91 | }, |
| 92 | "vnode": { |
| 93 | "ui:placeholder": "To use this option, first create a Virtual Node and then reference its name here." |
| 94 | }, |
| 95 | "autodetection_retry": { |
| 96 | "ui:help": "This option determines how frequently (in seconds) Netdata will retry data collection jobs that failed initially, with the value of 60 meaning it retries to start data collection jobs every 60 seconds, while setting it to 0 disables this retry mechanism entirely." |
| 97 | }, |
| 98 | "timeout": { |
| 99 | "ui:help": "Accepts decimals for precise control (e.g., type 1.5 for 1.5 seconds)." |
| 100 | }, |
| 101 | "ui:flavour": "tabs", |
| 102 | "ui:options": { |
| 103 | "tabs": [ |
| 104 | { |
| 105 | "title": "Base", |
| 106 | "fields": [ |
| 107 | "update_every", |
| 108 | "autodetection_retry", |
| 109 | "address", |
| 110 | "timeout", |
| 111 | "conf_path", |
| 112 | "cumulative_stats", |
| 113 | "vnode" |
| 114 | ] |
| 115 | }, |
| 116 | { |
| 117 | "title": "TLS", |
| 118 | "fields": [ |
| 119 | "use_tls", |
| 120 | "tls_skip_verify", |
| 121 | "tls_ca", |
| 122 | "tls_cert", |
| 123 | "tls_key" |
| 124 | ] |
| 125 | } |
| 126 | ] |
| 127 | } |
| 128 | } |
| 129 | } |