Back Up & Restore the Analytics Database

Overview

This guide explains how to back up and restore the F5 NGINX Controller analytics database. Backing up and restoring the analytics data lets you preserve the history of graphs. Backing up this information is optional.

Back Up the Analytics Database

Make a backup copy of the metrics database following the steps for your volume type:

  • Local: Make a back up copy of the metrics data that’s located in /opt/nginx-controller/clickhouse_data by default, or on the volume that you specified when installing NGINX Controller.

  • NFS: Make a backup copy of all of the data in the NFS path or make a copy of the ClickHouse binary data. Refer to the official ClickHouse documentation on Data Backup.

  • EBS: For AWS, refer to the Amazon EBS snapshots documentation to create a volume snapshot.

Restore the Analytics Database

Restore the backup copy of the metrics database following the steps for your volume type:

  • Local: Copy the data you backed up to /opt/nginx-controller/clickhouse_data.

  • NFS: Copy the ClickHouse binary data in the NFS path. Refer to the official ClickHouse documentation on Data Backup.

  • EBS: For AWS, refer to the Amazon EBS snapshots documentation to restore a volume snapshot.


This documentation applies to the following versions of NGINX Controller: 3.0, 3.1, 3.2, 3.3, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 3.10, 3.12, 3.13, 3.14, 3.15, 3.16.1, 3.17, 3.18, 3.18.1, 3.18.2 and 3.18.3.


This documentation applies to the following versions of NGINX Controller API Management module: 3.18, 3.18.1, 3.19, 3.19.1, 3.19.2, 3.19.3, 3.19.4 and 3.19.5.


This documentation applies to the following versions of NGINX Controller App Delivery module: 3.20, 3.20.1, 3.21, 3.22, 3.22.1, 3.22.2, 3.22.3, 3.22.4, 3.22.5, 3.22.6, 3.22.7 and 3.22.8.


Last modified March 19, 2025