| 1 | { |
| 2 | "jsonSchema": { |
| 3 | "$schema": "http://json-schema.org/draft-07/schema#", |
| 4 | "type": "object", |
| 5 | "title": "Redis 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": 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": "URI", |
| 23 | "description": "The URI specifying the connection details for the Redis server.", |
| 24 | "type": "string", |
| 25 | "default": "redis://@localhost:6379" |
| 26 | }, |
| 27 | "timeout": { |
| 28 | "title": "Timeout", |
| 29 | "description": "Timeout for establishing a connection and communication (reading and writing) in seconds.", |
| 30 | "type": "number", |
| 31 | "minimum": 0.5, |
| 32 | "default": 1 |
| 33 | }, |
| 34 | "ping_samples": { |
| 35 | "title": "Ping samples", |
| 36 | "description": "The number of PING commands to send per data collection interval. Used to calculate latency.", |
| 37 | "type": "integer", |
| 38 | "minimum": 1, |
| 39 | "default": 5 |
| 40 | }, |
| 41 | "vnode": { |
| 42 | "title": "Vnode", |
| 43 | "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).", |
| 44 | "type": "string" |
| 45 | }, |
| 46 | "username": { |
| 47 | "title": "Username", |
| 48 | "description": "The username for authentication.", |
| 49 | "type": "string", |
| 50 | "sensitive": true |
| 51 | }, |
| 52 | "password": { |
| 53 | "title": "Password", |
| 54 | "description": "The password for authentication.", |
| 55 | "type": "string", |
| 56 | "sensitive": true |
| 57 | }, |
| 58 | "tls_skip_verify": { |
| 59 | "title": "Skip TLS verification", |
| 60 | "description": "If set, TLS certificate verification will be skipped.", |
| 61 | "type": "boolean" |
| 62 | }, |
| 63 | "tls_ca": { |
| 64 | "title": "TLS CA", |
| 65 | "description": "The path to the CA certificate file for TLS verification.", |
| 66 | "type": "string" |
| 67 | }, |
| 68 | "tls_cert": { |
| 69 | "title": "TLS certificate", |
| 70 | "description": "The path to the client certificate file for TLS authentication.", |
| 71 | "type": "string" |
| 72 | }, |
| 73 | "tls_key": { |
| 74 | "title": "TLS key", |
| 75 | "description": "The path to the client key file for TLS authentication.", |
| 76 | "type": "string" |
| 77 | }, |
| 78 | "functions": { |
| 79 | "title": "Functions", |
| 80 | "type": "object", |
| 81 | "properties": { |
| 82 | "top_queries": { |
| 83 | "title": "Top Queries", |
| 84 | "type": "object", |
| 85 | "properties": { |
| 86 | "disabled": { |
| 87 | "title": "Disabled", |
| 88 | "description": "Disable the top-queries function.", |
| 89 | "type": "boolean", |
| 90 | "default": false |
| 91 | }, |
| 92 | "timeout": { |
| 93 | "title": "Timeout", |
| 94 | "description": "Query timeout in seconds. Set to 0 to use the collector's timeout.", |
| 95 | "type": "number", |
| 96 | "minimum": 0 |
| 97 | }, |
| 98 | "limit": { |
| 99 | "title": "Limit", |
| 100 | "description": "Maximum number of queries to return. Set to 0 to use the default (500).", |
| 101 | "type": "integer", |
| 102 | "minimum": 0, |
| 103 | "maximum": 5000, |
| 104 | "default": 500 |
| 105 | } |
| 106 | } |
| 107 | } |
| 108 | } |
| 109 | } |
| 110 | }, |
| 111 | "required": [ |
| 112 | "address" |
| 113 | ] |
| 114 | }, |
| 115 | "uiSchema": { |
| 116 | "uiOptions": { |
| 117 | "fullPage": true |
| 118 | }, |
| 119 | "vnode": { |
| 120 | "ui:placeholder": "To use this option, first create a Virtual Node and then reference its name here." |
| 121 | }, |
| 122 | "autodetection_retry": { |
| 123 | "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." |
| 124 | }, |
| 125 | "address": { |
| 126 | "ui:placeholder": "redis://user:password@host:port", |
| 127 | "ui:help": "Tcp connection: `redis://user:password@host:port`. Unix connection: `unix://user:password@/path/to/redis.sock`." |
| 128 | }, |
| 129 | "timeout": { |
| 130 | "ui:help": "Accepts decimals for precise control (e.g., type 1.5 for 1.5 seconds)." |
| 131 | }, |
| 132 | "username": { |
| 133 | "ui:widget": "password" |
| 134 | }, |
| 135 | "password": { |
| 136 | "ui:widget": "password" |
| 137 | }, |
| 138 | "ui:flavour": "tabs", |
| 139 | "ui:options": { |
| 140 | "tabs": [ |
| 141 | { |
| 142 | "title": "Base", |
| 143 | "fields": [ |
| 144 | "update_every", |
| 145 | "autodetection_retry", |
| 146 | "address", |
| 147 | "timeout", |
| 148 | "ping_samples", |
| 149 | "vnode" |
| 150 | ] |
| 151 | }, |
| 152 | { |
| 153 | "title": "Auth", |
| 154 | "fields": [ |
| 155 | "username", |
| 156 | "password" |
| 157 | ] |
| 158 | }, |
| 159 | { |
| 160 | "title": "TLS", |
| 161 | "fields": [ |
| 162 | "tls_skip_verify", |
| 163 | "tls_ca", |
| 164 | "tls_cert", |
| 165 | "tls_key" |
| 166 | ] |
| 167 | }, |
| 168 | { |
| 169 | "title": "Functions", |
| 170 | "fields": [ |
| 171 | "functions" |
| 172 | ] |
| 173 | } |
| 174 | ] |
| 175 | } |
| 176 | } |
| 177 | } |