-
Notifications
You must be signed in to change notification settings - Fork 74
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Don't log NotLoggedInException - Don't log FileNotFoundException - Don't log DirectoryNotFoundException - Only init one version of sentry - Only report 50% of errors. This should reduce volumes
- Loading branch information
Showing
5 changed files
with
123 additions
and
62 deletions.
There are no files selected for viewing
2 changes: 2 additions & 0 deletions
2
Shoko.Server/Providers/AniDB/UDP/Exceptions/NotLoggedInException.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,9 @@ | ||
| using System; | ||
| using Shoko.Server.Services.ErrorHandling; | ||
|
|
||
| namespace Shoko.Server.Providers.AniDB.UDP.Exceptions; | ||
|
|
||
| [SentryIgnore] | ||
| public class NotLoggedInException : Exception | ||
| { | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| using System; | ||
|
|
||
| namespace Shoko.Server.Services.ErrorHandling; | ||
|
|
||
| [AttributeUsage(AttributeTargets.Class)] | ||
| public class SentryIgnoreAttribute : Attribute | ||
| { | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Diagnostics; | ||
| using System.IO; | ||
| using System.Reflection; | ||
| using NLog; | ||
| using Sentry; | ||
| using Shoko.Server.Settings; | ||
| using Shoko.Server.Utilities; | ||
| using Constants = Shoko.Server.Server.Constants; | ||
|
|
||
| #nullable enable | ||
|
|
||
| namespace Shoko.Server.Services.ErrorHandling; | ||
|
|
||
| public class SentryInit : IDisposable | ||
| { | ||
| private readonly ISettingsProvider _settingsProvider; | ||
| private IDisposable? _sentry; | ||
|
|
||
| public SentryInit(ISettingsProvider settingsProvider) | ||
| { | ||
| _settingsProvider = settingsProvider; | ||
| } | ||
|
|
||
| public void Init() | ||
| { | ||
| if (_sentry is not null) | ||
| return; | ||
|
|
||
| var settings = _settingsProvider.GetSettings(); | ||
|
|
||
| // Only try to set up Sentry if the user DID NOT OPT __OUT__. | ||
| if (settings.SentryOptOut || !Constants.SentryDsn.StartsWith("https://")) | ||
| return; | ||
|
|
||
| // Get the release and extra info from the assembly. | ||
| var extraInfo = Utils.GetApplicationExtraVersion(); | ||
|
|
||
| // Only initialize the SDK if we're not on a debug build. | ||
| // | ||
| // If the release channel is not set or if it's set to "debug" then | ||
| // it's considered to be a debug build. | ||
| if (extraInfo.TryGetValue("channel", out var environment) && environment != "debug") | ||
| Init(environment, extraInfo); | ||
| } | ||
|
|
||
| private void Init(string environment, Dictionary<string, string> extraInfo) | ||
| { | ||
| _sentry = SentrySdk.Init(opts => | ||
| { | ||
| // Assign the DSN key and release version. | ||
| opts.Dsn = Constants.SentryDsn; | ||
| opts.Environment = environment; | ||
| opts.Release = Utils.GetApplicationVersion(); | ||
|
|
||
| // Conditionally assign the extra info if they're included in the assembly. | ||
| if (extraInfo.TryGetValue("commit", out var gitCommit)) | ||
| opts.DefaultTags.Add("commit", gitCommit); | ||
| if (extraInfo.TryGetValue("tag", out var gitTag)) | ||
| opts.DefaultTags.Add("commit.tag", gitTag); | ||
|
|
||
| // Append the release channel for the release on non-stable branches. | ||
| if (environment != "stable") | ||
| opts.Release += string.IsNullOrEmpty(gitCommit) ? $"-{environment}" : $"-{environment}-{gitCommit[0..7]}"; | ||
|
|
||
| opts.SampleRate = 0.5f; | ||
|
|
||
| opts.BeforeSend += BeforeSentrySend; | ||
| }); | ||
|
|
||
| LogManager.Configuration.AddSentry(o => | ||
| { | ||
| o.MinimumEventLevel = LogLevel.Fatal; | ||
| }); | ||
| } | ||
|
|
||
| private SentryEvent? BeforeSentrySend(SentryEvent arg) | ||
| { | ||
| if (arg.Exception is FileNotFoundException) | ||
| return null; | ||
|
|
||
| if (arg.Exception is DirectoryNotFoundException) | ||
| return null; | ||
|
|
||
| if (arg.Exception?.GetType().GetCustomAttribute<SentryIgnoreAttribute>() is not null) | ||
| return null; | ||
|
|
||
| return arg; | ||
| } | ||
|
|
||
| public void Dispose() | ||
| { | ||
| _sentry?.Dispose(); | ||
| } | ||
| } |