liz/PluralKit
liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add logging/metrics for error *messages*

Browse Source
This commit is contained in:
Ske 2020-11-16 10:07:57 +01:00
parent 6fb979e74d
commit e24b5e3529
2 changed files with 48 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
PluralKit.Bot/BotMetrics.cs
View File

@ -23,6 +23,7 @@ namespace PluralKit.Bot
public static TimerOptions ProxyMembersQueryTime => new TimerOptions { Name = "Proxy member query duration", Context = "Bot", RateUnit = TimeUnit.Seconds, DurationUnit = TimeUnit.Seconds, MeasurementUnit = Unit.Calls }; public static TimerOptions ProxyMembersQueryTime => new TimerOptions { Name = "Proxy member query duration", Context = "Bot", RateUnit = TimeUnit.Seconds, DurationUnit = TimeUnit.Seconds, MeasurementUnit = Unit.Calls };
public static TimerOptions DiscordApiRequests => new TimerOptions { Name = "Discord API requests", MeasurementUnit = Unit.Requests, Context = "Bot"}; public static TimerOptions DiscordApiRequests => new TimerOptions { Name = "Discord API requests", MeasurementUnit = Unit.Requests, Context = "Bot"};
public static MeterOptions BotErrors => new MeterOptions { Name = "Bot errors", MeasurementUnit = Unit.Errors, RateUnit = TimeUnit.Seconds, Context = "Bot"}; public static MeterOptions BotErrors => new MeterOptions { Name = "Bot errors", MeasurementUnit = Unit.Errors, RateUnit = TimeUnit.Seconds, Context = "Bot"};
public static MeterOptions ErrorMessagesSent => new MeterOptions { Name = "Error messages sent", MeasurementUnit = Unit.Errors, RateUnit = TimeUnit.Seconds, Context = "Bot"};
public static TimerOptions EventsHandled => new TimerOptions { Name = "Events handled", MeasurementUnit = Unit.Errors, RateUnit = TimeUnit.Seconds, DurationUnit = TimeUnit.Seconds, Context = "Bot"}; public static TimerOptions EventsHandled => new TimerOptions { Name = "Events handled", MeasurementUnit = Unit.Errors, RateUnit = TimeUnit.Seconds, DurationUnit = TimeUnit.Seconds, Context = "Bot"};
} }
} }

48
PluralKit.Bot/Services/ErrorMessageService.cs
View File

@ -1,10 +1,15 @@
using System.Collections.Concurrent; using System;
using System.Collections.Concurrent;
using System.Threading.Tasks; using System.Threading.Tasks;
using App.Metrics;
using DSharpPlus.Entities; using DSharpPlus.Entities;
using NodaTime; using NodaTime;
using Serilog;
namespace PluralKit.Bot namespace PluralKit.Bot
{ {
public class ErrorMessageService public class ErrorMessageService
@ -12,16 +17,24 @@ namespace PluralKit.Bot
private static readonly Duration MinErrorInterval = Duration.FromSeconds(10); private static readonly Duration MinErrorInterval = Duration.FromSeconds(10);
private readonly ConcurrentDictionary<ulong, Instant> _lastErrorInChannel = new ConcurrentDictionary<ulong, Instant>(); private readonly ConcurrentDictionary<ulong, Instant> _lastErrorInChannel = new ConcurrentDictionary<ulong, Instant>();
private readonly IMetrics _metrics;
private readonly ILogger _logger;
public ErrorMessageService(IMetrics metrics, ILogger logger)
{
_metrics = metrics;
_logger = logger;
}
public async Task SendErrorMessage(DiscordChannel channel, string errorId) public async Task SendErrorMessage(DiscordChannel channel, string errorId)
{ {
var now = SystemClock.Instance.GetCurrentInstant(); var now = SystemClock.Instance.GetCurrentInstant();
if (_lastErrorInChannel.TryGetValue(channel.Id, out var lastErrorTime)) if (!ShouldSendErrorMessage(channel, now))
{ {
var interval = now - lastErrorTime; _logger.Warning("Rate limited sending error message to {ChannelId} with error code {ErrorId}", channel.Id, errorId);
if (interval < MinErrorInterval) _metrics.Measure.Meter.Mark(BotMetrics.ErrorMessagesSent, "throttled");
return; return;
} }
_lastErrorInChannel[channel.Id] = now;
var embed = new DiscordEmbedBuilder() var embed = new DiscordEmbedBuilder()
.WithColor(new DiscordColor(0xE74C3C)) .WithColor(new DiscordColor(0xE74C3C))
@ -29,7 +42,32 @@ namespace PluralKit.Bot
.WithDescription("For support, please send the error code above in **#bug-reports-and-errors** on **[the support server *(click to join)*](https://discord.gg/PczBt78)** with a description of what you were doing at the time.") .WithDescription("For support, please send the error code above in **#bug-reports-and-errors** on **[the support server *(click to join)*](https://discord.gg/PczBt78)** with a description of what you were doing at the time.")
.WithFooter(errorId) .WithFooter(errorId)
.WithTimestamp(now.ToDateTimeOffset()); .WithTimestamp(now.ToDateTimeOffset());
try
{
await channel.SendMessageAsync($"> **Error code:** `{errorId}`", embed: embed.Build()); await channel.SendMessageAsync($"> **Error code:** `{errorId}`", embed: embed.Build());
_logger.Information("Sent error message to {ChannelId} with error code {ErrorId}", channel.Id, errorId);
_metrics.Measure.Meter.Mark(BotMetrics.ErrorMessagesSent, "sent");
}
catch (Exception e)
{
_logger.Error(e, "Error sending error message to {ChannelId}", channel.Id);
_metrics.Measure.Meter.Mark(BotMetrics.ErrorMessagesSent, "failed");
throw;
}
}
private bool ShouldSendErrorMessage(DiscordChannel channel, Instant now)
{
if (_lastErrorInChannel.TryGetValue(channel.Id, out var lastErrorTime))
{
var interval = now - lastErrorTime;
if (interval < MinErrorInterval)
return false;
}
_lastErrorInChannel[channel.Id] = now;
return true;
} }
} }
} }