Skip to content

feat(native): external crash reporter #15244

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(native): external crash reporter #15244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
Binary file added ...ve/advanced-usage/external-crash-reporter/img/sentry-desktop-crash-reporter.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions docs/platforms/native/advanced-usage/external-crash-reporter/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: External Crash Reporter
description: "How to configure an external crash reporter with the Native SDK."
sidebar_order: 2100
---
The Native SDK can be configured to work with an external crash reporter, which
can be used to display crash information to the user, collect user feedback, or
perform other actions when a crash occurs.

The external crash reporter is a user-defined executable, distinct from the
system crash reporter, that is launched by the Native SDK upon a crash. It
receives the path to the crash report as its only command-line argument and
is responsible for submitting the crash report to Sentry.

```c
sentry_options_t *options = sentry_options_new();
sentry_options_set_external_crash_reporter_path(options, "/path/to/external_crash_reporter");
/* ... */
sentry_init(options);
```

![Sentry Desktop Crash Reporter](./img/sentry-desktop-crash-reporter.png)

<Alert title="Tip">
[Sentry Desktop Crash Reporter](https://github.com/getsentry/sentry-desktop-crash-reporter) is a ready-made crash reporter reference implementation. It is a cross-platform desktop application made with [.NET](https://dot.net) and [Uno Platform](https://platform.uno/).
</Alert>
Loading