From: Muhammad Rizki <[email protected]>
To: Ammar Faizi <[email protected]>
Cc: Muhammad Rizki <[email protected]>,
Alviro Iskandar Setiawan <[email protected]>,
GNU/Weeb Mailing List <[email protected]>
Subject: [PATCH v2 15/17] discord: logger: Refactor all logging method
Date: Thu, 19 Jan 2023 00:53:54 +0700 [thread overview]
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>
Same as the telegram refactors. We use a simple logging method by using
file config and replace all custom logger method to built-in logging
method. This method is more cleaner and less code wasteful.
The reason why we should name the logger like:
`logging.getLogger("dscord")`
Because, if we use "discord" as the logger name, it will conflict the
discord.py's logger, that's why we need to disable the discord.py's
logger not to interrupt our logger.
Signed-off-by: Muhammad Rizki <[email protected]>
---
daemon/dc.py | 8 +-------
daemon/dscord/gnuweeb/client.py | 19 ++++++++++++-------
daemon/dscord/gnuweeb/filters.py | 12 +++++-------
.../dscord/gnuweeb/plugins/events/on_ready.py | 5 ++++-
daemon/dscord/mailer/listener.py | 17 ++++++++++-------
5 files changed, 32 insertions(+), 29 deletions(-)
diff --git a/daemon/dc.py b/daemon/dc.py
index f4eeefb..dade9f1 100644
--- a/daemon/dc.py
+++ b/daemon/dc.py
@@ -13,8 +13,6 @@ from apscheduler.schedulers.asyncio import AsyncIOScheduler
from dscord.gnuweeb import GWClient
from dscord.mailer import Listener
from dscord.mailer import Mutexes
-from enums.platform import Platform
-from logger import BotLogger
from atom import Scraper
@@ -28,9 +26,6 @@ def main():
}
)
- logger = BotLogger(Platform.DISCORD)
- logger.init()
-
logging.config.fileConfig("dscord/discord.logger.conf")
logging.getLogger("apscheduler").setLevel(logging.WARNING)
logging.getLogger("discord").setLevel(logging.WARNING)
@@ -42,8 +37,7 @@ def main():
port=int(os.environ.get("DB_PORT", 3306)),
password=os.getenv("DB_PASS"),
database=os.getenv("DB_NAME")
- ),
- logger=logger
+ )
)
mailer = Listener(
diff --git a/daemon/dscord/gnuweeb/client.py b/daemon/dscord/gnuweeb/client.py
index 7d6433b..a04fd26 100644
--- a/daemon/dscord/gnuweeb/client.py
+++ b/daemon/dscord/gnuweeb/client.py
@@ -3,6 +3,7 @@
# Copyright (C) 2022 Muhammad Rizki <[email protected]>
#
+import logging
import discord
from discord import Interaction, Message
from discord.ext import commands
@@ -14,18 +15,19 @@ from . import models
from atom import utils
from enums import Platform
from exceptions import DaemonException
-from logger.log import BotLogger
from dscord.config import ACTIVITY_NAME, LOG_CHANNEL_ID
from dscord.database import DB
+log = logging.getLogger("dscord")
+
+
class GWClient(commands.Bot):
- def __init__(self, db_conn, logger: BotLogger) -> None:
+ def __init__(self, db_conn) -> None:
self.db = DB(db_conn)
intents = Intents.default()
intents.message_content = True
self.mailer = None
- self.logger = logger
super().__init__(
command_prefix=["$", "."],
description="Just a bot for receiving lore emails.",
@@ -42,7 +44,7 @@ class GWClient(commands.Bot):
async def report_err(self, e: DaemonException):
- self.logger.warning(e.original_exception)
+ log.warning(e.original_exception)
capt = f"Atom URL: {e.atom_url}\n"
capt += f"Thread URL: {e.thread_url}"
await self.send_log_file(capt)
@@ -50,7 +52,10 @@ class GWClient(commands.Bot):
@filters.wait_on_limit
async def send_log_file(self, caption: str):
- filename = self.logger.handlers[0].baseFilename
+ for handler in log.root.handlers:
+ if isinstance(handler, logging.FileHandler):
+ filename = handler.baseFilename
+
channel = self.get_channel(LOG_CHANNEL_ID)
await channel.send(
content=caption,
@@ -61,7 +66,7 @@ class GWClient(commands.Bot):
@filters.wait_on_limit
async def send_text_email(self, guild_id: int, chat_id: int, text: str,
reply_to: Union[int, None] = None, url: str = None) -> Message:
- self.logger.debug("[send_text_email]")
+ log.debug("[send_text_email]")
channel = self.get_channel(chat_id)
return await channel.send(
@@ -78,7 +83,7 @@ class GWClient(commands.Bot):
@filters.wait_on_limit
async def send_patch_email(self, mail, guild_id: int, chat_id: int, text: str,
reply_to: Union[int, None] = None, url: str = None) -> Message:
- self.logger.debug("[send_patch_email]")
+ log.debug("[send_patch_email]")
tmp, doc, caption, url = utils.prepare_patch(
mail, text, url, Platform.DISCORD
)
diff --git a/daemon/dscord/gnuweeb/filters.py b/daemon/dscord/gnuweeb/filters.py
index 28b492c..ccd13e7 100644
--- a/daemon/dscord/gnuweeb/filters.py
+++ b/daemon/dscord/gnuweeb/filters.py
@@ -5,6 +5,7 @@
import asyncio
+import logging
from typing import Any, Callable, TypeVar, Coroutine
from typing_extensions import ParamSpec, ParamSpecArgs, ParamSpecKwargs
from functools import wraps
@@ -13,9 +14,9 @@ import discord
from discord import Interaction
from dscord import config
-from logger import BotLogger
+log = logging.getLogger("dscord")
T = TypeVar("T")
P = ParamSpec("P")
@@ -45,15 +46,12 @@ def wait_on_limit(func: Callable[P, Coroutine[Any,Any,T]]) -> Callable[P, Corout
try:
return await func(*args, **kwargs)
except discord.errors.RateLimited as e:
- # Calling logger attr from the GWClient() class
- logger = args[0].logger
-
_flood_exceptions(e)
- logger.info("Woken up from flood wait...")
+ log.info("Woken up from flood wait...")
return callback
-async def _flood_exceptions(e: "discord.errors.RateLimited", logger: BotLogger):
+async def _flood_exceptions(e: "discord.errors.RateLimited"):
wait = e.retry_after
- logger.info(f"Sleeping for {wait} seconds due to Discord limit")
+ log.info(f"Sleeping for {wait} seconds due to Discord limit")
await asyncio.sleep(wait)
diff --git a/daemon/dscord/gnuweeb/plugins/events/on_ready.py b/daemon/dscord/gnuweeb/plugins/events/on_ready.py
index e7f63cd..4248aad 100644
--- a/daemon/dscord/gnuweeb/plugins/events/on_ready.py
+++ b/daemon/dscord/gnuweeb/plugins/events/on_ready.py
@@ -3,9 +3,12 @@
# Copyright (C) 2022 Muhammad Rizki <[email protected]>
#
+import logging
from discord.ext import commands
+log = logging.getLogger("dscord")
+
class OnReady(commands.Cog):
def __init__(self, bot: "commands.Bot") -> None:
self.bot = bot
@@ -23,4 +26,4 @@ class OnReady(commands.Cog):
t += f"Send `{prefix}sync` message to the Discord channel "
t += "where the bot is running.\n"
- self.bot.logger.info(t)
+ log.info(t)
diff --git a/daemon/dscord/mailer/listener.py b/daemon/dscord/mailer/listener.py
index fc066b7..25e5715 100644
--- a/daemon/dscord/mailer/listener.py
+++ b/daemon/dscord/mailer/listener.py
@@ -6,6 +6,7 @@
import asyncio
import re
+import logging
from mysql.connector.errors import OperationalError, DatabaseError
from apscheduler.schedulers.asyncio import AsyncIOScheduler
from discord import File
@@ -18,6 +19,9 @@ from enums import Platform
from exceptions import DaemonException
+log = logging.getLogger("dscord")
+
+
class Mutexes:
def __init__(self):
self.lock = asyncio.Lock()
@@ -36,7 +40,6 @@ class Listener:
self.scraper = scraper
self.mutexes = mutexes
self.db = client.db
- self.logger = client.logger
self.isRunnerFixed = False
self.runner = None
@@ -46,7 +49,7 @@ class Listener:
# Execute __run() once to avoid high latency at
# initilization.
#
- self.logger.info("Initialize listener...\n")
+ log.info("Initialize listener...\n")
self.sched.start()
self.runner = self.sched.add_job(func=self.__run)
@@ -56,8 +59,8 @@ class Listener:
# TODO(ammarfaizi2):
# Ideally, we also want to log and report this situation.
#
- self.logger.error(f"Database error: {str(e)}")
- self.logger.info("Reconnecting to the database...")
+ log.error(f"Database error: {str(e)}")
+ log.info("Reconnecting to the database...")
#
# Don't do this too often to avoid reconnect burst.
@@ -70,7 +73,7 @@ class Listener:
async def __run(self):
- self.logger.info("Running...")
+ log.info("Running...")
url = None
try:
@@ -128,7 +131,7 @@ class Listener:
email_msg_id = utils.get_email_msg_id(mail)
if not email_msg_id:
md = "email_msg_id not detected, skipping malformed email"
- self.logger.debug(md)
+ log.debug(md)
return False
email_id = self.__get_email_id_sent(
@@ -137,7 +140,7 @@ class Listener:
)
if not email_id:
md = f"Skipping {email_id} because has already been sent to Discord"
- self.logger.debug(md)
+ log.debug(md)
return False
text, files, is_patch = utils.create_template(mail, Platform.DISCORD)
--
Muhammad Rizki
next prev parent reply other threads:[~2023-01-18 17:54 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-18 17:53 [PATCH v2 00/17] Everything about logger changes and some fixes Muhammad Rizki
2023-01-18 17:53 ` [PATCH v2 01/17] telegram: Simplify code to get DB_PORT from env Muhammad Rizki
2023-01-18 17:53 ` [PATCH v2 02/17] discord: " Muhammad Rizki
2023-01-18 17:53 ` [PATCH v2 03/17] telegram: logger: Add a telegram.logger.conf Muhammad Rizki
2023-01-18 17:53 ` [PATCH v2 04/17] discord: logger: Add a discord.logger.conf Muhammad Rizki
2023-01-18 17:53 ` [PATCH v2 05/17] telegram: logger: Initialize the configuration for the Telegram logger Muhammad Rizki
2023-01-18 17:53 ` [PATCH v2 06/17] discord: logger: Initialize the configuration for the Discord logger Muhammad Rizki
2023-01-18 17:53 ` [PATCH v2 07/17] telegram: fix: Fix the type annoations for the decorator Muhammad Rizki
2023-01-18 17:53 ` [PATCH v2 08/17] discord: cleanup: Remove some unnecessary comments Muhammad Rizki
2023-01-18 17:53 ` [PATCH v2 09/17] discord: fix: Fix the type annotations for the decorator Muhammad Rizki
2023-01-18 17:53 ` [PATCH v2 10/17] discord: typing: Add return type annotations Muhammad Rizki
2023-01-18 17:53 ` [PATCH v2 11/17] telegram: Implement DaemonException() and report_err() in scrape.py Muhammad Rizki
2023-01-18 17:53 ` [PATCH v2 12/17] utils: fix: Fix charset issue for get_decoded_payload() Muhammad Rizki
2023-01-18 17:53 ` [PATCH v2 13/17] telegram: logger: Refactor all logging method Muhammad Rizki
2023-01-18 17:53 ` [PATCH v2 14/17] discord: Implement DaemonException and report_err in get_lore_mail.py Muhammad Rizki
2023-01-18 17:53 ` Muhammad Rizki [this message]
2023-01-18 17:53 ` [PATCH v2 16/17] refactor: Move requirements.txt Muhammad Rizki
2023-01-18 17:53 ` [PATCH v2 17/17] cleanup: Remove the custom logger module Muhammad Rizki
2023-01-19 6:54 ` [PATCH v2 00/17] Everything about logger changes and some fixes Ammar Faizi
2023-01-19 12:49 ` Muhammad Rizki
2023-01-19 6:54 ` Ammar Faizi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
[email protected] \
[email protected] \
[email protected] \
[email protected] \
[email protected] \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox