https://github.com/brunobrown/logging-discord
The Logging Discord is a tool that simplifies the logging of error messages to a Discord channel. It allows you to send error messages with custom information, including a traceback and specific messages.
https://github.com/brunobrown/logging-discord
cli debugging discord error-reporting messenger python
Last synced: 8 months ago
JSON representation
The Logging Discord is a tool that simplifies the logging of error messages to a Discord channel. It allows you to send error messages with custom information, including a traceback and specific messages.
- Host: GitHub
- URL: https://github.com/brunobrown/logging-discord
- Owner: brunobrown
- License: mit
- Created: 2023-06-21T18:09:42.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-03T00:19:37.000Z (almost 2 years ago)
- Last Synced: 2025-09-05T09:58:28.523Z (10 months ago)
- Topics: cli, debugging, discord, error-reporting, messenger, python
- Language: Python
- Homepage:
- Size: 2.3 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-pt.md
- License: LICENSE
Awesome Lists containing this project
README
# Logging Discord
[](https://logging-discord.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/brunobrown/logging-discord/actions/workflows/pipeline.yml)
[](https://codecov.io/gh/brunobrown/logging-discord)
- [English](README.md)
- [Português](README-pt.md)
`Logging Discord` é uma ferramenta que facilita o registro de mensagens de erro em um canal no Discord. Permite o envio de traceback e mensagens com informações específicas e personalizadas. Abaixo, você encontrará detalhes, parâmetros e métodos, bem como exemplos de uso.
## Índice
- [Como instalar o pacote?](#como-instalar-o-pacote)
- [Como usar o pacote?](#como-usar-o-pacote)
- [Configuração via 'discord_config.py'](#configuração-via-discord_configpy)
- [Exemplos de Uso](#exemplos-de-uso)
- [Doações](#doações)
---
## Como instalar o pacote?
```bash
pip install logging_discord
```
## Como usar o pacote?
### Inicio rápido.
```python
from logging_discord import LogDiscord
log_discord = LogDiscord(webhook='https://webhook_do_seu_canal_no_discord')
log_discord.send(log_level=1) # 0 = unknown, 1 = debug, 2 = info, 3 = warning, 4 = error, 5 = critical
```
---
## Configuração via `discord_config.py`
Você pode configurar os parâmetros da classe `LogDiscord` criando um arquivo
chamado 'discord_config.py' na raiz do projeto. O arquivo 'discord_config.py'
deve conter as seguintes configurações:
Exemplo:
```python
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},
}
```
---
## Exemplos de Uso
Aqui estão alguns exemplos de como usar a classe `LogDiscord`:
```python
# Criando uma instância do logger
logger = LogDiscord(webhook="sua_url_webhook", avatar_url="url_do_avatar", mode="DEVELOPMENT", app_name="MeuApp")
# Enviando um log de erro com traceback
logger.send(show_traceback=True, error_message="Erro crítico ocorreu!", log_level=5)
# Enviando um log de informação
logger.send(show_traceback=False, error_message="Operação bem-sucedida.", log_level=2)
```
#### Lembre-se de ajustar os parâmetros de acordo com suas necessidades e personalizar as mensagens de erro conforme necessário.
---
## Doações
Obrigado por considerar apoiar o projeto! Sua ajuda é muito apreciada e me ajuda a continuar desenvolvendo e mantendo o software.
[Apoie o Projeto](https://logging-discord.readthedocs.io/en/latest/#support-the-project)
---
[Peça a Deus que abençoe os seus planos, e eles darão certo. Provérbios 16: 3](https://www.bible.com/bible/211/PRO.16.NTLH)