Skip to content
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion docs/concepts/key-terms/sample-rates.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Some of the options below aren't available in every SDK; check out our platform-

### Tracing

- **tracesSampleRate** - A number between 0 and 1, controlling the percentage chance a given transaction will be sent to Sentry. (0 represents 0% while 1 represents 100%.) Applies equally to all transactions created in the app. Either this or `tracesSampler` must be defined to enable tracing.
- **tracesSampleRate** - A number between `0` and `1`, controlling the percentage chance a given transaction will be sent to Sentry. (`0` represents 0% while `1` represents 100%.) Applies equally to all transactions created in the app. Either this or `tracesSampler` must be defined to enable tracing.

- **tracesSampler** - A function responsible for determining the percentage chance a given transaction will be sent to Sentry. It will automatically be passed information about the transaction and the context in which it's being created, and must return a number between 0 (0% chance of being sent) and 1 (100% chance of being sent). Can also be used for filtering transactions, by returning 0 for those that are unwanted. Either this or `tracesSampleRate` must be defined to enable tracing.

Expand Down
17 changes: 7 additions & 10 deletions docs/platforms/android/configuration/options.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,18 @@
---
title: Basic Options
description: "Learn more about how to configure the SDK. These options are set when the SDK is first initialized, passed to the init function as an object."
title: Options
description: "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."
sidebar_order: 1
---

SDKs are configurable using a variety of options. The options are largely standardized among SDKs, but there are some differences to better accommodate platform peculiarities. Options are set when the SDK is first
initialized.

<PlatformContent includePath="configuration/config-intro" />

## Common Options
## Core Options

The list of common options across SDKs. These work more or less the same in all SDKs, but some subtle differences will exist to better support the platform. Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically.
Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically.

<ConfigKey name="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.
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.

In runtimes without a process environment (such as the browser) that fallback does not apply.

Expand Down Expand Up @@ -276,7 +273,7 @@ Controls how many seconds to wait before shutting down. Sentry SDKs send events

<ConfigKey name="traces-sample-rate">

A number between 0 and 1, controlling the percentage chance a given transaction will be sent to Sentry. (0 represents 0% while 1 represents 100%.) Applies equally to all transactions created in the app. Either this or <PlatformIdentifier name="traces-sampler" /> must be defined to enable tracing.
A number between `0` and `1`, controlling the percentage chance a given transaction will be sent to Sentry. (`0` represents 0% while `1` represents 100%.) Applies equally to all transactions created in the app. Either this or <PlatformIdentifier name="traces-sampler" /> must be defined to enable tracing.

</ConfigKey>

Expand Down Expand Up @@ -308,7 +305,7 @@ Set this boolean to `false` to disable tracing for `OPTIONS` requests. This opti

<ConfigKey name="profiles-sample-rate">

A number between 0 and 1, controlling the percentage chance a given profile will be sent to Sentry. (0 represents 0% while 1 represents 100%.) Applies only to sampled transactions created in the app. Either this or <PlatformIdentifier name="profiles-sampler" /> must be defined to enable profiling.
A number between `0` and `1`, controlling the percentage chance a given profile will be sent to Sentry. (`0` represents 0% while `1` represents 100%.) Applies only to sampled transactions created in the app. Either this or <PlatformIdentifier name="profiles-sampler" /> must be defined to enable profiling.

</ConfigKey>

Expand Down
15 changes: 6 additions & 9 deletions docs/platforms/apple/common/configuration/options.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,18 @@
---
title: Basic Options
description: "Learn more about how to configure the SDK. These options are set when the SDK is first initialized, passed to the init function as an object."
title: Options
description: "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."
sidebar_order: 1
---

SDKs are configurable using a variety of options. The options are largely standardized among SDKs, but there are some differences to better accommodate platform peculiarities. Options are set when the SDK is first
initialized.

<PlatformContent includePath="configuration/config-intro" />

## Common Options
## Core Options

The list of common options across SDKs. These work more or less the same in all SDKs, but some subtle differences will exist to better support the platform. Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically.
Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically.

<ConfigKey name="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.
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.

In runtimes without a process environment (such as the browser) that fallback does not apply.

Expand Down Expand Up @@ -244,7 +241,7 @@ The callback typically gets a second argument (called a "hint") which contains t

<ConfigKey name="traces-sample-rate">

A number between 0 and 1, controlling the percentage chance a given transaction will be sent to Sentry. (0 represents 0% while 1 represents 100%.) Applies equally to all transactions created in the app. Either this or <PlatformIdentifier name="traces-sampler" /> must be defined to enable tracing.
A number between `0` and `1`, controlling the percentage chance a given transaction will be sent to Sentry. (`0` represents 0% while `1` represents 100%.) Applies equally to all transactions created in the app. Either this or <PlatformIdentifier name="traces-sampler" /> must be defined to enable tracing.

</ConfigKey>

Expand Down
15 changes: 6 additions & 9 deletions docs/platforms/dart/configuration/options.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,18 @@
---
title: Basic Options
description: "Learn more about how to configure the SDK. These options are set when the SDK is first initialized, passed to the init function as an object."
title: Options
description: "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."
sidebar_order: 1
---

SDKs are configurable using a variety of options. The options are largely standardized among SDKs, but there are some differences to better accommodate platform peculiarities. Options are set when the SDK is first
initialized.

<PlatformContent includePath="configuration/config-intro" />

## Common Options
## Core Options

The list of common options across SDKs. These work more or less the same in all SDKs, but some subtle differences will exist to better support the platform. Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically.
Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically.

<ConfigKey name="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.
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.

In runtimes without a process environment (such as the browser) that fallback does not apply.

Expand Down Expand Up @@ -201,7 +198,7 @@ Switches out the transport used to send events. How this works depends on the SD

