Struct sentry::Client

source ·

pub struct Client { /* private fields */ }

Expand description

The Sentry Client.

The Client is responsible for event processing and sending events to the sentry server via the configured Transport. It can be created from a ClientOptions.

See the Unified API document for more details.

§Examples

sentry::Client::from(sentry::ClientOptions::default());

Implementations§

source §

impl Client

This impl block contains no items.

Determine whether the new transaction should be sampled.

source §

impl Client

source

pub fn from_config<O>(opts: O) -> Client
where O: Into<ClientOptions>,

Creates a new Sentry client from a config.

§Supported Configs

The following common values are supported for the client config:

ClientOptions: configure the client with the given client options.
() or empty string: Disable the client.
&str / String / &OsStr / String: configure the client with the given DSN.
Dsn / &Dsn: configure the client with a given DSN.
(Dsn, ClientOptions): configure the client from the given DSN and optional options.

The Default implementation of ClientOptions pulls in the DSN from the SENTRY_DSN environment variable.

§Panics

The Into<ClientOptions> implementations can panic for the forms where a DSN needs to be parsed. If you want to handle invalid DSNs you need to parse them manually by calling parse on it and handle the error.

source

pub fn with_options(options: ClientOptions) -> Client

Creates a new sentry client for the given options.

If the DSN on the options is set to None the client will be entirely disabled.

source

pub fn options(&self) -> &ClientOptions

Returns the options of this client.

source

pub fn dsn(&self) -> Option<&Dsn>

Returns the DSN that constructed this client.

source

pub fn is_enabled(&self) -> bool

Quick check to see if the client is enabled.

The Client is enabled if it has a valid DSN and Transport configured.

§Examples

use std::sync::Arc;

let client = sentry::Client::from(sentry::ClientOptions::default());
assert!(!client.is_enabled());

let dsn = "https://public@example.com/1";
let transport = sentry::test::TestTransport::new();
let client = sentry::Client::from((
    dsn,
    sentry::ClientOptions {
        transport: Some(Arc::new(transport)),
        ..Default::default()
    },
));
assert!(client.is_enabled());

source

pub fn capture_event( &self, event: Event<'static>, scope: Option<&Scope> ) -> Uuid

Captures an event and sends it to sentry.

source

pub fn send_envelope(&self, envelope: Envelope)

Sends the specified Envelope to sentry.

source

pub fn add_metric(&self, metric: Metric)

Captures a metric and sends it to Sentry on the next flush.

source

pub fn flush(&self, timeout: Option<Duration>) -> bool

Drains all pending events without shutting down.

source

pub fn close(&self, timeout: Option<Duration>) -> bool

Drains all pending events and shuts down the transport behind the client. After shutting down the transport is removed.

This returns true if the queue was successfully drained in the given time or false if not (for instance because of a timeout). If no timeout is provided the client will wait for as long a shutdown_timeout in the client options.

source