github/lidarr
1
0
Fork 0
mirror of https://github.com/lidarr/lidarr.git synced 2025-08-14 02:37:08 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Fixed: More improvements to sentry logging (#669)

Browse source 
* Only add the exception message for some types

* Cleanse exception messages also

* Don't put exception message into log

It breaks the sentry grouping

* Combine the two calculations of fingerprint
This commit is contained in:
ta264 2019-03-13 23:10:58 +00:00 • committed by Qstick
commit 1c7ded859b
13 changed files with 36 additions and 72 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/Lidarr.Api.V1/Indexers/ReleaseModule.cs
View file

@ -69,7 +69,7 @@ namespace Lidarr.Api.V1.Indexers
}
catch (ReleaseDownloadException ex)
{
_logger.Error(ex, ex.Message);
_logger.Error(ex, "Getting release from indexer failed");
throw new NzbDroneClientException(HttpStatusCode.Conflict, "Getting release from indexer failed");
}
@ -102,7 +102,7 @@ namespace Lidarr.Api.V1.Indexers
}
catch (Exception ex)
{
_logger.Error(ex, "Album search failed: " + ex.Message);
_logger.Error(ex, "Album search failed");
}
return new List<ReleaseResource>();
@ -119,7 +119,7 @@ namespace Lidarr.Api.V1.Indexers
}
catch (Exception ex)
{
_logger.Error(ex, "Artist search failed: " + ex.Message);
_logger.Error(ex, "Artist search failed");
}
return new List<ReleaseResource>();

2
src/NzbDrone.Common/Instrumentation/Sentry/SentryCleanser.cs
View file

