Integration Backup and Restore Overview

Overview

Take your Datadog experience to the next level with the Integration Backup and Restore Tool (IBRT). This powerful tool helps you streamline your workflow by allowing you to easily create backups of your Datadog configuration, ensuring that you can quickly restore your setup after Agent upgrades or migrations.

Features

• Creates a complete backup of your Datadog configuration, including:
  • Integrations
  • Dependencies
  • Configuration files (for example, integrations’ datadog.yaml and conf.yaml files)
• Supports multiple backup locations, allowing you to store your backups in the locations that best suit your needs
• Flexible backup scheduling:
  • Run on-demand backups as needed
  • Schedule periodic backups to run automatically, based on your specific requirements
• Provides options during restoration:
  1. Agent migration or reinstallation: Installs all integrations and copies YAML files, including integration conf.yaml and datadog.yaml, for a seamless migration experience.
  2. Agent upgrade: Installs integrations as YAML configurations, and preserves dependencies during the upgrade process.

Supported backup locations

• Local machine
• Remote machine
• Cloud services:
  • AWS S3 buckets
  • Azure Blob storage
  • Google Cloud Storage

Ease of use

Unlike traditional backup methods that require manual installation and configuration, IBRT provides a simple and convenient way to create backups. You can easily create a backup of your Datadog configuration by running an on-demand command at the Agent level, or by scheduling periodic backups to run automatically. Additionally, restoring your backup is just as easy, requiring only a single script to get your configuration up and running again.

Restore the backup

Follow these steps after the backup is created:

1. Download or copy the backup to the latest agent location.
2. Unzip the zip file.
3. Restore the Datadog configuration by running the script cds_ibrt_restore_script.py, which is provided in the backup.

Note: Do not manually alter the content of the unzipped backup directory.

Follow the steps below to restore the configuration, based on your Agent type:

Linux

• To run the script, give the dd-agent user ownership to the unzipped directory in which the cds_ibrt_restore_script.py is located

• Run the following command, replacing <directory> with the directory that contains the cds_ibrt_restore_script.py script:

  sudo chown dd-agent:dd-agent <directory> -R
  

• After this, run the following command to execute the script:

  sudo -Hu dd-agent /opt/datadog-agent/embedded/bin/python cds_ibrt_restore_script.py
  

Note for RHEL and CentOS users: If you are running this script on RHEL or CentOS, ensure that all parent directories are accessible by the dd-agent user. If the script is stored in your home directory (e.g., /home/devuser/), make sure that directory has permission 755:

sudo chmod 755 /home/devuser

If you prefer not to change permissions, choose a storage location where the dd-agent user already has write access, such as /opt/datadog-agent.

Windows

Open the command prompt as administrator and run the following command:

"%programfiles%\Datadog\Datadog Agent\embedded3\python.exe" cds_ibrt_restore_script.py

macOS

sudo /opt/datadog-agent/embedded/bin/python cds_ibrt_restore_script.py

Docker

To restore a backup on your Docker container, use the following command:

/opt/datadog-agent/embedded/bin/python cds_ibrt_restore_script.py

After running the script, choose the option that best fits your scenario:

• Select 1 for Agent migration/reinstallation: Installs all integrations and copies YAML files, including integration conf.yaml and datadog.yaml, for a seamless migration experience.
• Select 2 for Agent Upgrade: Installs integrations as YAML configurations, preserving dependencies during the upgrade process.

Once you select an option, your Datadog environment will be configured accordingly.

What is your Datadog agent installation scenario?
1. Fresh agent installation/reinstallation or agent migration
2. Just upgraded existing datadog-agent
Enter your choice (1/2):

Troubleshooting

Here’s how to fix some common issues you might encounter.

• If you encounter any issues storing backup files on a remote VM using proxy, ensure that you have allowed the SSH port in your proxy server. For example, if you are using a Squid proxy server, you need to allow the SSH port in the squid.conf file and restart the proxy server.

  acl SSL_ports port 22
  http_access allow SSL_ports
  

• If you encounter any permission issues, ensure that you have followed all the steps mentioned in the Notes to avoid permission issues section.
• Here are some things to keep in mind while restoring your backup:
  • Core integrations will be skipped with the below log message during the restore process, because these integrations are shipped with the Datadog Agent.
    • INFO - <integration_name> is core integration, hence skipping...
  • Custom-created integrations, which are not on the Datadog Marketplace, will be skipped with the below log message during the restore process:
    • INFO - <integration_name> is custom integration, hence skipping...

Support

For support or feature requests, contact Crest Data through the following channels:

• Support Email: datadog.integrations@crestdata.ai
• Sales Email: datadog-sales@crestdata.ai
• Website: crestdata.ai
• FAQ: Crest Data Datadog Marketplace Integrations FAQ

This application is made available through the Datadog Marketplace and is supported by a Datadog Technology Partner. To use it, purchase this application in the Marketplace.