flask-datadog-monitor 0.0.6

Tool for auto generating DataDog Monitors from flask endpoints

Overview

Utility for auto generating DataDog terraform monitor specifications from flask endpoints.

1. Setup DataDog Terraform integration
2. Decorate flask endpoints you want to monitor
3. Run the DataDog Terraform generator
4. Apply Terraform changes

Decorator Examples

# Decorating with `datadog_monitors` will generate default monitors for each
# method on the route
@datadog_monitors()
@flask_app.route('/foo', methods=['GET', 'POST'])
def handle_foo():
    return ''

# Specifying a specific monitor will only generate that monitor for each
# method on the route
@datadog_monitors(
    monitors={
        MonitorType.APM_ERROR_RATE_THRESHOLD: {
            MonitorSpec.CRITICAL_THRESHOLD: 0.8,
            MonitorSpec.ALERT_PERIOD: '10m',
        },
    },
)
@flask_app.route('/foo', methods=['GET', 'POST'])
def handle_foo():
    return ''

Running

Running the test app service against a test DataDog account

Assumptions

• Test DataDog account is created; API and APP key are known

Running

1. Set DATADOG_API_KEY in env vars
2. Set DATADOG_APP_KEY in env vars
3. make sync-datadog: this applies monitoring configs to datadog acnt
4. make local-up: this builds app and dd-agent containers and runs them locally

Local setup

• Local docker compose environment runs test server in editable mode so you can modify python files while testing.

Running auto terraform generator

Running

1. source the venv that the application runs in
2. python monitor_generator.py ../test-app/app:app

Testing

1. Ensure venv is created. From root dir: python -m venv venv
2. Install testing dependencies: ./venv/bin/pip install .[testing] (setup.cfg has testing extras_require)
3. make test

Reference

• Flask App Object API: https://tedboy.github.io/flask/interface_api.application_object.html

TODO

• TF generation needs to be an executable
• Allow specification of just the monitors you want to default to
• "trigger when metric is <above/below> the threshold <in total | on average | etc.> ...
• test with different versions of Flask
• make terraform file generator into a cmd line executable