Agent Check: ProxySQL

Overview

This check monitors ProxySQL through the Datadog Agent.

Setup

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the Autodiscovery Integration Templates for guidance on applying these instructions.

Installation

The ProxySQL integration is included in the Datadog Agent package, so you don't need to install anything else on your servers.

Configuration

Enabling SSL

To connect to ProxySQL using full SSL/TLS validation, enable the tls_verify option in conf.yaml. Include certificates and passwords needed to connect with SSL/TLS.

    tls_verify: true
    tls_ca_cert: ca_cert.pem

Host

To configure this check for an Agent running on a host:

1. Edit the proxysql.d/conf.yaml file, in the conf.d/ folder at the root of your Agent's configuration directory to start collecting your ProxySQL performance data. See the sample proxysql.d/conf.yaml for all available configuration options.

2. Restart the Agent.

Log collection

1. Collecting logs is disabled by default in the Datadog Agent, enable it in your datadog.yaml file:

   logs_enabled: true

2. Add the log files you are interested in to your proxysql.d/conf.yaml file to start collecting your ProxySQL logs:

     logs:
         # Default logging file
       - type: file
         path: /var/log/proxysql.log
         source: proxysql
         service: "<SERVICE_NAME>"
         # Logged queries, file needs to be in JSON
         # https://github.com/sysown/proxysql/wiki/Query-Logging
       - type: file
         path: "<QUERY_LOGGING_FILE_PATH>"
         source: proxysql
         service: "<SERVICE_NAME>"
         # Audit log
         # https://github.com/sysown/proxysql/wiki/Audit-log
       - type: file
         path: "<AUDIT_LOG_FILE_PATH>"
         source: proxysql
         service: "<SERVICE_NAME>"

   Change the path and service parameter values and configure them for your environment. See the sample proxysql.d/conf.yaml for all available configuration options.

3. Restart the Agent.

Containerized

For containerized environments, see the Autodiscovery Integration Templates for guidance on applying the parameters below.

Metric collection

Parameter	Value
<INTEGRATION_NAME>	proxysql
<INIT_CONFIG>	blank or {}
<INSTANCE_CONFIG>	{"host": "%%host%%", "port": "%%port%%", "username": "<USER>", "password": "<PASSWORD>"}

Log collection

Collecting logs is disabled by default in the Datadog Agent. To enable it, see Kubernetes Log Collection.

Parameter	Value
<LOG_CONFIG>	{"source": "proxysql", "service": "<SERVICE_NAME>"}

Validation

Run the Agent's status subcommand and look for proxysql under the Checks section.

Data Collected

Metrics

See metadata.csv for a list of metrics provided by this check.

Events

The ProxySQL check does not include any events.

Service Checks

See service_checks.json for a list of service checks provided by this integration.

Troubleshooting

Need help? Contact Datadog support.