MaxScale
MaxScale
Plugin: go.d.plugin Module: maxscale
Overview
This collector monitors the activity and performance of MaxScale servers.
It sends HTTP requests to the MaxScale REST API.
This collector is supported on all platforms.
This collector supports collecting metrics from multiple instances of this integration, including remote instances.
Default Behavior
Auto-Detection
The collector can automatically detect MaxScale instances running on:
- localhost that are listening on port 8989
- within Docker containers
Note that the MaxScale REST API requires a username and password. While Netdata can automatically detect MaxScale instances and create data collection jobs, these jobs will fail unless you provide the necessary credentials.
Limits
The default configuration for this integration does not impose any limits on data collection.
Performance Impact
The default configuration for this integration is not expected to impose a significant performance impact on the system.
Setup
Prerequisites
No action required.
Configuration
File
The configuration file name for this integration is go.d/maxscale.conf.
You can edit the configuration file using the edit-config script from the
Netdata config directory.
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/maxscale.conf
Options
The following options can be defined globally: update_every, autodetection_retry.
| Name | Description | Default | Required |
|---|---|---|---|
| update_every | Data collection frequency. | 1 | no |
| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
| url | The URL of the MaxScale HTTP API endpoint. | http://127.0.0.1:8989 | yes |
| timeout | HTTP request timeout. | 1 | no |
| username | Username for basic HTTP authentication. | admin | no |
| password | Password for basic HTTP authentication. | mariadb | no |
| proxy_url | Proxy URL. | no | |
| proxy_username | Username for proxy basic HTTP authentication. | no | |
| proxy_password | Password for proxy basic HTTP authentication. | no | |
| method | HTTP request method. | GET | no |
| body | HTTP request body. | no | |
| headers | HTTP request headers. | no | |
| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |
| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |
| tls_ca | Certification authority that the client uses when verifying the server’s certificates. | no | |
| tls_cert | Client TLS certificate. | no | |
| tls_key | Client TLS key. | no |
Examples
Basic
A basic example configuration.
jobs:
- name: local
url: http://127.0.0.1:8989
username: admin
password: mariadb
HTTPS with self-signed certificate
MaxScale with enabled HTTPS and self-signed certificate.
jobs:
- name: local
url: http://127.0.0.1:8989
username: admin
password: mariadb
tls_skip_verify: yes
Multi-instance
Note: When you define multiple jobs, their names must be unique.
Collecting metrics from local and remote instances.
jobs:
- name: local
url: http://127.0.0.1:8989
username: admin
password: mariadb
- name: remote
url: http://192.0.2.1:8989
username: admin
password: mariadb
Metrics
Metrics grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
Per MaxScale instance
These metrics refer to the monitored MaxScale instance.
This scope has no labels.
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| maxscale.poll_events | reads, writes, accepts, errors, hangups | events/s |
| maxscale.current_sessions | sessions | sessions |
| maxscale.current_zombie_connections | zombie | connections |
| maxscale.threads_by_state | active, draining, dormant | threads |
| maxscale.current_fds | managed | fds |
| maxscale.qc_cache_efficiency | hits, misses | requests/s |
| maxscale.qc_cache_operations | inserts, evictions | operations/s |
| maxscale.uptime | uptime | seconds |
Per server
These metrics refer to the MariaDB server.
Labels:
| Label | Description |
|---|---|
| server | Server ID. |
| address | Server address. |
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| maxscale.server_state | master, slave, running, down, maintenance, draining, drained, relay_master, binlog_relay, synced | state |
| maxscale.server_current_connections | connections | connections |
Alerts
There are no alerts configured by default for this integration.
Troubleshooting
Debug Mode
Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
To troubleshoot issues with the maxscale collector, run the go.d.plugin with the debug option enabled. The output
should give you clues as to why the collector isn’t working.
-
Navigate to the
plugins.ddirectory, usually at/usr/libexec/netdata/plugins.d/. If that’s not the case on your system, opennetdata.confand look for thepluginssetting under[directories].cd /usr/libexec/netdata/plugins.d/ -
Switch to the
netdatauser.sudo -u netdata -s -
Run the
go.d.pluginto debug the collector:./go.d.plugin -d -m maxscale
Getting Logs
If you’re encountering problems with the maxscale collector, follow these steps to retrieve logs and identify potential issues:
- Run the command specific to your system (systemd, non-systemd, or Docker container).
- Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
System with systemd
Use the following command to view logs generated since the last Netdata service restart:
journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep maxscale
System without systemd
Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector’s name:
grep maxscale /var/log/netdata/collector.log
Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.
Docker Container
If your Netdata runs in a Docker container named “netdata” (replace if different), use this command:
docker logs netdata 2>&1 | grep maxscale