Moderation Logs
Plugin name: modlog
The modlog plugin provides a mechanism for logging various events and actions to one or more channels. The intention of the modlog is to provide a private feed of server events that administrators and moderators can use to better monitor and audit users actions. The modlog is extremely configurable and thus fairly complex.
Commands
| Name | Description | Default Level | Usage |
|---|---|---|---|
!modlog hush | Disables tracking of message deletes in modlog. | Administrator | !modlog hush |
!modlog unhush | Re-enables tracking of message deletes. | Administrator | !modlog unhush |
Configuration Options
| Option | Description | Type | Default |
|---|---|---|---|
| ignored_users | A list of user IDs which are ignored in the modlog. This is useful for ignoring bots that regularly delete or edit their messages | list(snowflake) | empty |
| ignored_channels | A list of channel IDs which are ignored in the modlog. This is useful for ignoring private or high-activity channels | list(snowflake) | empty |
| new_member_threshold | The number of seconds an account is considered new. | int | 900 (15 minutes) |
| channels | Mapping of channel names or IDs to ModLog configurations | dict | empty |
| custom | Change the logging format if the CUSTOM flag is on for the guild. Only available for PLAIN mode logs. | dict | empty |
ModLog Configuration
| Option | Description | Type | Default |
|---|---|---|---|
| include | List of modlog actions to include. If empty this includes all mod log actions. | list | empty |
| exclude | List of modlog actions to exclude. If empty this excludes no mod log actions. | list | empty |
| mode | Type of log output. Options: PLAIN, PRETTY. Pretty mode uses embedded messages. | str | PLAIN |
| exclude_category | A list of category IDs which are ignored in the modlog. | list(snowflake) | empty |
| timestamps | Show timestamps with the logs in PLAIN mode. | bool | false |
| timezone | The timezone that timestamps are rendered in in PLAIN mode. Supported timezones | timezone | US/Eastern |
info
If an action is in both include and exclude lists, the action will be excluded.
Actions
Server actions
| Action | Description |
|---|---|
| CHANNEL_CREATE | A channel is created |
| CHANNEL_DELETE | A channel is deleted |
| CATEGORY_CREATE | A category is created |
| CATEGORY_DELETE | A category is deleted |
| GUILD_MEMBER_ADD | A member joins |
| GUILD_MEMBER_REMOVE | A member leaves |
| GUILD_ROLE_CREATE | A role is created |
| GUILD_ROLE_DELETE | A role is deleted |
| SLOWMODE_ON | Slowmode is enabled or altered in a channel |
| SLOWMODE_OFF | Slowmode is disabled in a channel |
| BOT_DEBUG | A command failed |
User actions
| Action | Description |
|---|---|
| COMMAND_USED | A user uses a HepBoat command |
| ADD_NICK | A user adds a nickname |
| CHANGE_NICK | A user changes their nickname |
| CHANGE_USERNAME | A user changes their username |
| RMV_NICK | A user removes a nickname |
| GUILD_MEMBER_ROLES_ADD | A role is added to a user |
| GUILD_MEMBER_ROLES_RMV | A role is removed from a user |
| MEMBER_RESTORE | A user rejoined and had their roles/nickname/etc restored |
| MEMBER_ROLE_ADD | A role is added to a user by command |
| MEMBER_ROLE_REMOVE | A role is removed from a user by command |
| MEMBER_ADD_NICK | A nickname is assigned to a user by command |
| MEMBER_RMV_NICK | A nickname is removed from a user by command |
| MEMBER_CHANGE_NICK | A nickname is change for a user by command |
| VOICE_CHANNEL_JOIN | A user joins a voice channel |
| VOICE_CHANNEL_LEAVE | A user leaves a voice channel |
| VOICE_CHANNEL_MOVE | A user moves voice channels |
Message actions
| Action | Description |
|---|---|
| MESSAGE_EDIT | A message is edited |
| MESSAGE_DELETE | A message is deleted |
| MESSAGE_DELETE_BULK | Multiple messages are deleted |
Spam actions
| Action | Description |
|---|---|
| CENSOR_DEBUG | A user triggered too many censor violations |
| CENSORED | A user posted a message that was censored by the bot |
| CHANGE_NICK_BLOCKED | A nick change is blocked |
| SPAM_DEBUG | A user triggered spam protection |
Infraction actions
| Action | Description |
|---|---|
| MEMBER_MUTED | A mute is added for a user |
| MEMBER_UNMUTED | A mute is removed for a user |
| MEMBER_HARD_MUTED | A hard mute is added for a user |
| MEMBER_HARD_UNMUTED | A hard mute is removed for a user |
| MEMBER_HARD_TEMP_MUTED | A hard temp-mute is added for a user |
| MEMBER_TEMP_MUTED | A temp-mute is added for a user |
| MEMBER_TEMPMUTE_EXPIRE | A temp-mute expired for a user |
| MEMBER_KICK | A member is kicked from the guild |
| MEMBER_BAN | A ban (with a reason) is added for a user |
| MEMBER_SOFTBAN | A softban is added for a user |
| MEMBER_CLEANBAN | A cleanban is added for a user |
| MEMBER_TEMPBAN | A tempban is added for a user |
| MEMBER_TEMPBAN_EXPIRE | A tempban expired for a user |
| MEMBER_TEMPROLE_EXPIRE | A temprole expired for a user |
| MEMBER_WARNED | A warning is added for a user |
| ADD_NOTE | A note added on a user |
| GUILD_BAN_ADD | A ban is added to the guild |
| GUILD_BAN_REMOVE | A ban is removed from the guild |
| RAID | Potential raid detected |
| RAID_MEMBER | A raid action is applied to user |
Configuration Example
plugins:
modlog:
channels:
289494042000228352:
mode: pretty
include: []
exclude: [MESSAGE_EDIT]
ignored_users: [84912325282254848]
new_member_threshold: 86400
Custom Mod Log Format
To enable custom plain mode modlogs, please contact a HepBoat Global Administrator in the support server with a compelling reason after you have set up your server.
caution
If configured improperly, your logs may be missing and lost, and certain commands may not work.