This is a tool for backing up SignalFx dashboards and/or detectors. It is suitable for use with things like cron.
You can choose one of --dashboards or --detectors and point the output do a specific --destination directory.
Note: Be sure and point each invocation to a different directory, as this tool merely uses the asset's ID and has no awareness of types.
usage: backup.py [-h] [--api_url API_URL] [--api_version API_VERSION] --config
CONFIG [--dashboards] --destination DESTINATION [--detectors]
[--verbose]
optional arguments:
-h, --help show this help message and exit
--api_url API_URL Full URL to use for the API (default:
https://api.signalfx.com)
--api_version API_VERSION
API version (default: 2)
--config CONFIG Path to configuration file
--dashboards Back up dashboards
--destination DESTINATION
Directory to which backup files will be written
--detectors Back up detectors
--verbose Be verbose about what we doing
This tool needs a SignalFx Access Token to function. You must provide a --config pointing to a JSON config file containing:
{
"token": "XXX"
}
- Add pruning of definitions older than a timestamp
- Add restoration of entity @ timestamp
- Docs
- Strategies and such for v1 versus v2
Dashboards must be in Dashboard Groups, and Charts in Dashboards. To reflect that a directory structure like this is used (assumes a target directory of backups):
backups
├── DzYcoMDAcAE
│ ├── 1550165452744.json
│ ├── DzYc06kAgAA
│ │ ├── 1550165475470.json
│ │ ├── DzYc1WxAcAA
│ │ │ └── 1550165476002.json
│ │ ├── DzYc2L4AYAA
│ │ │ └── 1550165475710.json
│ │ ├── DzYc40KAYAA
│ │ │ └── 1550165475818.json
│ │ ├── DzYc44UAgAA
│ │ │ └── 1550165476352.json
│ │ ├── DzYc52eAcAA
│ │ │ └── 1550165476165.json
│ │ └── DzYc80NAYAA
│ │ └── 1550165476441.json
Each JSON file is a timestamp, containing the definition of the entity at that time. The directory structure is:
"dashboard group id" -> "dashboard id" -> "chart id"
As changes happen new JSON files will appear, containing the definition at that point in time.
Lacking any sort of grouping hierarchy, as a detector id directory that contains the definitions as timestamps.
backups
├── Dzx2UBeAYAA
│ └── 1550591993075.json
└── DzyF3vbAcCw
└── 1550595879283.json
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent