Add Sentry Error Tracking (#2670)

* Add Sentry Error Tracking

* Omit personally identifiable information and add additional sentry context

* Remove debug message

* Make sentry opt-out and add related notices and strings

Also add Minecraft Version to error context

* Update build to send release info to sentry

* Adjust sentry error tracking

- Send the user-friendly Minecraft Version in the error logs
- Capture exceptions in more parts of the application

We now capture exceptions from the following locations:
- Protocol18 (1.8+) Packet errors
- Errors during client initialization phase (When client is about to start, session keys are NEVER sent to sentry)

* Make Sentry DSN configurable and repository-specific

The Sentry DSN will automatically be filled out on the main repository through the Github Actions build.

* Update build-and-release.yml

Update sed command

* style: change variable name

nitpick, just to make it a little bit more descriptive

* Add Sentry branding in README.

* remove old code (merge conflict)
This commit is contained in:
breadbyte 2024-06-22 06:41:13 +08:00 committed by GitHub
parent 8756ff5b3c
commit 08551097c6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
11 changed files with 148 additions and 24 deletions

View file

@ -61,6 +61,7 @@ jobs:
run: |
echo '' >> ${{ env.assembly-info }}
echo "[assembly: AssemblyConfiguration(\"GitHub build ${{ github.run_number }}, built on ${{ env.date_dashed }} from commit ${{ env.commit }}\")]" >> ${{ env.assembly-info }}
sed -i -e 's|SentryDSN = "";|SentryDSN = "${{ secrets.SENTRY_DSN }}";|g' ${{ env.project-path }}/Program.cs
- name: Build Target
run: dotnet publish ${{ env.project-path }}.sln -f ${{ env.target-version }} -r ${{ matrix.target }} ${{ env.compile-flags }}
@ -177,6 +178,7 @@ jobs:
run: |
echo '' >> ${{ env.assembly-info }}
echo "[assembly: AssemblyConfiguration(\"GitHub build ${{ github.run_number }}, built on ${{ env.date_dashed }} from commit ${{ env.commit }}\")]" >> ${{ env.assembly-info }}
sed -i -e 's|SentryDSN = "";|SentryDSN = "${{ secrets.SENTRY_DSN }}";|g' ${{ env.project-path }}/Program.cs
- name: Build Target
run: dotnet publish ${{ env.project-path }}.sln -f ${{ env.target-version }} -r ${{ matrix.target }} ${{ env.compile-flags }}
@ -195,7 +197,17 @@ jobs:
filePath: ${{ env.target-out-path }}/mcc-${{ matrix.target }}.zip
assetName: ${{ env.PROJECT }}-${{ (contains(matrix.target, 'linux-x64') && 'linux.zip') || (contains(matrix.target, 'win-x86') && 'windows-x86.zip') || (contains(matrix.target, 'win-x64') && 'windows-x64.zip') || (contains(matrix.target, 'linux-arm64') && 'linux-arm64.zip') || (contains(matrix.target, 'osx-x64') && 'osx.zip') }}
tag: ${{ format('{0}-{1}', env.date, github.run_number) }}
- name: Sentry Release
uses: getsentry/action-release@v1.7.0
env:
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
SENTRY_ORG: ${{ secrets.SENTRY_ORG }}
SENTRY_PROJECT: ${{ secrets.SENTRY_PROJECT }}
with:
environment: production
dist: ${{ format('{0}-{1}', env.date, github.run_number) }}
determine-build:
runs-on: ubuntu-latest
strategy:

View file

@ -21,6 +21,7 @@ using MinecraftClient.Protocol.ProfileKey;
using MinecraftClient.Protocol.Session;
using MinecraftClient.Proxy;
using MinecraftClient.Scripting;
using Sentry;
using static MinecraftClient.Settings;
namespace MinecraftClient
@ -191,6 +192,33 @@ namespace MinecraftClient
Log.WarnEnabled = Config.Logging.WarningMessages;
Log.ErrorEnabled = Config.Logging.ErrorMessages;
// SENTRY: Send our client version and server version to Sentry
SentrySdk.ConfigureScope(scope =>
{
scope.SetTag("Protocol Version", protocolversion.ToString());
scope.SetTag("Minecraft Version", ProtocolHandler.ProtocolVersion2MCVer(protocolversion));
scope.SetTag("MCC Build", Program.BuildInfo == null ? "Debug" : Program.BuildInfo);
if (forgeInfo != null)
scope.SetTag("Forge Version", forgeInfo?.Version.ToString());
scope.Contexts["Server Information"] = new
{
ProtocolVersion = protocolversion,
MinecraftVersion = ProtocolHandler.ProtocolVersion2MCVer(protocolversion),
ForgeInfo = forgeInfo?.Version
};
scope.Contexts["Client Configuration"] = new
{
TerrainAndMovementsEnabled = terrainAndMovementsEnabled,
InventoryHandlingEnabled = inventoryHandlingEnabled,
EntityHandlingEnabled = entityHandlingEnabled
};
});
SentrySdk.StartSession();
/* Load commands from Commands namespace */
LoadCommands();
@ -588,6 +616,8 @@ namespace MinecraftClient
}
}
SentrySdk.EndSession();
if (!will_restart)
{
ConsoleInteractive.ConsoleReader.StopReadThread();

View file

@ -39,6 +39,7 @@
<PackageReference Include="Microsoft.CSharp" Version="4.7.0" />
<PackageReference Include="Microsoft.Windows.Compatibility" Version="7.0.3" />
<PackageReference Include="Samboy063.Tomlet" Version="5.0.1" />
<PackageReference Include="Sentry" Version="4.1.0" />
<PackageReference Include="SingleFileExtractor.Core" Version="1.0.1" />
<PackageReference Include="starksoft.aspen" Version="1.1.8">
<NoWarn>NU1701</NoWarn>

View file

@ -16,6 +16,7 @@ using MinecraftClient.Protocol.ProfileKey;
using MinecraftClient.Protocol.Session;
using MinecraftClient.Scripting;
using MinecraftClient.WinAPI;
using Sentry;
using Tomlet;
using static MinecraftClient.Settings;
using static MinecraftClient.Settings.ConsoleConfigHealper.ConsoleConfig;
@ -50,14 +51,31 @@ namespace MinecraftClient
public static readonly string? BuildInfo = null;
private static Tuple<Thread, CancellationTokenSource>? offlinePrompt = null;
private static IDisposable _sentrySdk;
private static bool useMcVersionOnce = false;
private static string settingsIniPath = "MinecraftClient.ini";
// [SENTRY]
// Setting this string to an empty string will disable Sentry
private const string SentryDSN = "";
/// <summary>
/// The main entry point of Minecraft Console Client
/// </summary>
static void Main(string[] args)
{
// [SENTRY] Initialize Sentry SDK only if the DSN is not empty
if (SentryDSN != string.Empty) {
_sentrySdk = SentrySdk.Init(options =>
{
options.Dsn = SentryDSN;
options.AutoSessionTracking = true;
options.IsGlobalModeEnabled = true;
options.EnableTracing = true;
options.SendDefaultPii = false;
});
}
Task.Run(() =>
{
// "ToLower" require "CultureInfo" to be initialized on first run, which can take a lot of time.
@ -139,6 +157,12 @@ namespace MinecraftClient
if (newlyGenerated)
ConsoleIO.WriteLineFormatted("§c" + Translations.mcc_settings_generated);
ConsoleIO.WriteLine(Translations.mcc_run_with_default_settings);
// Only show the Sentry message if the DSN is not empty
// as Sentry will not be initialized if the DSN is empty
if (SentryDSN != string.Empty) {
ConsoleIO.WriteLine(Translations.mcc_sentry_logging);
}
}
else if (!loadSucceed)
{
@ -182,6 +206,9 @@ namespace MinecraftClient
ConsoleIO.WriteLine(string.Format(Translations.mcc_help_us_translate, Settings.TranslationProjectUrl));
WriteBackSettings(true); // format
}
if (!Config.Main.Advanced.EnableSentry)
_sentrySdk.Dispose();
}
//Other command-line arguments
@ -632,6 +659,9 @@ namespace MinecraftClient
}
catch (Exception e)
{
// [SENTRY]
SentrySdk.CaptureException(e);
ConsoleIO.WriteLine(e.Message);
ConsoleIO.WriteLine(e.StackTrace ?? "");
HandleFailure(); // Other error

View file

@ -24,6 +24,7 @@ using MinecraftClient.Protocol.ProfileKey;
using MinecraftClient.Protocol.Session;
using MinecraftClient.Proxy;
using MinecraftClient.Scripting;
using Sentry;
using static MinecraftClient.Settings;
using static MinecraftClient.Settings.MainConfigHelper.MainConfig.GeneralConfig;
@ -370,6 +371,10 @@ namespace MinecraftClient.Protocol.Handlers
/// <returns>TRUE if the packet was processed, FALSE if ignored or unknown</returns>
internal bool HandlePacket(int packetId, Queue<byte> packetData)
{
// This copy is necessary because by the time we get to the catch block,
// the packetData queue will have been processed and the data will be lost
var _copy = packetData.ToArray();
try
{
switch (currentState)
@ -430,7 +435,7 @@ namespace MinecraftClient.Protocol.Handlers
World.StoreDimensionList(registryCodec);
break;
case ConfigurationPacketTypesIn.RemoveResourcePack:
if (dataTypes.ReadNextBool(packetData)) // Has UUID
dataTypes.ReadNextUUID(packetData); // UUID
@ -461,7 +466,7 @@ namespace MinecraftClient.Protocol.Handlers
innerException.InnerException is SocketException)
throw; //Thread abort or Connection lost rather than invalid data
throw new System.IO.InvalidDataException(
var exception = new System.IO.InvalidDataException(
string.Format(Translations.exception_packet_process,
packetPalette.GetIncomingTypeById(packetId),
packetId,
@ -469,6 +474,21 @@ namespace MinecraftClient.Protocol.Handlers
currentState == CurrentState.Login,
innerException.GetType()),
innerException);
SentrySdk.AddBreadcrumb(new Breadcrumb("S -> C Packet", "network", new Dictionary<string, string>()
{
{ "Packet ID", packetId.ToString() },
{ "Packet Type ", packetPalette.GetIncomingTypeById(packetId).ToString() },
{ "Protocol Version", protocolVersion.ToString() },
{ "Minecraft Version", ProtocolHandler.ProtocolVersion2MCVer(protocolVersion) },
{ "Current State", currentState.ToString() },
{ "Packet Data", string.Join(" ", _copy.Select(b => b.ToString("X2"))) },
{ "Inner Exception", innerException.GetType().ToString() }
}, "packet", BreadcrumbLevel.Error));
SentrySdk.CaptureException(exception);
throw exception;
}
return true;
@ -4561,4 +4581,4 @@ namespace MinecraftClient.Protocol.Handlers
Configuration,
Play
}
}
}

View file

@ -1,7 +1,6 @@
//------------------------------------------------------------------------------
// <auto-generated>
// This code was generated by a tool.
// Runtime Version:4.0.30319.42000
//
// Changes to this file may cause incorrect behavior and will be lost if
// the code is regenerated.
@ -165,8 +164,8 @@ namespace MinecraftClient {
/// <summary>
/// Looks up a localized string similar to Send a command on a regular or random basis or make the bot walk around randomly to avoid automatic AFK disconnection
////!\ Make sure your server rules do not forbid anti-AFK mechanisms!
////!\ Make sure you keep the bot in an enclosure to prevent it wandering off if you&apos;re using terrain handling! (Recommended size 5x5x5).
/// /!\ Make sure your server rules do not forbid anti-AFK mechanisms!
/// /!\ Make sure you keep the bot in an enclosure to prevent it wandering off if you&apos;re using terrain handling! (Recommended size 5x5x5).
/// </summary>
internal static string ChatBot_AntiAfk {
get {
@ -231,8 +230,8 @@ namespace MinecraftClient {
/// <summary>
/// Looks up a localized string similar to Automatically attack hostile mobs around you
///You need to enable Entity Handling to use this bot
////!\ Make sure server rules allow your planned use of AutoAttack
////!\ SERVER PLUGINS may consider AutoAttack to be a CHEAT MOD and TAKE ACTION AGAINST YOUR ACCOUNT so DOUBLE CHECK WITH SERVER RULES!.
/// /!\ Make sure server rules allow your planned use of AutoAttack
/// /!\ SERVER PLUGINS may consider AutoAttack to be a CHEAT MOD and TAKE ACTION AGAINST YOUR ACCOUNT so DOUBLE CHECK WITH SERVER RULES!.
/// </summary>
internal static string ChatBot_AutoAttack {
get {
@ -501,7 +500,7 @@ namespace MinecraftClient {
/// Looks up a localized string similar to Automatically catch fish using a fishing rod
///Guide: https://mccteam.github.io/g/bots/#auto-fishing
///You can use &quot;/fish&quot; to control the bot manually.
////!\ Make sure server rules allow automated farming before using this bot.
/// /!\ Make sure server rules allow automated farming before using this bot.
/// </summary>
internal static string ChatBot_AutoFishing {
get {
@ -628,7 +627,7 @@ namespace MinecraftClient {
/// <summary>
/// Looks up a localized string similar to Automatically relog when disconnected by server, for example because the server is restating
////!\ Use Ignore_Kick_Message=true at own risk! Server staff might not appreciate if you auto-relog on manual kicks.
/// /!\ Use Ignore_Kick_Message=true at own risk! Server staff might not appreciate if you auto-relog on manual kicks.
/// </summary>
internal static string ChatBot_AutoRelog {
get {
@ -675,7 +674,7 @@ namespace MinecraftClient {
/// <summary>
/// Looks up a localized string similar to Run commands or send messages automatically when a specified pattern is detected in chat
///Server admins can spoof chat messages (/nick, /tellraw) so keep this in mind when implementing AutoRespond rules
////!\ This bot may get spammy depending on your rules, although the global messagecooldown setting can help you avoiding accidental spam.
/// /!\ This bot may get spammy depending on your rules, although the global messagecooldown setting can help you avoiding accidental spam.
/// </summary>
internal static string ChatBot_AutoRespond {
get {
@ -707,7 +706,7 @@ namespace MinecraftClient {
///Documentation: https://mccteam.github.io/g/bots/#discord-bridge
///Setup:
///First you need to create a Bot on the Discord Developers Portal, here is a video tutorial: https://www.youtube.com/watch?v=2FgMnZViNPA .
////!\ IMPORTANT /!\: When creating a bot, you MUST ENABLE &quot;Message Content Intent&quot;, &quot;Server Members Intent&quot; and &quot;Presence Intent [rest of string was truncated]&quot;;.
/// /!\ IMPORTANT /!\: When creating a bot, you MUST ENABLE &quot;Message Content Intent&quot;, &quot;Server Members Intent&quot; and &quot;Presence Intent [rest of string was truncated]&quot;;.
/// </summary>
internal static string ChatBot_DiscordBridge {
get {
@ -799,8 +798,7 @@ namespace MinecraftClient {
///NOTE: This is an experimental feature, the bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you
///It&apos;s similar to making animals follow you when you&apos;re holding food in your hand.
///This is due to a slow pathfinding algorithm, we&apos;re working on getting a better one
///You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite,
/// [rest of string was truncated]&quot;;.
///You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, /// [rest of string was truncated]&quot;;.
/// </summary>
internal static string ChatBot_FollowPlayer {
get {
@ -829,7 +827,7 @@ namespace MinecraftClient {
/// <summary>
/// Looks up a localized string similar to A small game to demonstrate chat interactions. Players can guess mystery words one letter at a time.
///You need to have ChatFormat working correctly and add yourself in botowners to start the game with /tell &lt;bot username&gt; start
////!\ This bot may get a bit spammy if many players are interacting with it.
/// /!\ This bot may get a bit spammy if many players are interacting with it.
/// </summary>
internal static string ChatBot_HangmanGame {
get {
@ -903,7 +901,7 @@ namespace MinecraftClient {
/// <summary>
/// Looks up a localized string similar to Relay messages between players and servers, like a mail plugin
///This bot can store messages when the recipients are offline, and send them when they join the server
////!\ Server admins can spoof PMs (/tellraw, /nick) so enable this bot only if you trust server admins.
/// /!\ Server admins can spoof PMs (/tellraw, /nick) so enable this bot only if you trust server admins.
/// </summary>
internal static string ChatBot_Mailer {
get {
@ -917,7 +915,7 @@ namespace MinecraftClient {
///The maps are rendered into Rendered_Maps folder if the Save_To_File is enabled.
///NOTE:
///If some servers have a very short time for solving captchas, enabe Auto_Render_On_Update to see them immediatelly in the console.
////!\ Make sure server rules allow bots to be used on the server, or you risk being punished..
/// /!\ Make sure server rules allow bots to be used on the server, or you risk being punished..
/// </summary>
internal static string ChatBot_Map {
get {
@ -1020,7 +1018,7 @@ namespace MinecraftClient {
/// <summary>
/// Looks up a localized string similar to Send MCC console commands to your bot through server PMs (/tell)
///You need to have ChatFormat working correctly and add yourself in botowners to use the bot
////!\ Server admins can spoof PMs (/tellraw, /nick) so enable RemoteControl only if you trust server admins.
/// /!\ Server admins can spoof PMs (/tellraw, /nick) so enable RemoteControl only if you trust server admins.
/// </summary>
internal static string ChatBot_RemoteControl {
get {
@ -1031,7 +1029,7 @@ namespace MinecraftClient {
/// <summary>
/// Looks up a localized string similar to Enable recording of the game (/replay start) and replay it later using the Replay Mod (https://www.replaymod.com/)
///Please note that due to technical limitations, the client player (you) will not be shown in the replay file
////!\ You SHOULD use /replay stop or exit the program gracefully with /quit OR THE REPLAY FILE MAY GET CORRUPT!.
/// /!\ You SHOULD use /replay stop or exit the program gracefully with /quit OR THE REPLAY FILE MAY GET CORRUPT!.
/// </summary>
internal static string ChatBot_ReplayCapture {
get {
@ -1060,7 +1058,7 @@ namespace MinecraftClient {
/// <summary>
/// Looks up a localized string similar to This bot allows you to send and receive messages and commands via a Telegram Bot DM or to receive messages in a Telegram channel.
////!\ NOTE: You can&apos;t send messages and commands from a group channel, you can only send them in the bot DM, but you can get the messages from the client in a group channel.
/// /!\ NOTE: You can&apos;t send messages and commands from a group channel, you can only send them in the bot DM, but you can get the messages from the client in a group channel.
///-----------------------------------------------------------
///Setup:
///First you need to create a Telegram bot and obtain an API key, to do so, go to Telegram and find @botfather
@ -1451,6 +1449,15 @@ namespace MinecraftClient {
}
}
/// <summary>
/// Looks up a localized string similar to Set to false to opt-out of Sentry error logging..
/// </summary>
internal static string Main_Advanced_enable_sentry {
get {
return ResourceManager.GetString("Main.Advanced.enable_sentry", resourceCulture);
}
}
/// <summary>
/// Looks up a localized string similar to Toggle entity handling..
/// </summary>
@ -1844,7 +1851,7 @@ namespace MinecraftClient {
/// Looks up a localized string similar to Connect to a server via a proxy instead of connecting directly
///If Mojang session services are blocked on your network, set Enabled_Login=true to login using proxy.
///If the connection to the Minecraft game server is blocked by the firewall, set Enabled_Ingame=true to use a proxy to connect to the game server.
////!\ Make sure your server rules allow Proxies or VPNs before setting enabled=true, or you may face consequences!.
/// /!\ Make sure your server rules allow Proxies or VPNs before setting enabled=true, or you may face consequences!.
/// </summary>
internal static string Proxy {
get {
@ -2005,4 +2012,4 @@ namespace MinecraftClient {
}
}
}
}
}

View file

@ -852,4 +852,7 @@ If the connection to the Minecraft game server is blocked by the firewall, set E
<data name="Main.General.AuthlibServer" xml:space="preserve">
<value>Yggdrasil authlib server domain name and port.</value>
</data>
<data name="Main.Advanced.enable_sentry" xml:space="preserve">
<value>Set to false to opt-out of Sentry error logging.</value>
</data>
</root>

View file

@ -1,7 +1,6 @@
//------------------------------------------------------------------------------
// <auto-generated>
// This code was generated by a tool.
// Runtime Version:4.0.30319.42000
//
// Changes to this file may cause incorrect behavior and will be lost if
// the code is regenerated.
@ -5782,6 +5781,15 @@ namespace MinecraftClient {
}
}
/// <summary>
/// Looks up a localized string similar to MCC uses Sentry to log errors. You can opt-out by setting the EnableSentry option in the configuration file to false..
/// </summary>
internal static string mcc_sentry_logging {
get {
return ResourceManager.GetString("mcc.sentry_logging", resourceCulture);
}
}
/// <summary>
/// Looks up a localized string similar to Server is in offline mode..
/// </summary>

View file

@ -2130,4 +2130,7 @@ Logging in...</value>
<data name="mcc.select_profile" xml:space="preserve">
<value>Select a profile from available profiles:</value>
</data>
<data name="mcc.sentry_logging" xml:space="preserve">
<value>MCC uses Sentry to log errors. You can opt-out by setting the EnableSentry option in the configuration file to false.</value>
</data>
</root>

View file

@ -506,6 +506,9 @@ namespace MinecraftClient
[TomlDoNotInlineObject]
public class AdvancedConfig
{
[TomlInlineComment("$Main.Advanced.enable_sentry$")]
public bool EnableSentry = true;
[TomlInlineComment("$Main.Advanced.language$")]
public string Language = "en_us";

View file

@ -74,3 +74,10 @@ The main terms of the CDDL-1.0 license are basically the following:
More info at http://qstuff.blogspot.fr/2007/04/why-cddl.html
Full license at http://opensource.org/licenses/CDDL-1.0
## Uses technologies from
<div align="center">
<a href="https://sentry.io/welcome/">
<img src="https://github.com/breadbyte/Minecraft-Console-Client/assets/14045257/411e9a2f-cd9b-4bb5-b7e9-cd7529c76b88" alt="Sentry" />
</a>
</div>