Noi/RegexBot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Remove 'report' option in logging

Browse source 
The feature was previously meant for monitoring errors in a large public
bot instance, but is massively redundant and even annoying when using
as a self-hosted instance.
Besides, the information it did report was excessive and of little use.
This commit is contained in:
Noi 2022-07-27 19:23:49 -07:00
parent c77e4bd579
commit ebdaa6482c
9 changed files with 21 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
InstanceConfig.cs
View file

@ -19,7 +19,6 @@ class InstanceConfig {
/// List of assemblies to load, by file. Paths are always relative to the bot directory.
/// </summary>
internal IReadOnlyList<string> Assemblies { get; }
internal string InstanceLogTarget { get; }
public string? SqlHost { get; }
public string? SqlDatabase { get; }
@ -47,7 +46,6 @@ class InstanceConfig {
}
BotToken = ReadConfKey<string>(conf, nameof(BotToken), true);
InstanceLogTarget = ReadConfKey<string>(conf, nameof(InstanceLogTarget), true);
try {
Assemblies = Common.Utilities.LoadStringOrStringArray(conf[nameof(Assemblies)]).AsReadOnly();

2
ModuleLoader.cs
View file

@ -51,7 +51,7 @@ static class ModuleLoader {
newreport.Append($" {t.Name}");
newmods.Add((RegexbotModule)mod);
}
rb._svcLogging.DoLog(false, nameof(ModuleLoader), newreport.ToString());
rb._svcLogging.DoLog(nameof(ModuleLoader), newreport.ToString());
return newmods;
}
}

10
Program.cs
View file

@ -34,15 +34,13 @@ class Program {
AlwaysDownloadUsers = true
});
// Initialize services, load modules
_main = new RegexbotClient(cfg, client);
// Set up application close handler
Console.CancelKeyPress += Console_CancelKeyPress;
// TODO Set up unhandled exception handler
// send error notification to instance log channel, if possible
// And off we go.
// Proceed to connect
await _main.DiscordClient.LoginAsync(TokenType.Bot, cfg.BotToken);
await _main.DiscordClient.StartAsync();
await Task.Delay(-1);
@ -51,7 +49,7 @@ class Program {
private static void Console_CancelKeyPress(object? sender, ConsoleCancelEventArgs e) {
e.Cancel = true;
_main._svcLogging.DoLog(true, nameof(RegexBot), "Shutting down. Reason: Interrupt signal.");
_main._svcLogging.DoLog(nameof(RegexBot), "Shutting down.");
var finishingTasks = Task.Run(async () => {
// TODO periodic task service: stop processing, wait for all tasks to finish
@ -60,7 +58,7 @@ class Program {
});
if (!finishingTasks.Wait(5000))
_main._svcLogging.DoLog(false, nameof(RegexBot), "Could not disconnect properly. Exiting...");
_main._svcLogging.DoLog(nameof(RegexBot), "Warning: Normal shutdown is taking too long. Exiting now.");
Environment.Exit(0);
}
}

4
RegexbotClient.cs
View file

@ -30,8 +30,8 @@ public partial class RegexbotClient {
_svcCommonFunctions = new Services.CommonFunctions.CommonFunctionsService(this);
_svcEntityCache = new Services.EntityCache.EntityCacheService(this);
var ver = Assembly.GetExecutingAssembly().GetName().Version!;
_svcLogging.DoLog(true, nameof(RegexBot), $"{nameof(RegexBot)} v{ver:3} - https://github.com/NoiTheCat/RegexBot");
var ver = Assembly.GetExecutingAssembly().GetName().Version!.ToString(3);
_svcLogging.DoLog(nameof(RegexBot), $"{nameof(RegexBot)} v{ver} - https://github.com/NoiTheCat/RegexBot");
// Load externally defined functionality
Modules = ModuleLoader.Load(Config, this);

8
RegexbotModule.cs
View file

@ -73,16 +73,12 @@ public abstract class RegexbotModule {
/// <param name="message">The log message to send. Multi-line messages are acceptable.</param>
protected void Log(SocketGuild guild, string? message) {
var gname = guild.Name ?? $"Guild ID {guild.Id}";
Bot._svcLogging.DoLog(false, $"{gname}] [{Name}", message);
Bot._svcLogging.DoLog($"{gname}] [{Name}", message);
}
/// <summary>
/// Emits a log message to the bot console and, optionally, the logging webhook.
/// </summary>
/// <param name="message">The log message to send. Multi-line messages are acceptable.</param>
/// <param name="report">
/// Specifies if the log message should be sent to the reporting channel.
/// Only messages of very high importance should use this option.
/// </param>
protected void Log(string message, bool report = false) => Bot._svcLogging.DoLog(report, Name, message);
protected void Log(string message) => Bot._svcLogging.DoLog(Name, message);
}

8
Services/EntityCache/MessageCachingSubservice.cs
View file

@ -7,9 +7,9 @@ class MessageCachingSubservice {
// Hooked
public event EcMessageUpdateHandler? OnCachePreUpdate;
private readonly Action<string, bool> _log;
private readonly Action<string> _log;
internal MessageCachingSubservice(RegexbotClient bot, Action<string, bool> logMethod) {
internal MessageCachingSubservice(RegexbotClient bot, Action<string> logMethod) {
_log = logMethod;
bot.DiscordClient.MessageReceived += DiscordClient_MessageReceived;
bot.DiscordClient.MessageUpdated += DiscordClient_MessageUpdated;
@ -63,8 +63,8 @@ class MessageCachingSubservice {
try {
await (Task)handler.DynamicInvoke(oldMsg, newMsg)!;
} catch (Exception ex) {
_log($"Unhandled exception in {nameof(RegexbotClient.EcOnMessageUpdate)} handler '{handler.Method.Name}':", false);
_log(ex.ToString(), false);
_log($"Unhandled exception in {nameof(RegexbotClient.EcOnMessageUpdate)} handler '{handler.Method.Name}':\n"
+ ex.ToString());
}
}
}

35
Services/Logging/LoggingService.cs
View file

@ -1,5 +1,4 @@
using Discord;
using Discord.Webhook;
using System.Reflection;
using System.Text;
@ -9,11 +8,9 @@ namespace RegexBot.Services.Logging;
/// </summary>
class LoggingService : Service {
// NOTE: Service.Log's functionality is implemented here. DO NOT use within this class.
private readonly DiscordWebhookClient _instLogWebhook;
private readonly string? _logBasePath;
internal LoggingService(RegexbotClient bot) : base(bot) {
_instLogWebhook = new DiscordWebhookClient(bot.Config.InstanceLogTarget);
_logBasePath = Path.GetDirectoryName(Assembly.GetEntryAssembly()!.Location)
+ Path.DirectorySeparatorChar + "logs";
try {
@ -21,7 +18,7 @@ class LoggingService : Service {
Directory.GetFiles(_logBasePath);
} catch (Exception ex) when (ex is IOException or UnauthorizedAccessException) {
_logBasePath = null;
Output(Name, "Cannot create or access logging directory. File logging will be disabled.");
DoLog(Name, "Cannot create or access logging directory. File logging will be disabled.");
}
bot.DiscordClient.Log += DiscordClient_Log;
@ -33,9 +30,8 @@ class LoggingService : Service {
/// </summary>
private Task DiscordClient_Log(LogMessage arg) {
var msg = $"[{Enum.GetName(typeof(LogSeverity), arg.Severity)}] {arg.Message}";
if (arg.Exception != null) msg += "\n```\n" + arg.Exception.ToString() + "\n```";
if (arg.Exception != null) msg += arg.Exception.ToString();
var important = arg.Severity != LogSeverity.Info;
switch (arg.Message) { // Prevent webhook logs for these 'important' Discord.Net messages
case "Connecting":
case "Connected":
@ -44,15 +40,16 @@ class LoggingService : Service {
case "Disconnected":
case "Resumed previous session":
case "Failed to resume previous session":
important = false;
break;
}
DoLog(important, "Discord.Net", msg);
DoLog("Discord.Net", msg);
return Task.CompletedTask;
}
private void Output(string source, string message) {
// Hooked
internal void DoLog(string source, string? message) {
message ??= "(null)";
var now = DateTimeOffset.UtcNow;
var output = new StringBuilder();
var prefix = $"[{now:u}] [{source}] ";
@ -66,24 +63,4 @@ class LoggingService : Service {
File.AppendAllText(filename, outstr, Encoding.UTF8);
}
}
// Hooked
internal void DoLog(bool report, string source, string? message) {
message ??= "(null)";
Output(source, message);
if (report) Task.Run(() => ReportInstanceWebhook(source, message));
}
private async Task ReportInstanceWebhook(string source, string message) {
try {
EmbedBuilder e = new() {
Footer = new EmbedFooterBuilder() { Text = source },
Timestamp = DateTimeOffset.UtcNow,
Description = message
};
await _instLogWebhook.SendMessageAsync(embeds: new[] { e.Build() });
} catch (Exception ex) {
DoLog(false, Name, "Failed to send message to reporting channel: " + ex.Message);
}
}
}

4
Services/ModuleState/ModuleStateService.cs
View file

@ -75,8 +75,6 @@ class ModuleStateService : Service {
return false;
}
// TODO Guild-specific service options? If implemented, this is where to load them.
// Load moderator list
var mods = new EntityList(guildConf["Moderators"]!, true);
@ -94,7 +92,7 @@ class ModuleStateService : Service {
Log("Unhandled exception while initializing guild state for module:\n" +
$"Module: {module.Name} | " +
$"Guild: {guildId} ({BotClient.DiscordClient.GetGuild(guildId)?.Name ?? "unknown name"})\n" +
$"```\n{ex}\n```", true);
$"```\n{ex}\n```");
return false;
}
}

3
Services/Service.cs
View file

@ -17,6 +17,5 @@ internal abstract class Service {
/// Emits a log message.
/// </summary>
/// <param name="message">The log message to send. Multi-line messages are acceptable.</param>
/// <param name="report">Specify if the log message should be sent to a reporting channel.</param>
protected void Log(string message, bool report = false) => BotClient._svcLogging.DoLog(report, Name, message);
protected void Log(string message) => BotClient._svcLogging.DoLog(Name, message);
}