<ConfigKey name="traces-sample-rate">

A number between 0 and 1, controlling the percentage chance a given transaction will be sent to Sentry. (0 represents 0% while 1 represents 100%.) Applies equally to all transactions created in the app. Either this or <PlatformIdentifier name="traces-sampler" /> must be defined to enable tracing.
A number between `0` and `1`, controlling the percentage chance a given transaction will be sent to Sentry. (`0` represents 0% while `1` represents 100%.) Applies equally to all transactions created in the app. Either this or <PlatformIdentifier name="traces-sampler" /> must be defined to enable tracing.

</ConfigKey>

Expand Down
15 changes: 6 additions & 9 deletions docs/platforms/dotnet/common/configuration/options.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,18 @@
---
title: Basic Options
description: "Learn more about how to configure the SDK. These options are set when the SDK is first initialized, passed to the init function as an object."
title: Options
description: "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."
sidebar_order: 1
---

SDKs are configurable using a variety of options. The options are largely standardized among SDKs, but there are some differences to better accommodate platform peculiarities. Options are set when the SDK is first
initialized.

<PlatformContent includePath="configuration/config-intro" />

## Common Options
## Core Options

The list of common options across SDKs. These work more or less the same in all SDKs, but some subtle differences will exist to better support the platform. Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically.
Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically.

<ConfigKey name="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.
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.

In runtimes without a process environment (such as the browser) that fallback does not apply.

Expand Down Expand Up @@ -292,7 +289,7 @@ Controls how many seconds to wait before shutting down. Sentry SDKs send events

<ConfigKey name="traces-sample-rate">

A number between 0 and 1, controlling the percentage chance a given transaction will be sent to Sentry. (0 represents 0% while 1 represents 100%.) Applies equally to all transactions created in the app. Either this or <PlatformIdentifier name="traces-sampler" /> must be defined to enable tracing.
A number between `0` and `1`, controlling the percentage chance a given transaction will be sent to Sentry. (`0` represents 0% while `1` represents 100%.) Applies equally to all transactions created in the app. Either this or <PlatformIdentifier name="traces-sampler" /> must be defined to enable tracing.

</ConfigKey>

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/elixir/configuration/logging.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Logs & Process Crashes
description: "Learn more about how to configure the SDK. These options are set when the SDK is first initialized, passed to the init function as an object."
description: "Learn more about how to configure the SDK. These options are set when the SDK is first initialized, passed to the init function."
sidebar_order: 50
---

Expand Down
13 changes: 5 additions & 8 deletions docs/platforms/elixir/configuration/options.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,18 @@
---
title: Basic Options
description: "Learn more about how to configure the SDK. These options are set when the SDK is first initialized, passed to the init function as an object."
title: Options
description: "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."
sidebar_order: 1
---

SDKs are configurable using a variety of options. The options are largely standardized among SDKs, but there are some differences to better accommodate platform peculiarities. Options are set when the SDK is first
initialized.

<PlatformContent includePath="configuration/config-intro" />

## Common Options
## Core Options

The list of common options across SDKs. These work more or less the same in all SDKs, but some subtle differences will exist to better support the platform. Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically.
Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically.

<ConfigKey name="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.
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.

In runtimes without a process environment (such as the browser) that fallback does not apply.

Expand Down
15 changes: 6 additions & 9 deletions docs/platforms/flutter/configuration/options.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,18 @@
---
title: Basic Options
description: "Learn more about how to configure the SDK. These options are set when the SDK is first initialized, passed to the init function as an object."
title: Options
description: "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."
sidebar_order: 1
---

SDKs are configurable using a variety of options. The options are largely standardized among SDKs, but there are some differences to better accommodate platform peculiarities. Options are set when the SDK is first
initialized.

<PlatformContent includePath="configuration/config-intro" />

## Common Options
## Core Options

The list of common options across SDKs. These work more or less the same in all SDKs, but some subtle differences will exist to better support the platform. Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically.
Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically.

<ConfigKey name="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.
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.

In runtimes without a process environment (such as the browser) that fallback does not apply.

Expand Down Expand Up @@ -236,7 +233,7 @@ Switches out the transport used to send events. How this works depends on the SD

<ConfigKey name="traces-sample-rate">

A number between 0 and 1, controlling the percentage chance a given transaction will be sent to Sentry. (0 represents 0% while 1 represents 100%.) Applies equally to all transactions created in the app. Either this or <PlatformIdentifier name="traces-sampler" /> must be defined to enable tracing.
A number between `0` and `1`, controlling the percentage chance a given transaction will be sent to Sentry. (`0` represents 0% while `1` represents 100%.) Applies equally to all transactions created in the app. Either this or <PlatformIdentifier name="traces-sampler" /> must be defined to enable tracing.

</ConfigKey>

Expand Down
7 changes: 2 additions & 5 deletions docs/platforms/go/common/configuration/options.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
---
title: Basic Options
title: Options
sidebar_order: 0
description: "Learn more about how to configure the SDK. These options are set when the SDK is first initialized, passed to the init method as an object."
description: "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."
---

SDKs are configurable using a variety of options. The options are largely standardized among SDKs, but there are some differences to better accommodate platform peculiarities. Options are set when the SDK is first
initialized.

<PlatformContent includePath="configuration/config-intro" />

```go
Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/go/legacy-sdk/config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ as well as helping you streamline your error tracking.

### `SetDSN`

The _DSN_ tells the SDK where to send the events. This option is always required
The DSN tells the SDK where to send the events. This option is always required
and the Sentry Go SDKs can pick this up from an environment variable (`SENTRY_DSN`).
When set to an empty string, SDK won't send any events to Sentry, and all `Capture*` methods
will effectively act as no-ops.
Expand Down
Loading
Loading