Add Portable PDB support to Raygun4Net and Raygun4NetCore #528

xenolightning · 2024-05-05T20:54:17Z

This captures the required debugging information for reversing the stacktrace line numbers and file from the stack trace when a PDB is not included in the build output

Updated payload:

This captures the required debugging information for reversing the stacktrace line numbers and file from the stack trace when a PDB is not included in the build output

This could be an issue in medium trust environments, so safer just to try/catch it, especially in this critical part of code

phillip-haydon

1Q: the offset is -1, if the try fails and -1 is set but we have other info what happens to the offset? Do we ignore if the offset is -1?

xenolightning · 2024-05-05T22:26:11Z

1Q: the offset is -1, if the try fails and -1 is set but we have other info what happens to the offset? Do we ignore if the offset is -1?

Yeah I wanted a non-sensical value for determining that it doesn't exist. What I might do is set it to the constant. Which is equal to -1 :D

https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.stackframe.offset_unknown?view=net-8.0

ProRedCat · 2024-05-05T23:37:51Z

I am happy with this, it works for MAUI (iOS and Android tested) with the traces being symbolicated when using Sean's tool

One thing we noticed was that if any program is created without PDB files, the IL offsets will cause the symbolicated trace to be off by one line. This is not an issue as it's undefined behaviour to build an app and then build the PDB separately.

xenolightning · 2024-05-06T01:23:29Z

Holding on this just for now, we may need to add more information to the "frame" that we can use to determine what PDB we should be looking at, maybe that's assembly, or some sort of signature - not sure yet

xenolightning · 2024-05-09T02:17:44Z

There is issues using the PEReader in the context of the Android platform. Xamarin has some code to read assemblies out of the blob

We are going to need to explore this code, and probably port it into Raygun4Net to capture the PDB signatures when targeting android

https://github.com/xamarin/xamarin-android/tree/main/tools/assembly-store-reader

…for each stack frame

This saves having to go to file/disk/whatever else, when looking for the symbols. This could be expensive on each crash/frame, so we want to avoid doing too much work

Mindscape.Raygun4Net.NetCore.Common/Mindscape.Raygun4Net.NetCore.Common.csproj

xenolightning · 2024-05-16T02:42:01Z

Raw report inside raygun, after collecting the new fields. The full pipeline supports these fields. They haven't been reversed in the screenshots, but we have the data to do the reversal!

xenolightning · 2024-05-19T19:58:39Z

Mindscape.Raygun4Net.NetCore.Common/Builders/RaygunErrorMessageBuilder.cs


 namespace Mindscape.Raygun4Net
 {
  public class RaygunErrorMessageBuilder
  {
+    private static readonly ConcurrentDictionary<string, PdbDebugInformation> DebugInformationCache = new();
+    public static Func<string, PEReader> AssemblyReaderProvider { get; set; } = PortableExecutableReaderExtensions.GetFileSystemPEReader;


Intention here is that this is replaced with an android version for MAUI.

This needs to be bundled inside the raygun4maui release though, as our core library doesn't have platform targets

phillip-haydon

👍

Mindscape.Raygun4Net.NetCore.Common/Mindscape.Raygun4Net.NetCore.Common.csproj

Mindscape.Raygun4Net.Core/Mindscape.Raygun4Net.Core.csproj

phillip-haydon · 2024-05-19T21:05:08Z

Mindscape.Raygun4Net.Core/Builders/RaygunErrorMessageBuilder.cs

+        Debug.WriteLine($"Could not load debug information: {ex}");
+      }
+
+      return null;


If the module is not found and returns null, we could consider adding it to the dictionary too to avoid the lookup attempt every time.

Interesting, I originally had this code as that something went wrong and we shouldn't add it, and maybe we could try again.

But when there's no exceptions, maybe we do add a null?

phillip-haydon · 2024-05-19T21:06:30Z

Mindscape.Raygun4Net.NetCore.Common/Builders/RaygunErrorMessageBuilder.cs

+        Debug.WriteLine($"Could not load debug information: {ex}");
+      }
+
+      return null;


Same comment as the other implementation.

…e specific data this should reduce the overall size of the payload

xenolightning · 2024-05-20T22:16:49Z

Tagged @QuantumNightmare on this one too, as he had suggestions on improving the payload

Mindscape.Raygun4Net.Core/Builders/RaygunErrorMessageBuilder.cs

Mindscape.Raygun4Net.NetCore.Common/Builders/RaygunErrorMessageBuilder.cs

QuantumNightmare

Last 3 commits look good to me, just commented on what looks like a typo. Would be good to avoid the duplicate code too, but that could be left for another round as I know there are already thoughts on simplifying the repository.

xenolightning · 2024-05-20T22:25:33Z

Last 3 commits look good to me, just commented on what looks like a typo. Would be good to avoid the duplicate code too, but that could be left for another round as I know there are already thoughts on simplifying the repository.

Yeah, we end up having to make changes to both framework and core sadly.

We do have plans to consolidate them into a single netstandard targeting lib at some point soon

QuantumNightmare

Thanks for the typo fixes

phillip-haydon

🚀

phillip-haydon · 2024-05-21T19:47:23Z

Don't forget to update the Change Log.

xenolightning · 2024-05-21T22:08:17Z

Don't forget to update the Change Log.

I'll do a larger changelog update for 11.0 which will also include the offline storage support for netcore

xenolightning · 2024-05-22T23:37:50Z

Going to merge and release as 11.0-pre1

Then we can base raygun4maui off this package, and bring the rest into line

xenolightning requested a review from phillip-haydon May 5, 2024 20:54

xenolightning added 2 commits May 6, 2024 08:59

Support capturing ILOffset and MetadataToken for the method