@ -1,6 +1,5 @@
using System;
using System.Linq;
using NzbDrone.Common.EnvironmentInfo;
using Sentry;
using Sentry.Protocol;
@ -28,6 +27,7 @@ namespace NzbDrone.Common.Instrumentation.Sentry
foreach (var exception in sentryEvent.SentryExceptions)
{
exception.Value = CleanseLogMessage.Cleanse(exception.Value);
foreach (var frame in exception.Stacktrace.Frames)
{
frame.FileName = ShortenPath(frame.FileName);

71
src/NzbDrone.Common/Instrumentation/Sentry/SentryTarget.cs
View file

@ -9,10 +9,8 @@ using NLog;
using NLog.Common;
using NLog.Targets;
using NzbDrone.Common.EnvironmentInfo;
using System.Globalization;
using Sentry;
using Sentry.Protocol;
using NzbDrone.Common.Extensions;
namespace NzbDrone.Common.Instrumentation.Sentry
{
@ -49,6 +47,13 @@ namespace NzbDrone.Common.Instrumentation.Sentry
// Fix openflixr being stupid with permissions
"openflixr"
};
// exception types in this list will additionally have the exception message added to the
// sentry fingerprint. Make sure that this message doesn't vary by exception
// (e.g. containing a path or a url) so that the sentry grouping is sensible
private static readonly HashSet<string> IncludeExceptionMessageTypes = new HashSet<string> {
"SQLiteException"
};
private static readonly IDictionary<LogLevel, SentryLevel> LoggingLevelMap = new Dictionary<LogLevel, SentryLevel>
{
@ -137,22 +142,25 @@ namespace NzbDrone.Common.Instrumentation.Sentry
var fingerPrint = new List<string>
{
logEvent.Level.Ordinal.ToString(),
logEvent.LoggerName
logEvent.Level.ToString(),
logEvent.LoggerName,
logEvent.Message
};
var ex = logEvent.Exception;
if (ex != null)
{
var exception = ex.GetType().Name;
fingerPrint.Add(ex.GetType().FullName);
fingerPrint.Add(ex.TargetSite.ToString());
if (ex.InnerException != null)
{
exception += ex.InnerException.GetType().Name;
fingerPrint.Add(ex.InnerException.GetType().FullName);
}
else if (IncludeExceptionMessageTypes.Contains(ex.GetType().Name))
{
fingerPrint.Add(ex?.Message);
}
fingerPrint.Add(exception);
}
return fingerPrint;
@ -234,51 +242,8 @@ namespace NzbDrone.Common.Instrumentation.Sentry
Message = logEvent.FormattedMessage,
};
var sentryFingerprint = new List<string> {
logEvent.Level.ToString(),
logEvent.LoggerName,
logEvent.Message
};
sentryEvent.SetExtras(extras);
if (logEvent.Exception != null)
{
sentryFingerprint.Add(logEvent.Exception.GetType().FullName);
sentryFingerprint.Add(logEvent.Exception.TargetSite.ToString());
// only try to use the exeception message to fingerprint if there's no inner
// exception and the message is short, otherwise we're in danger of getting a
// stacktrace which will break the grouping
if (logEvent.Exception.InnerException == null)
{
string message = null;
// bodge to try to get the exception message in English
// https://stackoverflow.com/questions/209133/exception-messages-in-english
// There may still be some localization but this is better than nothing.
var t = new Thread(() => {
message = logEvent.Exception?.Message;
});
t.CurrentCulture = CultureInfo.InvariantCulture;
t.CurrentUICulture = CultureInfo.InvariantCulture;
t.Start();
t.Join();
if (message.IsNotNullOrWhiteSpace() && message.Length < 200)
{
// Windows gives a trailing '.' for NullReferenceException but mono doesn't
sentryFingerprint.Add(message.TrimEnd('.'));
}
}
}
if (logEvent.Properties.ContainsKey("Sentry"))
{
sentryFingerprint = ((string[])logEvent.Properties["Sentry"]).ToList();
}
sentryEvent.SetFingerprint(sentryFingerprint);
sentryEvent.SetFingerprint(fingerPrint);
// this can't be in the constructor as at that point OsInfo won't have
// populated these values yet

2
src/NzbDrone.Core/Download/Clients/Deluge/Deluge.cs
View file

@ -210,7 +210,7 @@ namespace NzbDrone.Core.Download.Clients.Deluge
}
catch (DownloadClientAuthenticationException ex)
{
_logger.Error(ex, ex.Message);
_logger.Error(ex, "Unable to authenticate");
return new NzbDroneValidationFailure("Password", "Authentication failed");
}
catch (WebException ex)

4
src/NzbDrone.Core/Download/Clients/DownloadStation/TorrentDownloadStation.cs
View file

@ -339,7 +339,7 @@ namespace NzbDrone.Core.Download.Clients.DownloadStation
}
catch (DownloadClientAuthenticationException ex) // User could not have permission to access to downloadstation
{
_logger.Error(ex, ex.Message);
_logger.Error(ex, "Unable to authenticate");
return new NzbDroneValidationFailure(string.Empty, ex.Message);
}
catch (Exception ex)
@ -357,7 +357,7 @@ namespace NzbDrone.Core.Download.Clients.DownloadStation
}
catch (DownloadClientAuthenticationException ex)
{
_logger.Error(ex, ex.Message);
_logger.Error(ex, "Unable to authenticate");
return new NzbDroneValidationFailure("Username", "Authentication failure")
{
DetailedDescription = $"Please verify your username and password. Also verify if the host running Lidarr isn't blocked from accessing {Name} by WhiteList limitations in the {Name} configuration."

4
src/NzbDrone.Core/Download/Clients/DownloadStation/UsenetDownloadStation.cs
View file

@ -238,7 +238,7 @@ namespace NzbDrone.Core.Download.Clients.DownloadStation
}
catch (DownloadClientAuthenticationException ex) // User could not have permission to access to downloadstation
{
_logger.Error(ex, ex.Message);
_logger.Error(ex, "Unable to authenticate");
return new NzbDroneValidationFailure(string.Empty, ex.Message);
}
catch (Exception ex)
@ -256,7 +256,7 @@ namespace NzbDrone.Core.Download.Clients.DownloadStation
}
catch (DownloadClientAuthenticationException ex)
{
_logger.Error(ex, ex.Message);
_logger.Error(ex, "Unable to authenticate");
return new NzbDroneValidationFailure("Username", "Authentication failure")
{
DetailedDescription = $"Please verify your username and password. Also verify if the host running Lidarr isn't blocked from accessing {Name} by WhiteList limitations in the {Name} configuration."

4
src/NzbDrone.Core/Download/Clients/Hadouken/Hadouken.cs
View file

@ -160,7 +160,7 @@ namespace NzbDrone.Core.Download.Clients.Hadouken
}
catch (DownloadClientAuthenticationException ex)
{
_logger.Error(ex.Message, ex);
_logger.Error(ex, "Unable to authenticate");
return new NzbDroneValidationFailure("Password", "Authentication failed");
}
@ -176,7 +176,7 @@ namespace NzbDrone.Core.Download.Clients.Hadouken
}
catch (Exception ex)
{
_logger.Error(ex, ex.Message);
_logger.Error(ex, "Unable to validate");
return new NzbDroneValidationFailure(String.Empty, "Failed to get the list of torrents: " + ex.Message);
}

