sciurus/datadog-monitor-tools

Scipts for managing datadog monitors

Introduction

There are lots of tools (e.g. Terraform, DogPush, BarkDog) that you can use to manage your DataDog monitors as code. You should probably use one of them. But what if you aren't, yet you still need to refactor a bunch of monitors? The scripts in this repo will let you export some or all of your monitors to a YAML file, edit them, then sync your edits back to DataDog.

Installation

This requires a working Python 3 environment.

1. Clone this repo
2. pip install datadog pyyaml

Usage

Prerequisites

1. Set up an API and application key at https://app.datadoghq.com/account/settings#api
2. export DD_API_KEY=your_api_key
3. export DD_APP_KEY=your_app_key

Filtering

get_monitors.py allows you to filter the monitors to download by any combination of name, tag, and monitor tag as described at https://docs.datadoghq.com/api/?lang=python#get-all-monitor-details. For example, get_monitors.py --tags 'env:foo,app:bar'

Modifying Monitors

1. ./get_monitors.py > foo.yml
2. Make your changes to foo.yml
3. ./update_monitors.py foo.yml

Now you should see your changes to the existing monitors in DataDog.

Creating Monitors

Instead of creating monitors by hand, it is easier to start by copying an existing monitor and modifying it.

1. ./get_monitors.py --purpose create > foo.yml
2. Make your changes to foo.yml
3. ./create_monitors.py foo.yml

Now you should see new monitors in DataDog.

Backing up Monitors

If you're making backups, you probably want to protect against two scenarios.

1. The accidental modification of monitors
2. The accidental deletion of monitors

You need two slightly different sets of data for each purpose, which you can produce via the commands below.

get_monitors.py > undo_modification.yml
get_monitors.py --purpose create > undo_deletion.yml

undo_modificaton.yml has the monitor id but not the monitor type, and undo_deletion.yml has the monitor type but not the monitor id.