81a6ab1

This captures the required debugging information for reversing the stacktrace line numbers and file from the stack trace when a PDB is not included in the build output

Wrap the retrieval of reflected properties in a try catch

be13820

This could be an issue in medium trust environments, so safer just to try/catch it, especially in this critical part of code

xenolightning force-pushed the sean/portable-pdb-support branch from fb85065 to be13820 Compare May 5, 2024 21:00

xenolightning requested a review from ProRedCat May 5, 2024 21:14

phillip-haydon previously approved these changes May 5, 2024

View reviewed changes

Make the -1 value a constant

f1c8e66

xenolightning dismissed phillip-haydon’s stale review via f1c8e66 May 5, 2024 22:35

Add comment on why this is in a try catch

b437013

xenolightning requested a review from phillip-haydon May 5, 2024 22:46

xenolightning added 4 commits May 16, 2024 11:31

Add a local file system PE reader to extract the PDB information out …

1f1ae72

…for each stack frame

Add a concurrent dictionary to cache the lookups for modules.

6782aca

This saves having to go to file/disk/whatever else, when looking for the symbols. This could be expensive on each crash/frame, so we want to avoid doing too much work

Whoops, actually call the thing.

3c3ea43

Pull debug info forward because it catches its own exceptions

16a37ae

xenolightning commented May 15, 2024

View reviewed changes

Mindscape.Raygun4Net.NetCore.Common/Mindscape.Raygun4Net.NetCore.Common.csproj Outdated Show resolved Hide resolved

Port the code across to framework

2098a7c

xenolightning commented May 19, 2024

View reviewed changes

phillip-haydon requested changes May 19, 2024

View reviewed changes

xenolightning added 3 commits May 20, 2024 12:07

Conditionally include the package for net standard

589ac25

Rename a few of the properties and add an images section for the imag…

c6af291

…e specific data this should reduce the overall size of the payload

Empty check the cache for an early return and null check signature

6827ed5

xenolightning requested a review from QuantumNightmare May 20, 2024 21:24

QuantumNightmare reviewed May 20, 2024

View reviewed changes

Mindscape.Raygun4Net.Core/Builders/RaygunErrorMessageBuilder.cs Outdated Show resolved Hide resolved

QuantumNightmare reviewed May 20, 2024

View reviewed changes

Mindscape.Raygun4Net.NetCore.Common/Builders/RaygunErrorMessageBuilder.cs Outdated Show resolved Hide resolved

QuantumNightmare reviewed May 20, 2024

View reviewed changes

Fix typo

876544f

xenolightning requested a review from QuantumNightmare May 20, 2024 22:28

Fix empty lines

fe2a4ff

QuantumNightmare reviewed May 21, 2024

View reviewed changes

Update the caching based off Phill's feedback

e471e0d

xenolightning requested a review from phillip-haydon May 21, 2024 01:42

Add a tests and filter out nulls

159a5ee

xenolightning changed the title ~~Support capturing ILOffset and MetadataToken for the method~~ Add Portable PDB support to Raygun4Net and Raygun4NetCore May 21, 2024

phillip-haydon approved these changes May 21, 2024

View reviewed changes

xenolightning requested a review from PanosNB May 22, 2024 21:37

xenolightning merged commit cd3a86c into master May 22, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Portable PDB support to Raygun4Net and Raygun4NetCore #528

Add Portable PDB support to Raygun4Net and Raygun4NetCore #528

xenolightning commented May 5, 2024 •

edited

Loading

phillip-haydon left a comment

xenolightning commented May 5, 2024 •

edited

Loading

ProRedCat commented May 5, 2024

xenolightning commented May 6, 2024

xenolightning commented May 9, 2024

xenolightning commented May 16, 2024

xenolightning May 19, 2024 •

edited

Loading

phillip-haydon left a comment

phillip-haydon May 19, 2024

xenolightning May 20, 2024 •

edited

Loading

phillip-haydon May 19, 2024

xenolightning commented May 20, 2024

QuantumNightmare left a comment

xenolightning commented May 20, 2024

QuantumNightmare left a comment

phillip-haydon left a comment

phillip-haydon commented May 21, 2024

xenolightning commented May 21, 2024

xenolightning commented May 22, 2024

Add Portable PDB support to Raygun4Net and Raygun4NetCore #528

Add Portable PDB support to Raygun4Net and Raygun4NetCore #528

Conversation

xenolightning commented May 5, 2024 • edited Loading

phillip-haydon left a comment

Choose a reason for hiding this comment

xenolightning commented May 5, 2024 • edited Loading

ProRedCat commented May 5, 2024

xenolightning commented May 6, 2024

xenolightning commented May 9, 2024

xenolightning commented May 16, 2024

xenolightning May 19, 2024 • edited Loading

Choose a reason for hiding this comment

phillip-haydon left a comment

Choose a reason for hiding this comment

phillip-haydon May 19, 2024

Choose a reason for hiding this comment

xenolightning May 20, 2024 • edited Loading

Choose a reason for hiding this comment

phillip-haydon May 19, 2024

Choose a reason for hiding this comment

xenolightning commented May 20, 2024

QuantumNightmare left a comment

Choose a reason for hiding this comment

xenolightning commented May 20, 2024

QuantumNightmare left a comment

Choose a reason for hiding this comment

phillip-haydon left a comment

Choose a reason for hiding this comment

phillip-haydon commented May 21, 2024

xenolightning commented May 21, 2024

xenolightning commented May 22, 2024

xenolightning commented May 5, 2024 •

edited

Loading

xenolightning commented May 5, 2024 •

edited

Loading

xenolightning May 19, 2024 •

edited

Loading

xenolightning May 20, 2024 •

edited

Loading