Add Context

Custom contexts allow you to attach arbitrary data to an event. Often, this context is shared among any issue captured in its lifecycle. You cannot search these, but they are viewable on the issue page:

Custom contexts as viewed on the Additional Data section of an event

Structured Context

The best practice to attach custom data is via structured contexts. A context must always be a dictionary or map, and its values can be arbitrary. Use set_context and give the context a unique name:

Copied
sentry::configure_scope(|scope| {
    scope.set_extra("character.name", "Mighty Fighter".to_owned().into());
});

There are no restrictions for naming contexts or their fields. However, there is a set of conventions for common contexts. For more information, refer to the contexts interface developer documentation.

Size Limitations

When sending context, consider payload size limits. Sentry does not recommend sending the entire application state and large data blobs in contexts. If you exceed the maximum payload size, Sentry will respond with HTTP error 413 Payload Too Large and reject the event.

The Sentry SDK will try its best to accommodate the data you send and trim large context payloads. Some SDKS can truncate parts of the event; for more details, see theĀ developer documentation on SDK data handling.

Additional Data

In addition to structured contexts, Sentry supports adding unstructured "Additional Data" via set_extra. Additional Data is deprecated in favor of structured contexts and should be avoided when possible.

You can edit this page on GitHub.