| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-maxscale |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: maxscale |
| 7 | monitored_instance: |
| 8 | name: MaxScale |
| 9 | link: https://mariadb.com/kb/en/maxscale/ |
| 10 | categories: |
| 11 | - data-collection.databases |
| 12 | icon_filename: maxscale.svg |
| 13 | related_resources: |
| 14 | integrations: |
| 15 | list: [] |
| 16 | alternative_monitored_instances: [] |
| 17 | info_provided_to_referring_integrations: |
| 18 | description: "" |
| 19 | keywords: |
| 20 | - maria |
| 21 | - mariadb |
| 22 | - maxscale |
| 23 | - database |
| 24 | - db |
| 25 | overview: |
| 26 | data_collection: |
| 27 | metrics_description: | |
| 28 | This collector monitors the activity and performance of MaxScale servers. |
| 29 | method_description: | |
| 30 | It sends HTTP requests to the MaxScale [REST API](https://mariadb.com/kb/en/maxscale-24-02rest-api/). |
| 31 | default_behavior: |
| 32 | auto_detection: |
| 33 | description: | |
| 34 | The collector can automatically detect MaxScale instances running on: |
| 35 | |
| 36 | - localhost that are listening on port 8989 |
| 37 | - within Docker containers |
| 38 | |
| 39 | > **Note that the MaxScale REST API requires a username and password**. |
| 40 | > While Netdata can automatically detect MaxScale instances and create data collection jobs, these jobs will fail unless you provide the necessary credentials. |
| 41 | limits: |
| 42 | description: "" |
| 43 | performance_impact: |
| 44 | description: "" |
| 45 | additional_permissions: |
| 46 | description: "" |
| 47 | multi_instance: true |
| 48 | supported_platforms: |
| 49 | include: [] |
| 50 | exclude: [] |
| 51 | setup: |
| 52 | prerequisites: |
| 53 | list: [] |
| 54 | configuration: |
| 55 | file: |
| 56 | name: go.d/maxscale.conf |
| 57 | options: |
| 58 | description: | |
| 59 | The following options can be defined globally: update_every, autodetection_retry. |
| 60 | folding: |
| 61 | title: Config options |
| 62 | enabled: true |
| 63 | list: |
| 64 | - name: update_every |
| 65 | description: Data collection interval (seconds). |
| 66 | default_value: 1 |
| 67 | required: false |
| 68 | group: Collection |
| 69 | - name: autodetection_retry |
| 70 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 71 | default_value: 0 |
| 72 | required: false |
| 73 | group: Collection |
| 74 | |
| 75 | - name: url |
| 76 | description: Target endpoint URL. |
| 77 | default_value: http://127.0.0.1:8989 |
| 78 | required: true |
| 79 | group: Target |
| 80 | - name: timeout |
| 81 | description: HTTP request timeout (seconds). |
| 82 | default_value: 1 |
| 83 | required: false |
| 84 | group: Target |
| 85 | |
| 86 | - name: username |
| 87 | description: Username for Basic HTTP authentication. |
| 88 | default_value: "admin" |
| 89 | required: false |
| 90 | group: HTTP Auth |
| 91 | - name: password |
| 92 | description: Password for Basic HTTP authentication. |
| 93 | default_value: "mariadb" |
| 94 | required: false |
| 95 | group: HTTP Auth |
| 96 | - name: bearer_token_file |
| 97 | description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)." |
| 98 | default_value: "" |
| 99 | required: false |
| 100 | group: HTTP Auth |
| 101 | |
| 102 | - name: tls_skip_verify |
| 103 | description: Skip TLS certificate and hostname verification (insecure). |
| 104 | default_value: no |
| 105 | required: false |
| 106 | group: TLS |
| 107 | - name: tls_ca |
| 108 | description: Path to CA bundle used to validate the server certificate. |
| 109 | default_value: "" |
| 110 | required: false |
| 111 | group: TLS |
| 112 | - name: tls_cert |
| 113 | description: Path to client TLS certificate (for mTLS). |
| 114 | default_value: "" |
| 115 | required: false |
| 116 | group: TLS |
| 117 | - name: tls_key |
| 118 | description: Path to client TLS private key (for mTLS). |
| 119 | default_value: "" |
| 120 | required: false |
| 121 | group: TLS |
| 122 | |
| 123 | - name: proxy_url |
| 124 | description: HTTP proxy URL. |
| 125 | default_value: "" |
| 126 | required: false |
| 127 | group: Proxy |
| 128 | - name: proxy_username |
| 129 | description: Username for proxy Basic HTTP authentication. |
| 130 | default_value: "" |
| 131 | required: false |
| 132 | group: Proxy |
| 133 | - name: proxy_password |
| 134 | description: Password for proxy Basic HTTP authentication. |
| 135 | default_value: "" |
| 136 | required: false |
| 137 | group: Proxy |
| 138 | |
| 139 | - name: method |
| 140 | description: HTTP method to use. |
| 141 | default_value: "GET" |
| 142 | required: false |
| 143 | group: Request |
| 144 | - name: body |
| 145 | description: Request body (e.g., for POST/PUT). |
| 146 | default_value: "" |
| 147 | required: false |
| 148 | group: Request |
| 149 | - name: headers |
| 150 | description: "Additional HTTP headers (one per line as key: value)." |
| 151 | default_value: "" |
| 152 | required: false |
| 153 | group: Request |
| 154 | - name: not_follow_redirects |
| 155 | description: Do not follow HTTP redirects. |
| 156 | default_value: no |
| 157 | required: false |
| 158 | group: Request |
| 159 | - name: force_http2 |
| 160 | description: Force HTTP/2 (including h2c over TCP). |
| 161 | default_value: no |
| 162 | required: false |
| 163 | group: Request |
| 164 | |
| 165 | - name: vnode |
| 166 | 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). |
| 167 | default_value: "" |
| 168 | required: false |
| 169 | group: Virtual Node |
| 170 | examples: |
| 171 | folding: |
| 172 | title: Config |
| 173 | enabled: true |
| 174 | list: |
| 175 | - name: Basic |
| 176 | description: A basic example configuration. |
| 177 | folding: |
| 178 | enabled: false |
| 179 | config: | |
| 180 | jobs: |
| 181 | - name: local |
| 182 | url: http://127.0.0.1:8989 |
| 183 | username: admin |
| 184 | password: mariadb |
| 185 | - name: HTTPS with self-signed certificate |
| 186 | description: MaxScale with enabled HTTPS and self-signed certificate. |
| 187 | config: | |
| 188 | jobs: |
| 189 | - name: local |
| 190 | url: http://127.0.0.1:8989 |
| 191 | username: admin |
| 192 | password: mariadb |
| 193 | tls_skip_verify: yes |
| 194 | - name: Multi-instance |
| 195 | description: | |
| 196 | > **Note**: When you define multiple jobs, their names must be unique. |
| 197 | |
| 198 | Collecting metrics from local and remote instances. |
| 199 | config: | |
| 200 | jobs: |
| 201 | - name: local |
| 202 | url: http://127.0.0.1:8989 |
| 203 | username: admin |
| 204 | password: mariadb |
| 205 | |
| 206 | - name: remote |
| 207 | url: http://192.0.2.1:8989 |
| 208 | username: admin |
| 209 | password: mariadb |
| 210 | troubleshooting: |
| 211 | problems: |
| 212 | list: [] |
| 213 | alerts: [] |
| 214 | metrics: |
| 215 | folding: |
| 216 | title: Metrics |
| 217 | enabled: false |
| 218 | description: "" |
| 219 | availability: [] |
| 220 | scopes: |
| 221 | - name: global |
| 222 | description: These metrics refer to the monitored MaxScale instance. |
| 223 | labels: [] |
| 224 | metrics: |
| 225 | - name: maxscale.poll_events |
| 226 | description: Poll Events |
| 227 | unit: events/s |
| 228 | chart_type: line |
| 229 | dimensions: |
| 230 | - name: reads |
| 231 | - name: writes |
| 232 | - name: accepts |
| 233 | - name: errors |
| 234 | - name: hangups |
| 235 | - name: maxscale.current_sessions |
| 236 | description: Current Sessions |
| 237 | unit: sessions |
| 238 | chart_type: line |
| 239 | dimensions: |
| 240 | - name: sessions |
| 241 | - name: maxscale.current_zombie_connections |
| 242 | description: Current Zombie Connections |
| 243 | unit: connections |
| 244 | chart_type: line |
| 245 | dimensions: |
| 246 | - name: zombie |
| 247 | - name: maxscale.threads_by_state |
| 248 | description: Threads Count by State |
| 249 | unit: threads |
| 250 | chart_type: stacked |
| 251 | dimensions: |
| 252 | - name: active |
| 253 | - name: draining |
| 254 | - name: dormant |
| 255 | - name: maxscale.current_fds |
| 256 | description: Current Managed File Descriptors |
| 257 | unit: fds |
| 258 | chart_type: line |
| 259 | dimensions: |
| 260 | - name: managed |
| 261 | - name: maxscale.qc_cache_efficiency |
| 262 | description: QC Cache Efficiency |
| 263 | unit: requests/s |
| 264 | chart_type: stacked |
| 265 | dimensions: |
| 266 | - name: hits |
| 267 | - name: misses |
| 268 | - name: maxscale.qc_cache_operations |
| 269 | description: QC Cache Operations |
| 270 | unit: operations/s |
| 271 | chart_type: stacked |
| 272 | dimensions: |
| 273 | - name: inserts |
| 274 | - name: evictions |
| 275 | - name: maxscale.uptime |
| 276 | description: Uptime |
| 277 | unit: seconds |
| 278 | chart_type: line |
| 279 | dimensions: |
| 280 | - name: uptime |
| 281 | - name: server |
| 282 | description: These metrics refer to the MariaDB server. |
| 283 | labels: |
| 284 | - name: server |
| 285 | description: Server ID. |
| 286 | - name: address |
| 287 | description: Server address. |
| 288 | metrics: |
| 289 | - name: maxscale.server_state |
| 290 | description: Server State |
| 291 | unit: state |
| 292 | chart_type: line |
| 293 | dimensions: |
| 294 | - name: master |
| 295 | - name: slave |
| 296 | - name: running |
| 297 | - name: down |
| 298 | - name: maintenance |
| 299 | - name: draining |
| 300 | - name: drained |
| 301 | - name: relay_master |
| 302 | - name: binlog_relay |
| 303 | - name: synced |
| 304 | - name: maxscale.server_current_connections |
| 305 | description: Server Current connections |
| 306 | unit: connections |
| 307 | chart_type: line |
| 308 | dimensions: |
| 309 | - name: connections |