Skip to content

docs: Add docs about internal event sending flow #6499

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
merged 1 commit into from
Dec 12, 2022
Merged
Changes from all commits
Commits
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
99 changes: 99 additions & 0 deletions docs/event-sending.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
# Event processing & sending

This document gives an outline for how event sending works, and which which places it goes through.

## Errors

* `hub.captureException()`
* `client.captureException()` (see baseclient)
* `checkOrSetAlreadyCaught()`
* `baseclient._process()`
* `baseclient.eventFromException()`
* `baseclient._captureEvent()`
* `baseclient._processEvent()`
* `baseclient._prepareEvent()`
* `baseclient._applyClientOptions()`
* `baseclient._applyIntegrationsMetadata()`
* `scope.applyToEvent()`
* `baseclient._normalizeEvent()`
* `baseclient._updateSessionFromEvent()`
* `baseclient.sendEvent()`
* `createEventEnvelope()`
* `getSdkMetadataForEnvelopeHeader()`
* `enhanceEventWithSdkInfo()`
* `createEventEnvelopeHeaders()`
* `createEnvelope()`
* `addItemToEnvelope()`
* `createAttachmentEnvelopeItem()`
* `baseclient._sendEnvelope()`
* `transport.send()`

## Transactions

* `transaction.finish()`
* `transaction.getTraceContext()`
* `transaction.getDynamicSamplingContext()`
* `hub.captureEvent()`
* `client.captureEvent()` (see baseclient)
* `checkOrSetAlreadyCaught()`
* `baseclient._process()`
* `baseclient.eventFromException()`
* `baseclient._captureEvent()`
* `baseclient._processEvent()`
* `baseclient._prepareEvent()`
* `baseclient._applyClientOptions()`
* `baseclient._applyIntegrationsMetadata()`
* `scope.applyToEvent()`
* `baseclient._normalizeEvent()`
* `baseclient._updateSessionFromEvent()`
* `baseclient.sendEvent()`
* `createEventEnvelope()`
* `getSdkMetadataForEnvelopeHeader()`
* `enhanceEventWithSdkInfo()`
* `createEventEnvelopeHeaders()`
* `createEnvelope()`
* `addItemToEnvelope()`
* `createAttachmentEnvelopeItem()`
* `baseclient._sendEnvelope()`
* `transport.send()`

## Sessions

* `hub.captureSession()`
* `hub.endSession()`
* `closeSession()`
* `hub._sendSessionUpdate()`
* `scope.setSession()`
* `hub._sendSessionUpdate()`
* `client.captureSession()` (see baseclient)
* `baseclient.sendSession()`
* `createSessionEnvelope()`
* `getSdkMetadataForEnvelopeHeader()`
* `createEnvelope()`
* `baseclient._sendEnvelope()`
* `transport.send()`
* `updateSession()`

## Replay (WIP)

* `replay.sendReplayRequest()`
* `createPayload()`
* `getReplayEvent()`
* `client._prepareEvent()` (see baseclient)
* `baseclient._applyClientOptions()`
* `baseclient._applyIntegrationsMetadata()`
* `scope.applyToEvent()`
* `baseclient._normalizeEvent()`
* `baseclient._updateSessionFromEvent()`
* `createReplayEnvelope()`
* `createEnvelope()`
* `transport.send()`

## Client Reports

* `browser.client.constructor()`
* `browser.client._flushOutcomes()`
* `getEnvelopeEndpointWithUrlEncodedAuth()`
* `createClientReportEnvelope()`
* `baseclient._sendEnvelope()`
* `transport.send()`