Backup location and structure

NXLog Platform backs up the logs database, configuration settings, and all other content and stores them on the local storage.

Backup location

By default, NXLog Platform creates backups in /srv/nxp/backup/:

# ls /srv/nxp/backup/
backup_20240815_144142.tar.gz
backup_20240815_164146.tar.gz

You can change the target location for your backups by editing the /etc/nxp.conf file. The line you need to change is the following:

export NXP_BACKUP_LOCATION=/srv/nxp/backup

Backup file naming

NXLog Platform creates a compressed file with a time stamp in its name for each backup. The timestamp can be critical to restore the correct backup.

For example, the timestamp presented in one of the above filenames 20240815_164146 can be broken down as follows:

2024: The year (2024).
08: The month (August).
15: The day (15th).
16: The hour (16, in 24-hour format).
41: The minute (41).
46: The second (46).

So, this timestamp represents August 15, 2024, at 16:41:46.

Backup file structure

NXLog Platform creates each backup as a file with a .tar.gz extension, meaning that it is a compressed files holding a single archive with a .tar extension inside. The archive includes multiple files and directories holding your backup data.

NXLog Platform backup file structure

backup_<TIMESTAMP>.tar.gz/
└── backup_<TIMESTAMP>.tar/
    └── backup_<TIMESTAMP>/
        ├── grafana_data/
        ├── minder_data/
        ├── nginx_certs/
        ├── pgdata/
        ├── prometheus_data/
        ├── raijin_agent_data/
        ├── raijin_audit_data/
        ├── vault_certs/
        ├── vault_data/
        ├── vault_secret/
        ├── api_key.txt
        ├── domain.txt
        └── pg_pass.txt

Do not modify the content of the extracted backup file, unless you are sure about the changes you make. Modifying the content of the folders and files can have irreversible consequences and might incur data loss.

Table 1. NXLog Platform backup content
Sub-directory or file	Description
grafana_data	Grafana data.
minder_data	Agent Manager data.
nginx_certs	nginx certificates.
pgdata	PostgreSQL database data.
prometheus_data	Prometheus data.
raijin_agent_data	Raijin database-related data.
raijin_audit_data	Raijin database-related data.
vault_certs	Vault certificates.
vault_data	Vault database data.
vault_secret	Vault configuration data.
api_key.txt	Your NXLog Platform API key in plain text.
domain.txt	Your domain name in plain text.
pg_pass.txt	Your PostgreSQL password in plain text.

Backup location and structure

Backup location

Backup file naming

Backup file structure

See also