Options
Learn more about how the SDK can be configured via options. These are being passed to the init function and therefore set when the SDK is first initialized.
Options are passed to the init() function as tuple where the first argument is the DSN and the second the options:
Additionally, the release_name macro automatically generates the expected release based on the cargo metadata.
let _guard = sentry::init(("https://examplePublicKey@o0.ingest.sentry.io/0", sentry::ClientOptions {
release: sentry::release_name!(),
max_breadcrumbs: 50,
debug: true, // <- this should only be used during development
..Default::default()
}));
Options that can be read from an environment variable (SENTRY_DSN, SENTRY_ENVIRONMENT, SENTRY_RELEASE) are read automatically.
dsn
| Type | string |
|---|---|
| ENV Variable | SENTRY_DSN |
The DSN tells the SDK where to send the events. If this value is not provided, the SDK will try to read it from the SENTRY_DSN environment variable. If that variable also does not exist, the SDK will just not send any events.
Learn more about DSN utilization.
debug
| Type | bool |
|---|---|
| Default | false |
Turns debug mode on or off. If debug is enabled, the SDK will attempt to print out useful debugging information if something goes wrong while sending the event. While it's generally not recommended to turn debug mode on in production, it won't create any security concerns.
release
| Type | string |
|---|---|
| ENV Variable | SENTRY_RELEASE |
Sets the release. This string is freeform and not set by default. Some formats are detected by Sentry and might be rendered differently. Learn more about how to send release data so Sentry can tell you about regressions between releases and identify the potential source in the releases documentation or the sandbox.
environment
| Type | string |
|---|---|
| ENV Variable | SENTRY_ENVIRONMENT |
Sets the environment. This string is freeform and not set by default. A release can be associated with more than one environment to separate them in the UI (think staging vs prod or similar).
By default the SDK will try to read this value from the SENTRY_ENVIRONMENT environment variable. If that is not present, this value will be set to development if debug assertions are enabled, otherwise to production.
max_breadcrumbs
| Type | usize |
|---|---|
| Default | 100 |
This variable controls the total amount of breadcrumbs that should be captured. This defaults to 100, but you can set this to any number. However, you should be aware that Sentry has a maximum payload size and any events exceeding that payload size will be dropped.
attach_stacktrace
| Type | bool |
|---|---|
| Default | false |
When enabled, stack traces are automatically attached to all messages logged. Stack traces are always attached to exceptions; however, when this option is set, stack traces are also sent with messages. This option, for instance, means that stack traces appear next to all log messages.
This option is turned off by default.
Grouping in Sentry is different for events with stack traces and without. As a result, you will get new groups as you enable or disable this flag for certain events.
send_default_pii
| Type | bool |
|---|---|
| Default | false |
If this flag is enabled, certain personally identifiable information (PII) is added by active integrations. By default, no such data is sent.
If you enable this option, be sure to manually remove what you don't want to send using our features for managing Sensitive Data.
in_app_include
| Type | Vec<&'static str> |
|---|
A list of string prefixes of module names that belong to the app. This option takes precedence over in_app_exclude.
Sentry differentiates stack frames that are directly related to your application ("in application") from stack frames that come from other packages such as the standard library, frameworks, or other dependencies. The application package is automatically marked as inApp. The difference is visible in sentry.io, where only the "in application" frames are displayed by default.
in_app_exclude
| Type | Vec<&'static str> |
|---|
A list of string prefixes of module names that do not belong to the app, but rather to third-party packages. Modules considered not part of the app will be hidden from stack traces by default.
This option can be overridden using in_app_include.
before_breadcrumb
| Type | Fn |
|---|
This function is called with an SDK-specific breadcrumb object before the breadcrumb is added to the scope. When None is returned from the function, the breadcrumb is dropped. To pass the breadcrumb through, return the first argument, which contains the breadcrumb object. The callback typically gets a second argument (called a "hint"), which contains the original object from which the breadcrumb was created to further customize what the breadcrumb should look like.
sample_rate
| Type | f32 |
|---|---|
| Default | 1.0 |
Configures the sample rate for error events, in the range of 0.0 to 1.0. The default is 1.0, which means that 100% of error events will be sent. If set to 0.1, only 10% of error events will be sent. Events are picked randomly.
before_send
| Type | Fn |
|---|
This function is called with an SDK-specific message or error event object, and can return a modified event object, or None to skip reporting the event. This can be used, for instance, for manual PII stripping before sending.
By the time before_send is executed, all scope data has already been applied to the event. Further modification of the scope won't have any effect.
traces_sample_rate
| Type | f32 |
|---|---|
| Default | 0.0 |
A number between 0.0 and 1.0, controlling the percentage chance a given transaction will be sent to Sentry (0.0 represents 0% while 1.0 represents 100%.) Applies equally to all transactions created in the app.
http_proxy
| Type | string |
|---|---|
| ENV Variable | HTTP_PROXY |
When set, a proxy can be configured that should be used for outbound requests. This is also used for HTTPS requests unless a separate https_proxy is configured. However, not all SDKs support a separate HTTPS proxy. SDKs will attempt to default to the system-wide configured proxy, if possible. For instance, on Unix systems, the HTTP_PROXY environment variable will be picked up.
https_proxy
| Type | string |
|---|---|
| ENV Variable | HTTPS_PROXY |
Configures a separate proxy for outgoing HTTPS requests. If this option is not provided but http_proxy is, then http_proxy is used for HTTPS requests too.
accept_invalid_certs
| Type | bool |
|---|---|
| ENV Variable | SSL_VERIFY |
Setting this to true disables SSL certificate validation when sending outbound requests to Sentry. This should never be enabled when using the SDK in your real codebase or otherwise handling any kind of sensitive or personally identifiable information, as it could be exposed to potential attackers.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").