Creating a System Backup through the UI

This article details how to create a System Backup of your Metric Insights instance.

For details on mi-app-backup script, see Backup Your Metric Insights Instance.

1. Create a New Backup

Access Admin > System > System Backups

The list page containing all available System Backups opens.

  1. Below the grid, click [+ New Backup Method]

2. Configure Backup Settings

This example illustrates creation of a locally stored Backup. Backups can also be stored:

See the corresponding sections for examples.

  1. Enter a Name for the Backup
  2. Destination: Select the type of location where the Backup will be stored
  3. URI: Enter the path under which the Backup will be stored
    • By default, backups are stored locally in the /opt/mi/backup directory inside the web container
  4. [Save]
2.1. Remote
  1. Enter a Name for the Backup
  2. Destination: Remote
  3. Enter URI in the following format: ssh://<remote server address>/<location>
  4. [Save]
2.2. Amazon S3
  1. Enter a Name for the Backup
  2. Destination: Amazon S3
  3. Enter URI in the following format: s3://<bucket name>/<directory name>
  4. Enter AWS Access Key ID
  5. Enter AWS Secret Access Key
  6. Optionally, change the S3 Chunk Size of stored data and number of Connections for uploading
  7. [Save]
2.3. FTP
  1. Enter a Name for the Backup
  2. Destination: FTP
  3. Enter URI in the following format: ftp://<FTP server address>/<location on the FTP server>
  4. Enter the FTP credentials
  5. [Save]

3. Add a Scheduled Backup

  1. [+ New Scheduled Backup]
  2. Select Backup Type:
    • Full: the default Backup type. Both files and database data are included in the Backup
    • Database: Only database data is included in the Backup
    • Files: Only files are included in the Backup
  3. Exclude Dataset Tables from Backup: exclude Dataset data from the Backup. This option is applicable for Full and Database Backup types
  4. Set Frequency of Backup
  5. Set Backup Retention by:
    • Maximum number of Backups in the system
    • Time of keeping Backups
  6. Click [Save], the created schedule appears under the Scheduled Backups grid
  7. You can click [Backup Now] to create a new Backup immediately, out of the set schedule

4. Scheduled Backup Types

Note: As a best practice, the recommendation from MI is to choose the Full backup type. The other backup options "Database" and "Files" exist for a more specific use-case where a full backup may not be needed (e.g. to save disk space for some specific reason where only a partial backup is needed). Such cases are rare - in general there should be no need to avoid making a full backup


Full (recommended): an all-inclusive backup that contains sqldump files for all tables in both the application database (Dashboard db) as well as all tables in dataset storage (Dashboard dataset) & all critical application data and configuration files from the MI filesystem. A full backup can be taken and restored in a completely new environment whereas the same is not true of the other two partial backup options listed below, which is why it is the preferred method


Database: produces a backup.tar.gz file that contains strictly mysqldumps of the application database (Dashboard db) + the Dataset storage database (Dashboard dataset). Using the "Database" backup option would not include copies of critical application configuration files - it's simply a backup of the MI databases and does not include any files from the MI filesystem. This is a partial backup method that has a limited purpose with few applicable use-cases


Files: the contents included in the "Files" backup option are a mix of different application data and configuration files such as report and metric data points, charts, visualizations, etc. Additionally, the files included in the backup would also consist of any documents or manually uploaded element images in MI, the UI themes, colors, and fonts, thumbnail images for the tiles, and some configuration files such as const.php which is a copy of all System Variables and their values at the time the backup was taken, and also a stamp.json file that gets included in the tarball when a "Files" backup is taken that is basically a map of the database hostname, port, and credentials that were used to take the backup. There are also additional files critical to the MI filesystem that are included in both the "Full" and "Files" backup options