Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include framework configuration in sentry output #19909

Merged
merged 3 commits into from
Aug 26, 2022
Merged

Include framework configuration in sentry output #19909

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c86a75a
Update `OsuConfigManager` in line with `ConfigManager` logging changes
peppy Aug 22, 2022
22072ee
Include framework configuration in sentry output
peppy Aug 22, 2022
17a1280
Merge branch 'master' into framework-ini-in-sentry
smoogipoo Aug 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 8 additions & 13 deletions osu.Game/Configuration/OsuConfigManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,8 @@
#nullable disable

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Globalization;
using System.Linq;
using osu.Framework.Configuration;
using osu.Framework.Configuration.Tracking;
using osu.Framework.Extensions;
Expand All @@ -31,6 +29,12 @@ namespace osu.Game.Configuration
[ExcludeFromDynamicCompile]
public class OsuConfigManager : IniConfigManager<OsuSetting>
{
public OsuConfigManager(Storage storage)
: base(storage)
{
Migrate();
}

protected override void InitialiseDefaults()
{
// UI/selection defaults
Expand Down Expand Up @@ -172,12 +176,9 @@ protected override void InitialiseDefaults()
SetDefault(OsuSetting.LastProcessedMetadataId, -1);
}

public IDictionary<OsuSetting, string> GetLoggableState() =>
new Dictionary<OsuSetting, string>(ConfigStore.Where(kvp => !keyContainsPrivateInformation(kvp.Key)).ToDictionary(kvp => kvp.Key, kvp => kvp.Value.ToString()));

private static bool keyContainsPrivateInformation(OsuSetting argKey)
protected override bool CheckLookupContainsPrivateInformation(OsuSetting lookup)
{
switch (argKey)
switch (lookup)
{
case OsuSetting.Token:
return true;
Expand All @@ -186,12 +187,6 @@ private static bool keyContainsPrivateInformation(OsuSetting argKey)
return false;
}

public OsuConfigManager(Storage storage)
: base(storage)
{
Migrate();
}

public void Migrate()
{
// arrives as 2020.123.0
Expand Down
5 changes: 3 additions & 2 deletions osu.Game/Utils/SentryLogger.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
using osu.Framework;
using osu.Framework.Allocation;
using osu.Framework.Bindables;
using osu.Framework.Configuration;
using osu.Framework.Logging;
using osu.Framework.Statistics;
using osu.Game.Beatmaps;
Expand Down Expand Up @@ -112,8 +113,8 @@ private void processLogEntry(LogEntry entry)

scope.Contexts[@"config"] = new
{
Game = game.Dependencies.Get<OsuConfigManager>().GetLoggableState()
// TODO: add framework config here. needs some consideration on how to expose.
Game = game.Dependencies.Get<OsuConfigManager>().GetCurrentConfigurationForLogging(),
Framework = game.Dependencies.Get<FrameworkConfigManager>().GetCurrentConfigurationForLogging(),
};

game.Dependencies.Get<RealmAccess>().Run(realm =>
Expand Down