logging-discord

Logging Discord

• English
• Português

Logging Discord is a tool that streamlines error message logging to a Discord channel. It enables the sending of tracebacks and custom specific information messages. Below, you will find details, parameters and methods, as well as usage examples.

Table of Contents

• How to Install the Package?
• How to Use the Package?
• Configuration via 'discord_config.py'
• Usage Examples
• Donations

How to Install the Package?

pip install logging_discord

How to Use the Package?

Quick Start.

from logging_discord import LogDiscord

log_discord = LogDiscord(webhook='https://your_discord_channel_webhook')

log_discord.send(log_level=1)   # 0 = unknown, 1 = debug, 2 = info, 3 = warning, 4 = error, 5 = critical

Configuration with discord_config.py

You can configure the parameters of the LogDiscord class by creating a file called 'discord_config.py' at the root of the project. The 'discord_config.py' file should contain the following configurations:

Example:

channel = {
    'webhook': 'https://discord.com/api/webhooks/example',
    'avatar_url': 'https://i0.wp.com/www.theterminatorfans.com/wp-content/uploads/2012/09/the-terminator3.jpg?resize=900%2C450&ssl=1',
    'mode': 'DEVELOPMENT',
    'app_name': 'APP_TEST',
}

log_levels = {
    #   color legend:
    #   * UNKNOWN: 0 = Black
    #   * DEBUG: 35840 = Green
    #   * INFO: 2196944 = Blue
    #   * WARNING: 16497928 = Yellow
    #   * ERROR: 16729344 = Red Orange
    #   * CRITICAL: 12255250 = Red
    
    0: {
        'emoji': ':thinking:   ',
        'title': 'UNKNOWN',
        'color': 0,
    },
    1: {'emoji': ':beetle:   ', 'title': 'DEBUG', 'color': 35840},
    2: {
        'emoji': ':information_source:   ',
        'title': 'INFO',
        'color': 2196944,
    },
    3: {
        'emoji': ':warning:   ',
        'title': 'WARNING',
        'color': 16497928,
    },
    4: {'emoji': ':x:   ', 'title': 'ERROR', 'color': 16729344},
    5: {'emoji': ':sos:   ', 'title': 'CRITICAL', 'color': 12255250},
}

Usage Examples

Here are some examples of how to use the LogDiscord class:

# Creating a logger instance
logger = LogDiscord(webhook="your_webhook_url", avatar_url="avatar_url", mode="DEVELOPMENT", app_name="MyApp")

# Sending an error log with traceback
logger.send(show_traceback=True, error_message="Critical error occurred!", log_level=5)

# Sending an information log
logger.send(show_traceback=False, error_message="Operation successful.", log_level=2)

Remember to adjust the parameters according to your needs and customize error messages as necessary.

Donations

Thank you for considering supporting the project! Your help is greatly appreciated and it enables me to continue developing and maintaining the software.

Support the Project

Commit your work to the LORD, and your plans will succeed. Proverbs 16: 3