// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. // See the LICENCE file in the repository root for full licence text. #nullable enable using System; using System.Diagnostics; using System.IO; using System.Net; using osu.Framework.Bindables; using osu.Framework.Logging; using osu.Game.Online.API.Requests.Responses; using Sentry; namespace osu.Game.Utils { /// /// Report errors to sentry. /// public class SentryLogger : IDisposable { private Exception? lastException; private IBindable? localUser; private readonly IDisposable? sentrySession; public SentryLogger(OsuGame game) { sentrySession = SentrySdk.Init(options => { // Not setting the dsn will completely disable sentry. if (game.IsDeployedBuild) options.Dsn = "https://ad9f78529cef40ac874afb95a9aca04e@sentry.ppy.sh/2"; options.AutoSessionTracking = true; options.IsEnvironmentUser = false; options.Release = game.Version; }); Logger.NewEntry += processLogEntry; } ~SentryLogger() => Dispose(false); public void AttachUser(IBindable user) { Debug.Assert(localUser == null); localUser = user.GetBoundCopy(); localUser.BindValueChanged(u => { SentrySdk.ConfigureScope(scope => scope.User = new User { Username = u.NewValue.Username, Id = u.NewValue.Id.ToString(), }); }, true); } private void processLogEntry(LogEntry entry) { if (entry.Level < LogLevel.Verbose) return; var exception = entry.Exception; if (exception != null) { if (!shouldSubmitException(exception)) return; // since we let unhandled exceptions go ignored at times, we want to ensure they don't get submitted on subsequent reports. if (lastException != null && lastException.Message == exception.Message && exception.StackTrace.StartsWith(lastException.StackTrace, StringComparison.Ordinal)) return; lastException = exception; SentrySdk.CaptureEvent(new SentryEvent(exception) { Message = entry.Message, Level = getSentryLevel(entry.Level), }); } else SentrySdk.AddBreadcrumb(entry.Message, entry.Target.ToString(), "navigation"); } private SentryLevel? getSentryLevel(LogLevel entryLevel) { switch (entryLevel) { case LogLevel.Debug: return SentryLevel.Debug; case LogLevel.Verbose: return SentryLevel.Info; case LogLevel.Important: return SentryLevel.Warning; case LogLevel.Error: return SentryLevel.Error; default: throw new ArgumentOutOfRangeException(nameof(entryLevel), entryLevel, null); } } private bool shouldSubmitException(Exception exception) { switch (exception) { case IOException ioe: // disk full exceptions, see https://stackoverflow.com/a/9294382 const int hr_error_handle_disk_full = unchecked((int)0x80070027); const int hr_error_disk_full = unchecked((int)0x80070070); if (ioe.HResult == hr_error_handle_disk_full || ioe.HResult == hr_error_disk_full) return false; break; case WebException we: switch (we.Status) { // more statuses may need to be blocked as we come across them. case WebExceptionStatus.Timeout: return false; } break; } return true; } #region Disposal public void Dispose() { Dispose(true); GC.SuppressFinalize(this); } protected virtual void Dispose(bool isDisposing) { Logger.NewEntry -= processLogEntry; sentrySession?.Dispose(); } #endregion } }