-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Document how to manipulate attachments via hints #5070
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.
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
adinauer
merged 4 commits into
feat/update-hints-docs
from
feat/attachment-manipulation-via-hints
Jun 9, 2022
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
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: | ||
|
||
```java | ||
import io.sentry.Attachment; | ||
import io.sentry.Hint; | ||
import io.sentry.Sentry; | ||
|
||
Sentry.captureException(new IllegalStateException(), Hint.withAttachment("/path/to/file.txt")) | ||
``` | ||
|
||
```kotlin | ||
import io.sentry.Attachment; | ||
import io.sentry.Hint; | ||
import io.sentry.Sentry; | ||
|
||
Sentry.captureException(IllegalStateException(), Hint.withAttachment("/path/to/file.txt")) | ||
``` | ||
|
||
### Adding Attachments in `EventProcessor` | ||
|
||
You may also manipulate attachments in `EventProcessor`: | ||
|
||
```java | ||
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!"); | ||
``` | ||
|
||
```kotlin | ||
import io.sentry.Attachment; | ||
import io.sentry.EventProcessor; | ||
import io.sentry.Hint; | ||
import io.sentry.Sentry | ||
import io.sentry.SentryEvent; | ||
import io.sentry.protocol.Message | ||
|
||
class AttachmentManipulationEventProcessor: EventProcessor { | ||
override fun process(event: SentryEvent, hint: Hint): SentryEvent? { | ||
hint.addAttachment(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!") | ||
``` | ||
|
||
<Note> | ||
|
||
Instead of adding attachments, you can also remove them, by setting a different (or empty) list of attachments using `Hint#setAttachments()`. | ||
|
||
</Note> | ||
|
||
### Adding Attachments in `beforeSend` | ||
|
||
Another way of adding attachments is using `beforeSend`: | ||
|
||
```java | ||
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; | ||
}); | ||
``` | ||
|
||
```kotlin | ||
import io.sentry.Attachment; | ||
import io.sentry.Hint; | ||
import io.sentry.Sentry; | ||
import io.sentry.SentryOptions.BeforeSendCallback | ||
|
||
options.beforeSend = BeforeSendCallback { event, hint -> | ||
hint.addAttachment(Attachment("/path/to/file.txt")) | ||
event | ||
} | ||
``` | ||
|
||
<Note> | ||
|
||
Instead of adding attachments, you can also remove them, by setting a different (or empty) list of attachments using `Hint#setAttachments()`. | ||
|
||
</Note> | ||
|
||
### Adding Attachments to the Scope |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.