Minidump

Sentry can process Minidump crash reports, a memory dump used on Windows and by open-source libraries like Breakpad or Crashpad. You can either choose to generate and upload minidumps yourself or use a higher-level SDK for platforms with built-in support for native crashes:

In order to receive symbolicated stack traces, you have to upload debug information to Sentry. For more information, see Debug Information Files.

What is a Minidump?

Minidumps are files containing the most important memory regions of a crashed process. When the process crashes, the minidump is written to the user’s disk and can later be uploaded to Sentry. A minidump typically includes:

  • The runtime stack of each thread that was active during the time of the crash. This allows yout to reconstruct stack traces for all stacks and even infer variable values in some cases.
  • Thread contexts – that is, register values – at the time of the crash. This is especially relevant for stack walking.
  • Optionally, the process heap. By default, this is not included to keep minidumps at a reasonable size. Sentry does not read the heap so that it can be safely omitted.
  • The crash reason and an optional memory address associated to with the crash. For example, memory access violations. In the case of assertions, the assertion message is also included in the dump.
  • Meta data about the CPU architecture and the user’s operating system.

In addition to this information, you can add further metadata specific to Sentry, which can help in organizing and analyzing issues. For more information, see Passing Additional Data.

Creating and Uploading Minidumps

Depending on your operating system and programming language, there are various alternatives to create minidumps and upload them to Sentry. See the following resources for libraries that support generating minidump crash reports:

If you have already integrated a library that generates minidumps and would just like to upload them to Sentry, you need to configure the Minidump Endpoint URL, which can be found at Project Settings > Client Keys (DSN). This endpoint expects a POST request with the minidump in the upload_file_minidump field:

$ curl -X POST \
  '___MINIDUMP_URL___' \
  -F upload_file_minidump=@mini.dmp

To send additional information, add more form fields to this request. For a full description of fields accepted by Sentry, see Passing Additional Data.

Passing Additional Data

You can add more information to crash reports by merely adding more fields to the upload HTTP request. All these fields will be collected in the “Extra Data” section in Sentry:

$ curl -X POST \
  '___MINIDUMP_URL___' \
  -F upload_file_minidump=@mini.dmp \
  -F custom_field=value

Additionally, you can set all attributes corresponding to the Sentry event interface in a sentry field. This field either accepts JSON data or its values can be flattened with the bracket syntax. For example, to set the release and add a tag, send:

# As JSON
$ curl -X POST \
  '___MINIDUMP_URL___' \
  -F upload_file_minidump=@mini.dmp \
  -F 'sentry={"release":"1.2.3","tags":{"mytag":"value"}}'

# flattened
$ curl -X POST \
  '___MINIDUMP_URL___' \
  -F upload_file_minidump=@mini.dmp \
  -F 'sentry[release]=1.0.0' \
  -F 'sentry[tags][mytag]=value'

For the full list of supported values, see Event Payloads and linked documents.

Event Attachments (Preview)

Besides the minidump file, Sentry can optionally store additional files uploaded in the same request, such as log files.

The organization and project setting Store Native Crash Reports also enables storage of the original minidump files. For data privacy reasons, this setting is by default disabled. Raw minidumps are deleted permanently with their issues or after 30 days.

To send attachments directly to Sentry, add more files to the multipart form body. Note that the entire request must not exceed 20MB in size. Sentry will use the provided file names and mime types and list those files in the Event Attachments section at the bottom of the Issue Details page:

$ curl -X POST \
  '___MINIDUMP_URL___' \
  -F upload_file_minidump=@mini.dmp \
  -F some_file=@some_file.txt \
  -F db_log=@db.log