DDMON

Description

ddmon is a simple means to manage Datadog monitors via templates + terraform. It is opinionated on the structure of a monitor. It allows for terse YAML monitor definitions.

Note: This project is under active development and is not intended to be used in production.

Setup

# Install the latest version
go get github.com/DataDog/ddmonitor

# Install a specific version
GO111MODULE=on go get github.com/DataDog/[email protected]

Usage

Given many common monitor patterns, ddmon aids in generating terraform
files for Datadog by providing a rich templating language built off sprig and terse
YAML monitor definitions to generate terraform Datadog monitors.

Usage:
  ddmon [command]

Available Commands:
  generate    Generates all templates into terraform files
  help        Help about any command
  init        Initialze the directory for ddmon usage

Flags:
      --config string   config file (default is $HOME/.ddmon.yaml)
  -h, --help            help for ddmon
      --version         version for ddmon

Use "ddmon [command] --help" for more information about a command.

Contribution Guides

TODO

Expected Project Structure

/monitors
  output/
    *.tf
  resources/
    $GROUP/
      $MONITOR-1.tpl
      $MONITOR-2.tpl
    templates/
      base.tpl
  data/
    common.yaml
    $NAMESPACE
      common.yaml
      $GROUP/
        common.yaml
        $MONITOR-1.yaml
        $MONITOR-2.yaml
        ...

Guide

All monitors are defined in YAML files.

Data Inheritance

Each $MONITOR-N.yaml is merged into its groups's common.yaml, this is merged into the groups common.yaml, and finally the data's common.yaml.

Thus $MONITOR-N.yaml has precedence, followed by $GROUP/common.yaml, followed by $NAMESPACE/common.yaml, followed by data/common.yaml.

YAML Specificiation

The $MONITOR-N.yaml file has the following specification:

All fields populate terraform fields in some form, in so, they must meet the terraform datadog specification

key	required?	description	default
`identifier`	required	a unique identifier for the tag, will be prefixed with the service name. Alphanumerics + `-` only.	N/A
`name`	required	the name of the monitor	N/A
`type`	required	see terraform docs	N/A
`description`	required	a short description of the alert	N/A
`recovery_plan`	required	a run book on how to resolve the alert	N/A
`wiki_link`	required	a link to the services wiki. should be in the services common.yaml	inherited
`dashboard_link`	required	a link to the services dashboard. should be in the services common.yaml	inherited
`slack`	optional	the slack room to post to. inherited from data/common.yaml	"@slack-milkyway-ops"
`tags`	optional	the tags for the monitor	["team:team-aaa", "terraform:true", "datacenter:$DATACENTER", "service:host-conumser"]
`datacenter`	inherited	the datacenter for the monitor, inherited from the common.yaml	inherited
`default_message`	inherited	a default message for all monitors	see data/common.yaml
`should_page`	optional	if set to true, the monitor will page	false

The following fields are directly equivelent to their terraform specification

key	required?	description	default
`escalation_message`	optional	TODO	""
`thresholds.critical`	optional	TODO	Nil
`thresholds.critical_recovery`	optional	TODO	Nil
`thresholds.warning`	optional	TODO	Nil
`thresholds.warning_recovery`	optional	TODO	Nil
`notify_no_data`	optional	TODO	false
`new_host_delay`	optional	TODO	300
`evaluation_delay`	optional	TODO	Nil
`no_data_timeframe`	optional	TODO	2x timeframe for metric alerts, 2 minutes for service checks.
`renotify_interval`	optional	TODO	nil
`notify_audit`	optional	TODO	false
`require_full_window`	optional	TODO	false
`locked`	optional	TODO	false

Useful Links

Datadog Terraform Docs

Package cmd configures and executes the given CLI command Copyright © 2019 Dan Piet <[email protected]> Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.

lib

No description provided by the author

# README