discord-logging-handler 0.3.0

A logging handler that sends log messages to discord via webhook.

Discord Logging Handler

A Python logging handler that sends log messages to Discord via webhook with colour-coded levels.

Features

• Colour-coded embeds by log level
• Supports full stack traces for errors and exceptions
• Configurable minimum log level
• Simple drop-in integration for any Python project
• Optional development mode to suppress logs during builds/tests

Installation

pip install discord-logging-handler

Usage

from discord_logging_handler import DiscordWebHookHandler
import logging

handler = DiscordWebHookHandler(webhook_url="WEBHOOK_URL", level=logging.INFO, dev_mode=True)

• webhook_url: Your webhook from Discord Integrations.
• level (optional): The minimum level that should trigger logs to be sent to Discord. Defaults to ERROR.
• dev_mode (optional): Use to enable development mode (logs are suppressed during builds/tests). Defaults to False.

Example

from discord_logging_handler import DiscordWebHookHandler
import logging

# Create handler
handler = DiscordWebHookHandler(webhook_url="WEBHOOK_URL", level=logging.INFO, dev_mode=False)

# Set up the root logger
logger = logging.getLogger()
logger.setLevel(logging.DEBUG)
logger.addHandler(handler)

# Example log messages
logger.info("Server started successfully.")
logger.warning("Disk space running low.")
logger.error("Database connection failed.")

# Example exception handling
try:
    1 / 0
except Exception:
    logger.exception("An unexpected error occurred.")

Example Output

Logs appear directly in your Discord channel with level-based colour coding:

Django Example

settings.py

import os
from pathlib import Path
from discord_logging_handler import DiscordWebHookHandler  # ensure it's installed

BASE_DIR = Path(__file__).resolve().parent.parent

DISCORD_WEBHOOK_URL = os.environ.get('DISCORD_WEBHOOK_URL')

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'handlers': {
        'file': {
            'level': 'INFO',
            'class': 'logging.FileHandler',
            'filename': BASE_DIR / 'logs/app.log',
            'formatter': 'verbose',
        },
        'console': {
            'class': 'logging.StreamHandler',
            'formatter': 'simple'
        },
        'discord': {
            'level': 'INFO',
            'class': 'discord_logging_handler.handler.DiscordWebHookHandler',
            'webhook_url': DISCORD_WEBHOOK_URL,
            'dev_mode': False
        }
    },
    'root': {
        'handlers': ['console', 'file', 'discord'],
        'level': 'INFO',
    },
    'loggers': {
        'django': {
            'handlers': ['console', 'file'],
            'level': 'CRITICAL',
            'propagate': True,
        },
        'vaultapi': {
            'handlers': ['console', 'file', 'discord'],
            'level': 'INFO',
            'propagate': False,
        },
    },
}

Environment Variable

DISCORD_WEBHOOK_URL: Your Discord webhook URL.

Discord Webhook Setup

Discord allows webhooks to be created via Server Settings → Integrations.

1. Go to Server Settings → Integrations
2. Under Webhooks, click New Webhook
3. Copy the generated webhook URL

Contributing

Contributions, issues, and feature requests are welcome!
Feel free to open an issue or submit a pull request on GitHub.

License

MIT License

Copyright (c) 2025 Moses White