Attachments

Please note that attachments don't work yet with crashes.

Sentry can enrich your events for further investigation by storing additional files, such as config or log files, as attachments.

Creating Attachments

The simplest way to create an attachment is to use a path. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same envelope. If the SDK can't read the file, the SDK logs an error message and drops the attachment.

Copied
import io.sentry.Sentry;
import io.sentry.Attachment;

Attachment attachment = new Attachment("your/path/file.log");

Alternately, use bytes to initialize an attachment. When doing so, you also need to specify a filename.

Copied
import io.sentry.Sentry;
import io.sentry.Attachment;

Attachment attachment = new Attachment(bytes, "file.log");

If your SDK supports offline caching, which is typical for mobile, each attachment is stored to disk for each event or transaction you capture when the device is offline. When using large attachments, this storage can consume the disk space if the device is offline for a longer time period. You can specify maximum attachment size to drop large attachments and avoid this issue.

In addition, you can set these parameters:

filename
The filename is the name of the file to display in Sentry. When using bytes you have to specify a filename, whereas with a path you don't as the SKD is going to use the last path component.

contentType
The type of content stored in this attachment. Any MIME type may be used; the default is application/octet-stream.

Uploading Attachments

To add an attachment, you can either add it to the scope, pass it to any of the capture methods, or manipulate the list of attachments in an EventProcessor or beforeSend.

Passing Attachments to Capture

You may pass attachments to any of the capture methods, for example, when capturing an exception:

Copied
import io.sentry.Attachment;
import io.sentry.Hint;
import io.sentry.Sentry;

Sentry.captureException(new IllegalStateException(), Hint.withAttachment("/path/to/file.txt"))

Adding Attachments in EventProcessor

You may also manipulate attachments in EventProcessor:

Copied
import io.sentry.Attachment;
import io.sentry.EventProcessor;
import io.sentry.Hint;
import io.sentry.Sentry;
import io.sentry.SentryEvent;

class AttachmentManipulationEventProcessor implements EventProcessor {
  @Override
  public SentryEvent process(SentryEvent event, Hint hint) {
    hint.addAttachment(new Attachment("/path/to/file.txt"))
    return event;
  }
}

// Register the AttachmentManipulationEventProcessor using SentryOptions#addEventProcessor or Scope#addEventProcessor

// Send an event to Sentry. During construction of the event
// the attachment will be added by the event processor.
Sentry.captureMessage("Hello, world!");

Adding Attachments in beforeSend

Another way of adding attachments is using beforeSend:

Copied
import io.sentry.Attachment;
import io.sentry.Hint;
import io.sentry.Sentry;

options.setBeforeSend((event, hint) -> {
  hint.addAttachment(new Attachment("/path/to/file.txt"))
  return event;
});

Adding Attachments to the Scope

Attachments live on the Scope. You can either add an attachment on the global scope to be sent with every event or add it on the local Scope to just send the attachment with one specific event.

Copied
import io.sentry.Sentry;
import io.sentry.Attachment;

Attachment fileAttachment = new Attachment("your/path/file.log");

// Global Scope
Sentry.configureScope(scope -> {
  scope.addAttachment(fileAttachment);
});

// Clear all attachments in the global Scope
Sentry.configureScope(scope -> {
  scope.clearAttachments();
});

// Local Scope
Sentry.withScope(scope -> {
  scope.addAttachment(fileAttachment);
  Sentry.captureMessage("my message");
});

Attachments persist for 30 days; if your total storage included in your

quotaThe monthly number of events that you pay Sentry to track.
is exceeded, attachments will not be stored. You can delete attachments or their containing events at any time. Deleting an attachment does not affect your
quotaThe monthly number of events that you pay Sentry to track.
- Sentry counts an attachment toward your
quotaThe monthly number of events that you pay Sentry to track.
as soon as it is stored.

Learn more about how attachments impact your quota.

Access to Attachments

To limit access to attachments, navigate to your organization's General Settings, then select the Attachments Access dropdown to set appropriate access — any member of your organization, the organization billing owner, member, admin, manager, or owner.

Attachments Access

By default, access is granted to all members when storage is enabled. If a member does not have access to the project, the ability to download an attachment is not available; the button will be greyed out in Sentry. The member may only view that an attachment is stored.

Viewing Attachments

Attachments display on the bottom of the Issue Details page for the event that is shown.

Attachments Access Denied

Alternately, attachments also appear in the Attachments tab on the Issue Details page, where you can view the Type of attachment, as well as associated events. Click the Event ID to open the Issue Details of that specific event.

Attachments List Example

Maximum Attachment Size

The maximum size for each attachment is set on `SentryOptions.maxAttachmentSize`.

The scale is bytes and the default is 20 MiB. Please also check the maximum attachment size of Relay to make sure your attachments don't get discarded there.

Copied
import io.sentry.Sentry;

Sentry.init(options -> {
  options.setMaxAttachmentSize(5 * 1024 * 1024); // 5 MiB
});
Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").