Records a new breadcrumb which will be attached to future events.
Breadcrumbs will be added to subsequent events to provide more context on user's actions prior to an error or crash.
The breadcrumb to record.
Optional
hint: BreadcrumbHintMay contain additional information about the original breadcrumb.
This binds the given client to the current scope.
Optional
client: Client<ClientOptions<BaseTransportOptions>>An SDK client (client) instance.
Captures an exception event and sends it to Sentry.
An exception-like object.
Optional
hint: EventHintMay contain additional information about the original exception.
The generated eventId.
Callback to set context information onto the scope.
Callback function that receives Scope.
Returns the integration if installed on the current client.
Create a new scope to store context information.
The scope will be layered on top of the current one. It is isolated, i.e. all breadcrumbs and context information added to this scope will be removed once the scope ends. Be sure to always remove this scope with this.popScope when the operation finishes or throws.
Scope, the new cloned scope
For the duration of the callback, this hub will be set as the global current Hub. This function is useful if you want to run your own client and hook into an already initialized one e.g.: Reporting issues to your own sentry when running in your component while still using the users configuration.
Updates user context information for future events.
User context object to be set in the current context. Pass null
to unset the user.
Starts a new Session
, sets on the current scope and returns it.
To finish a session
, it has to be passed directly to client.captureSession
, which is done automatically
when using hub.endSession()
for the session currently stored on the scope.
When there's already an existing session on the scope, it'll be automatically ended.
Optional
context: SessionOptional properties of the new Session
.
The session which was just started
Starts a new Transaction
and returns it. This is the entry point to manual tracing instrumentation.
A tree structure can be built by adding child spans to the transaction, and child spans to other spans. To start a
new child span within the transaction or any span, call the respective .startChild()
method.
Every child span must be finished before the transaction is finished, otherwise the unfinished spans are discarded.
The transaction must be finished with a call to its .finish()
method, at which point the transaction with all its
finished child spans will be sent to Sentry.
Properties of the new Transaction
.
Optional
customSamplingContext: CustomSamplingContextInformation given to the transaction sampling function (along with context-dependent default values). See tracesSampler.
The transaction which was just started
Creates a new scope with and executes the given operation within. The scope is automatically removed once the operation finishes or throws.
This is essentially a convenience function for:
pushScope();
callback();
popScope();
that will be enclosed into push/popScope.
Generated using TypeDoc
Internal class used to make sure we always have the latest internal functions working in case we have a version conflict.