Project

datadog_backup

0.03
There's a lot of open issues
datadog_backupscribd/datadog_backupHomepageDocumentationSource CodeBug TrackerWiki
A utility to backup and restore Datadog accounts
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
317,628
Stars
30
Forks
11
Watchers
7
 Releases
Current version
4.0.1
Total releases
35
First release
2020-08-11
Latest release
2024-04-30
 Issues
Open Issues
7
Closed Issues
19
Total Issues
26
Issue Closure Rate
73%
 Pull Requests
Open Pull Requests
2
Closed Pull Requests
34
Merged Pull Requests
103
Pull Request Acceptance Rate
74%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2023-01-28
Reverse Dependencies
0

 Dependencies

Development

bundler
>= 0
pry
>= 0
guard-rspec
>= 0
rspec
>= 0
rubocop
>= 0
rubocop-rspec
>= 0
pry-byebug
>= 0

Runtime

amazing_print
>= 0
deepsort
>= 0
concurrent-ruby
>= 0
diffy
>= 0
faraday
>= 0
faraday-retry
>= 0
 Project Readme

Datadog Backup

Rspec and Release Gem Version

Use datadog_backup to backup your datadog account. Currently supports

  • dashboards
  • monitors

Additional features may be built out over time.

v3 Migration

Breaking Changes

v3 is a backwards incompatible change.

  • DATADOG_API_KEY and DATADOG_APP_KEY are no longer the environment variables used to authenticate to Datadog. Instead, set the environment variables DD_API_KEY and DD_APP_KEY.
  • ruby 2.7 is no longer supported. Please upgrade to ruby 3.0 or higher.
  • The options --ssh and --ssshh are no longer supported. Instead, please use --quiet to supress logging. --debug remains supported.
  • The environment variable DATADOG_HOST is no longer supported. Instead, please use DD_SITE_URL.

Misc

Installation

gem install datadog_backup

Usage

demo

DD_API_KEY=example123 DD_APP_KEY=example123 datadog_backup <backup|diffs|restore> [--backup-dir /path/to/backups] [--debug] [--monitors-only] [--dashboards-only] [--diff-format color|html|html_simple] [--no-color] [--json]

gem install datadog_backup
export DD_API_KEY=abc123
export DD_APP_KEY=abc123

# Perform backup to `./backup/` using YAML encoding
datadog_backup backup

# Make some changes

# Just review the changes since last backup
datadog_backup diffs

# Review the changes since last backup and apply local changes to datadog

datadog_backup restore

Parameters

Supply the following parameters in order to customize datadog_backup:

parameter description default
--debug log debug and above info
--quiet only show errors and above info
--backup-dir PATH path to the directory to backup to or restore from ./backup/
--monitors-only only backup monitors backup monitors and dashboards
--dashboards-only only backup dashboards backup monitors and dashboards
--json format backups as JSON instead of YAML. Does not impact diffs nor restore, but do not mix formats in the same backup-dir. YAML
--no-color removes colored output from diff format
--diff-format FORMAT one of color, html_simple, html color
--force-restore Force restore to Datadog. Do not ask to validate. Non-interactive.
--disable-array-sort Do not sort array elements, to preserver order of dashboard widgets.
--h, --help help

Environment variables

The following environment variables can be set in order to further customize datadog_backup:

environment variable description default
DD_SITE_URL Describe the API endpoint to connect to (https://api.datadoghq.eu for example) https://api.datadoghq.com
DD_API_KEY The API key for the Datadog account none
DD_API_KEY The Application key for the Datadog account none

Usage in a Github repo

See example/ for an example implementation as a repo that backs up your Datadog dashboards hourly.

Development

Releases are cut using semantic-release.

Please write commit messages following Angular commit guidelines