Custom Metadata for each exception report

Unity Services
,
1

Hi,

Is there a way to set metadata for a crash report just before it’s sent? I’m thinking about reporting some data that varies constantly from frame to frame like the framerate, the ping or the time since the start of the game. If there was an event or a callback when a crash report is ready to be sent, that would be perfect. If it doesn’t exist, is it something that is on the roadmap?

2

I think you can achieve this with SetUserMetadata:

https://docs.unity3d.com/2018.3/Documentation/ScriptReference/CrashReportHandler.CrashReportHandler.SetUserMetadata.html

This post is a little out of date but it describes this feature as well:

https://blogs.unity3d.com/2018/10/15/whats-new-in-performance-reporting/

Note this feature of Cloud Diagnostics is only available to Plus/Pro subscribers.

1 Like
3

Thanks for the quick reply!

I have tried that this afternoon. My only issue with that method is that I need to keep updating the values each frame instead of being able to set the data when the crash happens to have the most accurate values. For example, if I wanted to send the time since the game has started, I would have to do it like this:

public class MetadataManager : MonoBehaviour
{
    private static DateTime gameStartTime;

    [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)]
    private void OnGameStarted()
    {
        gameStartTime = DateTime.Now;
    }

    void Update()
    {
        CrashReportHandler.SetUserMetadata("timeSinceGameStart", (DateTime.Now - gameStartTime).TotalSeconds.ToString());
    }
}

I think that would be easier and more efficient for performance to be able to set the metadata based on a callback or event like this:

public class MetadataManager : MonoBehaviour
{
    private static DateTime gameStartTime;

    [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)]
    private void OnGameStarted()
    {
        gameStartTime = DateTime.Now;
    }

    void Awake()
    {
        CrashReportHandler.UnhandledExceptionEvent += OnUnhandledException;
    }

    private void OnUnhandledException()
    {
        CrashReportHandler.SetUserMetadata("timeSinceGameStart", (DateTime.Now - gameStartTime).TotalSeconds.ToString());
    }
}

The metadata would be processed after that UnhandledExceptionEvent.

3 Likes
4

I would like add to what @Djadjouka is propossing. Additional to having a callback for when a crash report is genereated, it would also be a great function to be able to force sending a crash report. Some times, part of our code has to be handled in a try … catch to prevent leaving the execution on an inconsistent state, but it would be very helpfull if we still got the crash report. Currently, only Unhandled exceptions are reported. So, something like this would be great:

        private void SomeAction()
        {
            try
            {
                // Work that can fail.
            }
            catch (Exception ex)
            {
                // Do something to handled the exception
                CrashReport.Send(ex);
            }
        }

In the example above, after handling the exception, we are still reporting it. That would also be a great place where user metadata can be added to the crash report.

1 Like
5

Hi @Djadjouka and @emmanuelsolis , thank you for the awesome suggestions! The callback feature is already in our backlog of features that we’d like to add.

For the second issue regarding being able to manually send crash reports, you can actually accomplish that by calling Debug.LogException() in your code. These will still send out exception reports while allowing you to properly handle the exception.

3 Likes
6

That’s great news @Ryan-Unity . Any ETA on that callback feature?

7

Hi @Can-Baycay ! Unfortunately we don’t have an ETA yet on the callback feature. But we’ll be sure to update everyone here when we’re close to announcing something.

8

Hi @Ryan-Unity , any news on this callback ?

9

Debug.LogException is not sending a report for us. Is there any way to achieve this?

10

It looks like the callback never came? Making the class UnityEngine.CrashReportHandler.CrashReportHandler useless and potentially dangerous - the game will carry on, not understanding that something went wrong and that very-very-very often have secondary problems emerging down the line. Up to and including completely ruined savegame files. That is a disaster for players.

11

Hey! Since it’s been 3 years an update on the issue would be much appreciated!

1 Like
12

Would love to see the extended functionality described above