|
|
|
@@ -40,11 +40,15 @@ happens before the discord send, so the record survives even if discord fails.
|
|
|
|
|
extending: this base has no feed/announcement method by design. a project
|
|
|
|
|
that wants one subclasses DPYLogger and adds it, reusing _resolve.
|
|
|
|
|
|
|
|
|
|
errors: resolution failures (unresolvable guild/channel, bad config) raise
|
|
|
|
|
errors: resolution failures (unresolvable guild/channel, bad config, a
|
|
|
|
|
non-text channel passed as either an id or an already-resolved object) raise
|
|
|
|
|
ValueError from `initialize()` — a misconfigured logger should fail loudly at
|
|
|
|
|
setup. on a per-call send, resolution AND send failures do NOT propagate: they
|
|
|
|
|
fall back to the stdlib logger so a transient discord failure (or a per-call
|
|
|
|
|
`guild=` that doesn't resolve) never breaks the caller's command.
|
|
|
|
|
setup. underlying discord exceptions (NotFound/Forbidden/HTTPException/
|
|
|
|
|
InvalidData and other ClientException subclasses) are normalized to that
|
|
|
|
|
ValueError on every resolution path. on a per-call send, resolution AND send
|
|
|
|
|
failures do NOT propagate: they fall back to the stdlib logger so a transient
|
|
|
|
|
discord failure (or a per-call `guild=` that doesn't resolve) never breaks the
|
|
|
|
|
caller's command.
|
|
|
|
|
"""
|
|
|
|
|
|
|
|
|
|
import logging
|
|
|
|
@@ -119,6 +123,12 @@ class DPYLogger:
|
|
|
|
|
self.guild = self.channel.guild
|
|
|
|
|
if self.guild is None and self.channel is not None:
|
|
|
|
|
raise ValueError("[dpy_logger] channel provided without a resolvable guild")
|
|
|
|
|
# a resolved wrong-type object (Thread/VoiceChannel/ForumChannel) would also pass
|
|
|
|
|
# setup silently — _get_channel only recognizes TextChannel/int, so anything else
|
|
|
|
|
# falls through to the bot.settings lookup at send time and misroutes or blackholes
|
|
|
|
|
# the sink. fail loud here, mirroring the int-path check in _get_channel.
|
|
|
|
|
if self.channel is not None and not isinstance(self.channel, (discord.TextChannel, int)):
|
|
|
|
|
raise ValueError(f"[dpy_logger] channel {self.channel!r} is not a text channel")
|
|
|
|
|
|
|
|
|
|
async def _get_guild(self, guild):
|
|
|
|
|
"""resolve a guild from id-or-object, raising if unresolvable"""
|
|
|
|
@@ -147,7 +157,14 @@ class DPYLogger:
|
|
|
|
|
if isinstance(self.channel, discord.TextChannel):
|
|
|
|
|
return self.channel
|
|
|
|
|
if isinstance(self.channel, int):
|
|
|
|
|
# fetch_channel raises NotFound/Forbidden/HTTPException/InvalidData (a
|
|
|
|
|
# ClientException, not an HTTPException); normalize all of those to the
|
|
|
|
|
# lib's ValueError so a bad construction channel id fails loud with one
|
|
|
|
|
# error type, matching the settings path below
|
|
|
|
|
try:
|
|
|
|
|
channel = await guild.fetch_channel(self.channel)
|
|
|
|
|
except (discord.HTTPException, discord.ClientException) as error:
|
|
|
|
|
raise ValueError(f"[dpy_logger] could not fetch channel {self.channel}: {error}") from error
|
|
|
|
|
if not isinstance(channel, discord.TextChannel):
|
|
|
|
|
# fetch_channel can return a Voice/Category/Forum channel; fail loud
|
|
|
|
|
# at setup like the settings path, not later via an AttributeError on .send
|
|
|
|
@@ -160,8 +177,9 @@ class DPYLogger:
|
|
|
|
|
raise ValueError(f"[dpy_logger] no log channel configured for guild {guild.id}")
|
|
|
|
|
try:
|
|
|
|
|
channel = await guild.fetch_channel(channel_id)
|
|
|
|
|
except discord.HTTPException as error:
|
|
|
|
|
# fetch_channel raises NotFound/Forbidden/HTTPException; normalize to the
|
|
|
|
|
except (discord.HTTPException, discord.ClientException) as error:
|
|
|
|
|
# fetch_channel raises NotFound/Forbidden/HTTPException/InvalidData (a
|
|
|
|
|
# ClientException, not an HTTPException); normalize all of those to the
|
|
|
|
|
# lib's ValueError so a bad configured id fails loud with one error type
|
|
|
|
|
raise ValueError(f"[dpy_logger] could not fetch channel {channel_id}: {error}") from error
|
|
|
|
|
if not isinstance(channel, discord.TextChannel):
|
|
|
|
@@ -179,14 +197,16 @@ class DPYLogger:
|
|
|
|
|
if self._embed_builder is not None:
|
|
|
|
|
return self._embed_builder(self, level, action, actor, details)
|
|
|
|
|
em = discord.Embed(color=self.colors[level])
|
|
|
|
|
if action:
|
|
|
|
|
# test `is not None` so a falsy-but-valid value (0, False) still renders; only a
|
|
|
|
|
# genuinely absent field (None) or an empty string is dropped/substituted below
|
|
|
|
|
if action is not None and str(action) != "":
|
|
|
|
|
em.add_field(name="Action", value=f"`{action}`", inline=True)
|
|
|
|
|
if actor:
|
|
|
|
|
if actor is not None and str(actor) != "":
|
|
|
|
|
em.add_field(name="Actor", value=f"`{actor}`", inline=True)
|
|
|
|
|
# discord rejects an empty field value (50035) and truncates nothing itself, so
|
|
|
|
|
# an empty or >1024-char message would 400 the send; substitute + cap to keep
|
|
|
|
|
# every logging call producing a valid embed
|
|
|
|
|
log_value = str(details) if details else "(no message)"
|
|
|
|
|
log_value = str(details) if details is not None and str(details) != "" else "(no message)"
|
|
|
|
|
if len(log_value) > 1024:
|
|
|
|
|
log_value = log_value[:1021] + "..."
|
|
|
|
|
em.add_field(name="Log", value=log_value, inline=False)
|
|
|
|
@@ -200,20 +220,28 @@ class DPYLogger:
|
|
|
|
|
|
|
|
|
|
def _emit_stdlib(self, level, action, actor, log_msg):
|
|
|
|
|
"""mirror the log line to the stdlib logger (routed to file/console by the app)"""
|
|
|
|
|
parts = [p for p in (action, str(actor) if actor else None, log_msg) if p]
|
|
|
|
|
# render falsy-but-valid parts (0, False); drop only genuinely-absent (None) ones
|
|
|
|
|
raw = (action, str(actor) if actor is not None else None, log_msg)
|
|
|
|
|
parts = [str(p) for p in raw if p is not None and str(p) != ""]
|
|
|
|
|
_log.log(LEVEL_MAP.get(level, logging.INFO), f"[{level}] " + " | ".join(parts))
|
|
|
|
|
|
|
|
|
|
async def _send(self, level, log_msg, action=None, actor=None, guild=None, log_to_file=None):
|
|
|
|
|
async def _send(self, level, log_msg, action=None, actor=None, guild=None,
|
|
|
|
|
log_to_file=None, content=None):
|
|
|
|
|
"""resolve channel and dispatch a leveled embed; mirror to stdlib unless opted out
|
|
|
|
|
|
|
|
|
|
stdlib emit happens first so the record survives even if the discord send fails.
|
|
|
|
|
a failed send falls back to stdlib rather than propagating into the caller.
|
|
|
|
|
`content` carries the critical-level ping/@here text (None for the other levels),
|
|
|
|
|
so every level shares this one send/error contract.
|
|
|
|
|
"""
|
|
|
|
|
if self.log_to_file if log_to_file is None else log_to_file:
|
|
|
|
|
self._emit_stdlib(level, action, actor, log_msg)
|
|
|
|
|
try:
|
|
|
|
|
channel = await self._resolve(guild)
|
|
|
|
|
return await channel.send(embed=self.build_embed(level, action, actor, log_msg))
|
|
|
|
|
return await channel.send(
|
|
|
|
|
content=content,
|
|
|
|
|
embed=self.build_embed(level, action, actor, log_msg),
|
|
|
|
|
)
|
|
|
|
|
except Exception:
|
|
|
|
|
_log.exception(f"[dpy_logger] failed to send {level} log: {log_msg}")
|
|
|
|
|
return None
|
|
|
|
@@ -245,21 +273,15 @@ class DPYLogger:
|
|
|
|
|
return await self._send("task", log, action, "SYSTEM/TASK", guild, log_to_file)
|
|
|
|
|
|
|
|
|
|
async def critical(self, log, action=None, actor=None, guild=None, log_to_file=None):
|
|
|
|
|
"""log a critical-level message and ping configured devs"""
|
|
|
|
|
if self.log_to_file if log_to_file is None else log_to_file:
|
|
|
|
|
self._emit_stdlib("critical", action, actor, log)
|
|
|
|
|
"""log a critical-level message and ping configured devs
|
|
|
|
|
|
|
|
|
|
delegates to _send with the ping/@here content so the send + error contract has a
|
|
|
|
|
single source of truth; critical only adds the alert `content`.
|
|
|
|
|
"""
|
|
|
|
|
if self.pings:
|
|
|
|
|
content = "alert: " + " ".join(f"<@{u}>" for u in self.pings)
|
|
|
|
|
elif self.alert_here:
|
|
|
|
|
content = "alert: @here"
|
|
|
|
|
else:
|
|
|
|
|
content = None
|
|
|
|
|
try:
|
|
|
|
|
channel = await self._resolve(guild)
|
|
|
|
|
return await channel.send(
|
|
|
|
|
content=content,
|
|
|
|
|
embed=self.build_embed("critical", action, actor, log),
|
|
|
|
|
)
|
|
|
|
|
except Exception:
|
|
|
|
|
_log.exception(f"[dpy_logger] failed to send critical log: {log}")
|
|
|
|
|
return None
|
|
|
|
|
return await self._send("critical", log, action, actor, guild, log_to_file, content)
|
|
|
|
|