Skip to content

ref(native): capture-error using high-level API. #5085

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

Merged
merged 1 commit into from
May 30, 2022
Merged

ref(native): capture-error using high-level API. #5085

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
29 changes: 18 additions & 11 deletions src/includes/capture-error/native.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,30 @@
To capture an error or exception condition, create events containing an
exception object. It needs to contain at least a value and type:
exception object:

```cpp
#include <sentry.h>

sentry_value_t exc = sentry_value_new_object();
sentry_value_set_by_key(exc, "type", sentry_value_new_string("Exception"));
sentry_value_set_by_key(exc, "value", sentry_value_new_string("Error message."));
sentry_value_t event = sentry_value_new_event();

sentry_value_t exc = sentry_value_new_exception("Exception", "Error message.");
sentry_event_add_exception(event, exc);

sentry_value_t exceptions = sentry_value_new_object();
sentry_value_t values = sentry_value_new_list();
sentry_capture_event(event);
```

sentry_value_set_by_key(exceptions, "values", values);
sentry_value_append(values, exc);
The above exception does not contain a stack trace, which must be added separately:

```cpp
#include <sentry.h>

sentry_value_t event = sentry_value_new_event();
sentry_value_set_by_key(event, "exception", exceptions);

sentry_value_t exc = sentry_value_new_exception("Exception", "Error message.");

sentry_value_t stacktrace = sentry_value_new_stacktrace(NULL, 0);
sentry_value_set_by_key(exc, "stacktrace", stacktrace);
Comment on lines +24 to +25
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it was these two which we could replace with another function:

void sentry_value_add_stacktrace(sentry_value_t, void**, size_t)

to get rid of key/entry management on the client-side, correct?


sentry_event_add_exception(event, exc);

sentry_capture_event(event);
```

This exception does not contain a stack trace, which must be added separately.