Installation

Installation Guide

This guide covers the installation process for the DataDog Monitor Deployer tool.

Prerequisites

• Python 3.9 or higher
• pip (Python package installer)
• DataDog account with API and Application keys
• Git (optional, for development)

Installation Methods

1. Using pip (Recommended)

pip install datadog-monitor-deployer

2. From Source

git clone https://github.com/fleXRPL/datadog-monitor-deployer.git
cd datadog-monitor-deployer
pip install -e .

3. Development Installation

git clone https://github.com/fleXRPL/datadog-monitor-deployer.git
cd datadog-monitor-deployer
pip install -r requirements-dev.txt

Configuration

1. Environment Variables

Set up your DataDog credentials using environment variables:

# Linux/macOS
export DD_API_KEY='your-api-key'
export DD_APP_KEY='your-app-key'

# Windows (PowerShell)
$env:DD_API_KEY='your-api-key'
$env:DD_APP_KEY='your-app-key'

2. Using .env File

Create a .env file in your project directory:

DD_API_KEY=your-api-key
DD_APP_KEY=your-app-key

Verify Installation

Verify the installation by running:

dd-monitor --version

Platform-Specific Instructions

Linux

Most Linux distributions come with Python pre-installed. If needed:

# Ubuntu/Debian
sudo apt-get update
sudo apt-get install python3 python3-pip

# CentOS/RHEL
sudo yum install python3 python3-pip

macOS

Using Homebrew:

brew install python3

Windows

1. Download Python from python.org
2. During installation:
   • Check "Add Python to PATH"
   • Check "pip package installer"

Docker Installation

docker pull flexrpl/datadog-monitor-deployer

Usage with Docker:

docker run -e DD_API_KEY='your-api-key' \
           -e DD_APP_KEY='your-app-key' \
           -v $(pwd):/app \
           flexrpl/datadog-monitor-deployer \
           deploy monitor.yaml

Common Installation Issues

SSL Certificate Errors

If you encounter SSL certificate errors:

pip install --trusted-host pypi.org --trusted-host files.pythonhosted.org datadog-monitor-deployer

Permission Errors

If you encounter permission errors:

# Linux/macOS
pip install --user datadog-monitor-deployer

# Windows (run as administrator)
pip install datadog-monitor-deployer

Dependency Conflicts

If you encounter dependency conflicts:

pip install --upgrade pip
pip install -r requirements.txt --no-cache-dir

Next Steps

• Read the Getting Started Guide
• Create your First Monitor
• Review Best Practices

Additional Resources

• Python Installation Guide
• pip Documentation
• Virtual Environments Guide
• DataDog API Keys