config.yaml

# GoDockerManager Configuration File
# Copy this file to your working directory as 'config.yaml'
#
# This file contains all configuration options for GoDockerManager including
# the new enterprise-grade monitoring, security, and observability features.

# =============================================================================
# DOCKER CONNECTION
# =============================================================================

# Docker socket path
# Default: unix:///var/run/docker.sock
# Examples:
#   - Unix socket: "unix:///var/run/docker.sock"
#   - TCP socket: "tcp://localhost:2376"
#   - Windows named pipe: "npipe:////./pipe/docker_engine"
docker_socket: "unix:///var/run/docker.sock"

# =============================================================================
# OUTPUT FORMATTING
# =============================================================================

# Default output format for list commands
# Options: table, json, yaml, csv
# Default: table
output_format: "table"

# =============================================================================
# MONITORING & METRICS
# =============================================================================

# Enable historical metrics collection
# When enabled, container metrics are stored for historical analysis
enable_metrics: true

# Metrics retention period in hours
# Data older than this period will be automatically cleaned up
# Default: 168 hours (7 days)
# Minimum: 24 hours (1 day)
# Maximum: 720 hours (30 days)
metrics_retention: 168

# Metrics collection interval in seconds
# How often to collect container metrics when using prometheus exporter
# Default: 30 seconds
# Minimum: 10 seconds
# Maximum: 300 seconds (5 minutes)
metrics_interval: 30

# =============================================================================
# ALERTING SYSTEM
# =============================================================================

alerting:
  # Enable real-time alerting for container resource usage
  enabled: true

  # CPU usage threshold percentage
  # Alerts when container CPU usage exceeds this value
  # Range: 0.0 - 100.0
  cpu_threshold: 80.0

  # Memory usage threshold percentage
  # Alerts when container memory usage exceeds this value
  # Range: 0.0 - 100.0
  memory_threshold: 90.0

  # Disk usage threshold percentage
  # Alerts when container disk I/O usage exceeds this value
  # Range: 0.0 - 100.0
  disk_threshold: 85.0

  # Alert notification method
  # Options: console, webhook, email, slack
  # console: Print alerts to command line
  # webhook: Send alerts to HTTP endpoint (requires webhook_url)
  # email: Send alerts via email (requires email configuration)
  # slack: Send alerts to Slack channel (requires slack configuration)
  notification_method: "console"

  # Webhook configuration (if notification_method is "webhook")
  webhook_url: ""  # e.g., "https://hooks.slack.com/services/..."
  webhook_timeout: 30  # seconds

  # Email configuration (if notification_method is "email")
  email_smtp_server: "smtp.gmail.com"
  email_smtp_port: 587
  email_username: ""
  email_password: ""
  email_from: ""
  email_to: []

# =============================================================================
# SECURITY SCANNING
# =============================================================================

security:
  # Enable automatic security scanning for containers
  # When enabled, containers are scanned for known vulnerabilities
  enabled: true

  # Security scan interval in hours
  # How often to automatically scan running containers
  # Default: 24 hours
  # Set to 0 to disable automatic scanning
  scan_interval: 24

  # Vulnerability database update interval in hours
  # How often to check for vulnerability database updates
  # Default: 168 hours (7 days)
  db_update_interval: 168

  # Security levels for reporting
  # Include containers with vulnerabilities at or above this level
  # Options: low, medium, high, critical
  minimum_severity_level: "medium"

# =============================================================================
# PROMETHEUS INTEGRATION
# =============================================================================

prometheus:
  # Default port for Prometheus metrics exporter
  # This port is used when running 'docker-container-manager prometheus'
  default_port: 8080

  # Metrics collection interval
  # How often to collect and update Prometheus metrics
  # Format: duration string (e.g., "30s", "1m", "5m")
  collection_interval: "30s"

  # Enable detailed metrics
  # When true, includes additional detailed metrics for advanced monitoring
  detailed_metrics: true

  # Enable health check endpoint
  # Provides /health endpoint for load balancer health checks
  health_check_enabled: true

# =============================================================================
# GRAFANA DASHBOARD
# =============================================================================

grafana:
  # Default dashboard title
  dashboard_title: "GoDockerManager Container Metrics"

  # Dashboard refresh interval in seconds
  # How often Grafana should refresh the dashboard
  refresh_interval: 10

  # Default time range for dashboard
  # Format: "now-Xh" where X is number of hours
  default_time_range: "now-1h"

  # Include panels for:
  # - CPU usage trends
  # - Memory consumption
  # - Network traffic
  # - Disk I/O
  # - Container health status
  enable_all_panels: true

# =============================================================================
# DATA STORAGE
# =============================================================================

# Directory for storing metrics and security data
# Default: ~/.godockermanager/
# Set to absolute path to override default location
data_directory: ""

# Enable data compression for historical metrics
# Reduces disk usage for long-term metric storage
enable_compression: true

# Maximum disk usage percentage for data storage
# When exceeded, oldest data is automatically cleaned up
max_disk_usage: 80.0

# =============================================================================
# LOGGING
# =============================================================================

# Log level for application logs
# Options: debug, info, warn, error
# Default: info
log_level: "info"

# Enable detailed logging for debugging
# When true, includes detailed debug information in logs
debug_logging: false

# Log file path (empty for console only)
# Set to file path to enable persistent logging
log_file: ""

# Maximum log file size in MB before rotation
# Default: 100 MB
max_log_size: 100

# Maximum number of rotated log files to keep
# Default: 5
max_log_files: 5

# =============================================================================
# EXAMPLE CUSTOM CONFIGURATIONS
# =============================================================================
#
# Production Environment:
#   metrics_retention: 720  # 30 days
#   alerting:
#     notification_method: "webhook"
#     webhook_url: "https://your-webhook-url"
#   security:
#     minimum_severity_level: "high"
#     scan_interval: 6  # Every 6 hours
#
# Development Environment:
#   metrics_retention: 24  # 1 day
#   alerting:
#     notification_method: "console"
#   prometheus:
#     default_port: 9090
#     detailed_metrics: false
#
# High Security Environment:
#   security:
#     minimum_severity_level: "low"
#     scan_interval: 1  # Every hour
#   alerting:
#     cpu_threshold: 70.0  # More sensitive
#     memory_threshold: 80.0