Logger module

[Jet132]

Add a module that is responsible for managing log channels and gives log event emitters a standardized interface.
Module consumers should be able to tag events and users should be able to set filters for certain log channels.
Like for example ban cases go in #bans, the rest of the cases go in #cases, and system logs go in #logs.

[ElementalMP4]

Initial Design Proposal:

I will need to study the botler docs to understand how to implement this, but here is a design for this feature which I feel is sufficiently capable:

From what I have read so far, this may be achievable in a single module (probably called GigaLogger) which will contain two components:

1. A command which will be used to manipulate the gigalogger configuration
2. An event listener which will watch for events from discord (and I assume the moderation commands) and filter them into their appropriate log channel

Frontend
When the logger is set up, the user will be guided through an initial setup process which will ask them for each event whether they would like it to be logged, and what channel they would like it to be logged to. Additionally, users may want to set a master log channel which all events will be sent to.
As well as this setup option, users may choose to set individual channels for individual log events. For example, bans, kicks etc may want to be logged to a separate mod action channel, and all other events to the master channel. To do this, they may use a subcommand which allows them to choose an event by name and a channel to log that event to. This action can be undone by repeating the same command phrase.
If the user is uncool and decides to disable the logger, a disable option should be present which will either clear the entire setup or set a disabled flag in the database (in case the user changes their mind)

Backend
The listener section of the module will be constantly listening for events from discord. When an event is received, the Guild ID of the event will be used to retrieve a config entity. This will contain the events by name and their respective channels. If no channel is set, it will be null by default. If no config is found, the event will be ignored. If a config is found, the event name will be checked for a logging channel AND the master channel. If neither one is found, we will again ignore it. If there is a channel, we will then send the log messages.

Any tweaks or ideas are very much appreciated

[Jet132]

Well, I completely forgot about this comment. The logger is intended to only log events originating from Botler itself and not from Discord directly as the Megalogger module (#3) will be responsible for that.

Ideally, other modules could register a specific event type with like .getLogger('event-name') or something and when sending the messages, the logger module would take care of whether a channel for it was set or not. (It's probably best if you just give the channel to the consumer module so expensive message preparation logic can be skipped in case the channel is not even set.)

There would be a single command (like you said) listing all event types from the user side and where you can set the channel for these events. I could imagine that ?!logs list all set channels and available event types, ?!logs <event name> [channel] would set the channel, and omitting the channel would delete the entry.

Excuse me for the late response in case that you've already implemented some now redundant logic but I really just forgot about your comment.

[ElementalMP4]

I see I see, my bad I mistook that one :kek:

So if I understand correctly, the logger module will get called from somewhere else inside botler, and then send messages to the appropriate channels, as well as holding the command to set up log channels and list events etc.

Regarding the .getLogger('event-name') method you outlined, would it be necessary to attach some kind of guild ID to that, and then if no logging channel for that event is found with that corresponding guild ID the method can return null or undefined to the caller. If the logger is not null, then another method called .logMessage(<Discord embed>) which belongs to the logger object you just acquired can be used to send the final message

Also no worries, I've been out of action the past couple of days anyway so I haven't been able to do a lot

[Jet132]

You would probably provide the guild to a method of the given logger. The logger module first needs to know which event types exist. That's why you first need to register the event type. I'd at that point just return an object representing that type that has a sendLog(guild, message) method and a hasChannel(guild) method.

[ElementalMP4]

I'll give it some thought, that seems like a doable system.
I'll get back to you when I have something working