Add a ClickHouse database instance

Monitor your ClickHouse database instance with SolarWinds Observability SaaS on self-monitored host. Capture a robust assortment of ClickHouse query metrics that give you insight into database performance and what consumes your database’s resources.

Get started

To monitor your ClickHouse database instance with SolarWinds Observability SaaS, complete the following:

1. In SolarWinds Observability SaaS, click Add Data at the top.

2. On the Add Data dialog Intro, click Monitor my database performance.

3. Click ClickHouse.

4. Choose an existing SolarWinds Observability Agent on a monitored host. Click Next to continue.

   For more information about installing the SolarWinds Observability Agent on your host, see Add a self-managed host or Run the SolarWinds Observability Agent as a Docker image or Kubernetes deployment.

   If the Agent you want to use is not displayed in the wizard, make sure it has host monitoring enabled. See Enable host monitoring on an Agent.

5. Complete the Credentials panel and click Next:

   1. Enter address in the following format: host:port, and edit the display name if desired.

   2. Enter the user name and password.

   3. (Optional) To enable SSL, click the Enable SSL toggle and select the SSL mode:

      • Require: SSL is enabled, but no certificate checks are performed.

      • Verify CA: SSL is enabled. The client verifies that the server is trustworthy by checking the certificate chain up to a trusted certificate authority (CA).

      • Verify Full: The client checks the certificate chain up to a trusted CA, and also verifis that the server host name matches the name stored in the server certificate.

      When SSL is enabled, you can also specify the client certificate path and the client key path.

   4. Optional: Click Add Tags to add any tags to your database entity. Enter a tag key and value, and then click Add Tag. Repeat this step as necessary for any tags you want to add.

   5. Click Next to continue.

6. Copy and execute the scripts on your ClickHouse instance.

   1. Create a new Database User: Copy and execute the script to create a new database user for the Agent to use. If you already have a user, you can skip this step.

   2. Grant Privileges on system tables: Copy and execute the script to grant privileges on system tables to your user. Note that the Agent requires at least the listed privileges.

   3. Grant the Explain permission: Copy and execute the script to gran the Explain permission to your user.

   4. The Advanced Configuration field is optional. The field provides a metric agent configuration path for you to indicate a different config file that can add to or override the dbo-global.conf file.

      This field should be used if you need to monitor multiple database instances from the same host Agent and you want to provide different configuration file paths to each DBO plugin on that same host Agent. Enter any parameters for metric collection in the Metric Agent field.

      See Database configuration files for information about configuration options.

      The /etc/solarwinds/dbo-global.conf configuration file is used for all database hosts. If you don't need to override configuration options in the dbo-global.conf file for this database instance, you do not need to provide a configuration file path for the Metric Agent field.

      The config files are JSON. When editing or creating a new configuration file, be sure to include the opening and closing brackets" { " and " }" . All options must be comma-separated.

      For example, a file might look like the following:

      {

      "disable-sampling":"false",

      "enable-explains":"false"

      }

   5. Click Observe Database to continue.

7. The database plugin status and the other information you entered in the wizard is displayed on the Review tab.

   1. If your plugin deployment was unsuccessful, check the Agent status you entered in the wizard, and verify your database credentials. Click Test Connection to refresh your plugin connection.

   2. If your plugin deployment was successful, your database instance is being monitored with SolarWinds Observability.

   3. Click Close to exit the wizard.

To view data collected for the newly configured entity in the Entity Explorer, click the name of the Database in the confirmation dialog in the lower-left corner. It may take a few seconds for data to appear for the newly created entity. See Entity Explorer for details.

See Entities in SolarWinds Observability SaaS for an overview of Database entities and how they work in SolarWinds Observability SaaS.