Skip to main content

A powerful tool for managing Datadog monitors as code

Project description

Datadog Monitor Deployer

versions

PyPI version Python Versions CI/CD Pipeline Python

health

Quality Gate Status Overall Coverage Security Rating Maintainability Rating Vulnerabilities Dependabot Status Code style: black

stats

Downloads License: MIT

A powerful and flexible tool for managing Datadog monitors as code. This project enables teams to define, deploy, and manage Datadog monitors using a declarative approach, supporting both YAML/JSON configurations and Python classes.

🌟 Key Features

  • 📝 Multiple Definition Formats:
    • YAML/JSON with schema validation
    • Python classes for programmatic creation
    • Hybrid approach supporting both methods
  • 🔍 Comprehensive Monitor Type Support:
    • Metric monitors
    • Event monitors
    • Log monitors
    • APM monitors
    • Network monitors
    • Process monitors
  • ⚡ Advanced Functionality:
    • Robust alerting configuration
    • Multiple notification channels (Email, Slack, PagerDuty)
    • Custom message templates
    • Tagging and organization
    • Full CRUD operations
  • 🛡️ Enterprise-Ready:
    • Idempotent operations
    • Comprehensive testing
    • Secure authentication handling
    • CI/CD pipeline integration

🚀 Quick Start

  1. Install the package:
pip install datadog-monitor-deployer
  1. Set up your Datadog credentials:
export DD_API_KEY="your-api-key"
export DD_APP_KEY="your-app-key"
  1. Create a monitor definition (example.yaml):
monitors:
  - name: "High CPU Usage Alert"
    type: "metric alert"
    query: "avg(last_5m):avg:system.cpu.user{*} > 80"
    message: "CPU usage is above 80%"
    tags:
      - "env:production"
      - "service:web"
    options:
      notify_no_data: true
      evaluation_delay: 900
  1. Deploy your monitor:
dd-monitor deploy example.yaml

📚 Documentation

For detailed documentation, visit our Documentation Site.

🛠️ Development Setup

  1. Clone the repository:
git clone https://github.com/fleXRPL/datadog-monitor-deployer.git
cd datadog-monitor-deployer
  1. Create and activate a virtual environment:
python -m venv venv
source venv/bin/activate  # On Windows: .\venv\Scripts\activate
  1. Install development dependencies:
pip install -r requirements-dev.txt
  1. Run tests:
pytest

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🔒 Security

Please review our Security Policy for reporting security vulnerabilities.

📊 Project Status

This project is actively maintained and used in production environments. For the latest updates, see our Changelog.


Built with ❤️ by the fleXRPL team

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

datadog_monitor_deployer-0.1.0.tar.gz (15.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

datadog_monitor_deployer-0.1.0-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file datadog_monitor_deployer-0.1.0.tar.gz.

File metadata

  • Download URL: datadog_monitor_deployer-0.1.0.tar.gz
  • Upload date:
  • Size: 15.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for datadog_monitor_deployer-0.1.0.tar.gz
Algorithm Hash digest
SHA256 94a45fb6775c9859c1c8cb5f16a8430a1b975e16398f6bbef6c5cd5194651694
MD5 c6093c37a91d91feee4dd2d94e4f77e1
BLAKE2b-256 4be3bf4b8f216cf02e06e8ab059d5f50c3205fa1825f7035ca1551fcbe0c91e4

See more details on using hashes here.

Provenance

The following attestation bundles were made for datadog_monitor_deployer-0.1.0.tar.gz:

Publisher: workflow.yml on fleXRPL/datadog-monitor-deployer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file datadog_monitor_deployer-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for datadog_monitor_deployer-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c48a642df0019759e088e2a9a59260bb1311d10619f3d55c25dfbbe4901bb792
MD5 3345e13941dad507e4b97d983a3256b7
BLAKE2b-256 0fdfe56469a8d8e74c59d0d30e0fb28582936ec61471aff97d5267b1624fbe14

See more details on using hashes here.

Provenance

The following attestation bundles were made for datadog_monitor_deployer-0.1.0-py3-none-any.whl:

Publisher: workflow.yml on fleXRPL/datadog-monitor-deployer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page