2
src/NzbDrone.Core/Download/Clients/QBittorrent/QBittorrent.cs
View file

@ -269,7 +269,7 @@ namespace NzbDrone.Core.Download.Clients.QBittorrent
}
catch (DownloadClientAuthenticationException ex)
{
_logger.Error(ex, ex.Message);
_logger.Error(ex, "Unable to authenticate");
return new NzbDroneValidationFailure("Username", "Authentication failure")
{
DetailedDescription = "Please verify your username and password."

2
src/NzbDrone.Core/Download/Clients/Sabnzbd/Sabnzbd.cs
View file

@ -384,7 +384,7 @@ namespace NzbDrone.Core.Download.Clients.Sabnzbd
}
catch (Exception ex)
{
_logger.Error(ex, ex.Message);
_logger.Error(ex, "Unable to authenticate");
return new ValidationFailure("Host", "Unable to connect to SABnzbd");
}
}

4
src/NzbDrone.Core/Download/Clients/Transmission/TransmissionBase.cs
View file

@ -200,7 +200,7 @@ namespace NzbDrone.Core.Download.Clients.Transmission
}
catch (DownloadClientAuthenticationException ex)
{
_logger.Error(ex, ex.Message);
_logger.Error(ex, "Unable to authenticate");
return new NzbDroneValidationFailure("Username", "Authentication failure")
{
DetailedDescription = string.Format("Please verify your username and password. Also verify if the host running Lidarr isn't blocked from accessing {0} by WhiteList limitations in the {0} configuration.", Name)
@ -208,7 +208,7 @@ namespace NzbDrone.Core.Download.Clients.Transmission
}
catch (DownloadClientUnavailableException ex)
{
_logger.Error(ex, ex.Message);
_logger.Error(ex, "Unable to connect to transmission");
return new NzbDroneValidationFailure("Host", "Unable to connect")
{
DetailedDescription = "Please verify the hostname and port."

2
src/NzbDrone.Core/Download/Clients/uTorrent/UTorrent.cs
View file

@ -241,7 +241,7 @@ namespace NzbDrone.Core.Download.Clients.UTorrent
}
catch (DownloadClientAuthenticationException ex)
{
_logger.Error(ex, ex.Message);
_logger.Error(ex, "Unable to authenticate");
return new NzbDroneValidationFailure("Username", "Authentication failure")
{
DetailedDescription = "Please verify your username and password."

2
src/NzbDrone.Core/Extras/Metadata/MetadataService.cs
View file

@ -462,7 +462,7 @@ namespace NzbDrone.Core.Extras.Metadata
}
catch (Exception ex)
{
_logger.Error(ex, "Couldn't download image {0} for {1}. {2}", image.Url, artist, ex.Message);
_logger.Error(ex, "Couldn't download image {0} for {1}", image.Url, artist);
}
}

3
src/NzbDrone.Core/Music/AddArtistService.cs
View file

@ -72,8 +72,7 @@ namespace NzbDrone.Core.Music
catch (Exception ex)
{
// Catch Import Errors for now until we get things fixed up
_logger.Debug("Failed to import id: {0} - {1}", s.Metadata.Value.ForeignArtistId, s.Metadata.Value.Name);
_logger.Error(ex, ex.Message);
_logger.Error(ex, "Failed to import id: {0} - {1}", s.Metadata.Value.ForeignArtistId, s.Metadata.Value.Name);
}
}