Skip to content
Open
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
1 change: 1 addition & 0 deletions docs/platforms/elixir/configuration/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Configuration
description: "Additional configuration options for the SDK."
sidebar_order: 5
sidebar_section: configuration
---

<PageGrid />
1 change: 1 addition & 0 deletions docs/platforms/elixir/crons/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Set Up Crons
sidebar_title: Crons
description: "Sentry Crons allows you to monitor the uptime and performance of any scheduled, recurring job in your application."
sidebar_order: 5750
sidebar_section: features
---

Once implemented, it'll allow you to get alerts and metrics to help you solve errors, detect timeouts, and prevent disruptions to your service.
Expand Down
1 change: 1 addition & 0 deletions docs/platforms/elixir/data-management/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Data Management
description: Manage your events by pre-filtering, scrubbing sensitive information, and forwarding them to other systems.
sidebar_order: 2500
sidebar_section: configuration
---

<PageGrid />
1 change: 1 addition & 0 deletions docs/platforms/elixir/enriching-events/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Enriching Events
description: Enrich events with additional context to make debugging simpler.
sidebar_order: 2300
sidebar_section: configuration
---

<PageGrid />
1 change: 1 addition & 0 deletions docs/platforms/elixir/integrations/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Integrations
description: "Sentry provides additional integrations designed to change configuration or add instrumentation to your application."
sidebar_order: 40
sidebar_section: configuration
---

The Sentry SDK uses integrations to hook into the functionality of popular libraries to automatically capture errors and collect additional context.
Expand Down
7 changes: 4 additions & 3 deletions docs/platforms/elixir/migration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@
title: Migration Guides
sidebar_order: 8000
description: "Learn about migrating to a newer version of the Elixir SDK."
sidebar_section: configuration
---

The migration guides for older versions of the Elixir SDK are available over on hexdocs.

* [Upgrade to Sentry 8.x](https://hexdocs.pm/sentry/upgrade-8-x.html)
* [Upgrade to Sentry 9.x](https://hexdocs.pm/sentry/upgrade-9-x.html)
* [Upgrade to Sentry 10.x](https://hexdocs.pm/sentry/upgrade-10-x.html)
- [Upgrade to Sentry 8.x](https://hexdocs.pm/sentry/upgrade-8-x.html)
- [Upgrade to Sentry 9.x](https://hexdocs.pm/sentry/upgrade-9-x.html)
- [Upgrade to Sentry 10.x](https://hexdocs.pm/sentry/upgrade-10-x.html)
1 change: 1 addition & 0 deletions docs/platforms/elixir/security-policy-reporting/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Set Up Security Policy Reporting
sidebar_title: Security Policy Reporting
sidebar_order: 7500
description: "Learn how Sentry can help manage Content-Security-Policy violations and reports here."
sidebar_section: configuration
---

<Include name="platforms/security-policy-reporting/content.mdx" />
1 change: 1 addition & 0 deletions docs/platforms/elixir/tracing/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Set Up Tracing
sidebar_title: Tracing
description: "Learn how to enable tracing in your app and discover valuable performance insights of your application."
sidebar_order: 30
sidebar_section: features
---

With [tracing](/product/insights/overview/), Sentry tracks your software performance, measuring metrics like throughput and latency, and displaying the impact of errors across multiple systems.
Expand Down
1 change: 1 addition & 0 deletions docs/platforms/elixir/usage/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Usage
description: "Use the SDK to manually capture errors and other events."
sidebar_order: 10
sidebar_section: features
---

Sentry's SDK hooks into your runtime environment and automatically reports errors, uncaught exceptions, and unhandled rejections as well as other types of errors depending on the platform.
Expand Down
1 change: 1 addition & 0 deletions docs/platforms/elixir/user-feedback/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Set Up User Feedback
sidebar_title: User Feedback
description: "Learn more about collecting user feedback when an event occurs. Sentry pairs the feedback with the original event, giving you additional insight into issues."
sidebar_order: 6000
sidebar_section: features
---

When a user experiences an error, Sentry provides the ability to collect additional feedback. You can collect feedback according to the method supported by the SDK.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Configuration
title: Basic Configuration
description: "Additional configuration options for the SDK."
sidebar_order: 20
sidebar_section: configuration
---

<PageGrid />
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ notSupported:
- kotlin
sidebar_order: 4000
description: Manage your events by pre-filtering, scrubbing sensitive information, and forwarding them to other systems.
sidebar_section: configuration
---

<PageGrid />
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Upload Debug Symbols
description: "Learn more about how to upload debug symbols in Sentry Kotlin Multiplatform."
sidebar_order: 6
sidebar_section: features
---

To symbolicate your stack traces, you need to provide debug information to Sentry.
Expand All @@ -28,7 +29,7 @@ sentry {
autoInstallation {
enabled.set(false)
}

// The slug of the Sentry organization to use for uploading proguard mappings/source contexts.
org.set("___ORG_SLUG___")

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Enriching Events
description: Enrich events with additional context to make debugging simpler.
sidebar_order: 2300
sidebar_section: configuration
---

<PageGrid />
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Features
sidebar_order: 1
description: "Learn about the features of Sentry's Kotlin Multiplatform SDK."
sidebar_section: features
---

Sentry's Kotlin Multiplatform SDK enables automatic reporting of errors and exceptions.
Expand All @@ -15,6 +16,7 @@ Because the SDK provides a unified API for all supported platforms directly leve
Some functionality may not be available in the shared Kotlin Multiplatform layer yet. You may have to use the native SDKs directly, or write your own platform-specific code.

To access the native SDK init options, use the [Native Platform Options initialization](/platforms/kotlin/guides/kotlin-multiplatform/initialization-strategies/#native-platform-options).

</Alert>

## Supported Platforms
Expand All @@ -35,8 +37,8 @@ The table below lists supported platforms and their corresponding presets.
You can add these targets to your project and they will compile and satisfy the API surface, but **do nothing at runtime**.

| Target Platform | Target preset |
|---------------|---------------------------------------------------|
| --------------- | ------------------------------------------------- |
| JS | <ul><li>`js`</li></ul> |
| Wasm JS | <ul><li>`wasmJs`</li></ul> |
| Linux | <ul><li>`linuxx64`</li><li>`linuxarm64`</li></ul> |
| Windows | <ul><li>`mingwx64`</li></ul> |
| Windows | <ul><li>`mingwx64`</li></ul> |
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Initialization Options
description: "Different options for initializing the Kotlin Multiplatform SDK."
sidebar_order: 2
sidebar_section: configuration
---

When it comes to initializing a Kotlin Multiplatform SDK, there are multiple options to consider:
Expand All @@ -26,6 +27,7 @@ class YourApplication : Application() {
}
}
```

```swift {tabTitle: iosApp}
import shared

Expand All @@ -49,12 +51,11 @@ struct SwiftUIApp: App {

## Native Platform Options

<Alert>Requires Sentry SDK version `0.7.1` or higher.</Alert>
<Alert>
Requires Sentry SDK version `0.7.1` or higher.
</Alert>
<Alert>
Available options are determined by the native SDK versions used in the build.
For example, Kotlin Multiplatform SDK `0.10.0` uses Sentry Android `7.16.0` and Sentry Cocoa `8.38.0`, so it supports all options from these versions.
Available options are determined by the native SDK versions used in the build.
For example, Kotlin Multiplatform SDK `0.10.0` uses Sentry Android `7.16.0`
and Sentry Cocoa `8.38.0`, so it supports all options from these versions.
</Alert>

This approach involves initializing the SDK with the platform's specific options directly, using `PlatformOptionsConfiguration`. This strategy is ideal for projects that require configuring options that are not yet supported by the KMP SDK, such as experimental options.
Expand Down Expand Up @@ -120,7 +121,6 @@ Using a shared initializer provides a single source of truth for your SDK's conf

To initialize the SDK, create a Kotlin file in your `commonMain` (such as `SentrySetup.kt` or whatever you decide to call it), and write an initialization function. You'll then be able to call it in an early lifecycle stage in your platforms.


```kotlin {filename:SentrySetup.kt}
import io.sentry.kotlin.multiplatform.Sentry
import io.sentry.kotlin.multiplatform.SentryOptions
Expand Down Expand Up @@ -153,7 +153,6 @@ expect fun initializeSentry()

### androidMain


```kotlin {filename:androidMain/SentrySetup.kt}
import io.sentry.kotlin.multiplatform.Sentry
import io.sentry.kotlin.multiplatform.Context
Expand All @@ -168,7 +167,6 @@ actual fun initializeSentry() {

### iosMain


```kotlin {filename:iosMain/SentrySetup.kt}
import io.sentry.kotlin.multiplatform.Sentry
import io.sentry.kotlin.multiplatform.Context
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Troubleshooting
description: "Troubleshoot and resolve edge cases when using Sentry's Kotlin Multiplatform SDK."
sidebar_order: 9000
sidebar_section: configuration
---

This document covers common issues you may encounter when using the Sentry Kotlin Multiplatform SDK and provides steps to troubleshoot.
Expand All @@ -17,7 +18,8 @@ Starting May 1, 2024, Apple requires all apps submitted to the App Store to prov
If you configured the Sentry Kotlin Multiplatform SDK and tests are still failing with the following error: `ld: framework 'Sentry' not found` then follow these steps for the workaround:

<Alert>
This example shows you how to fix the issue for the iOS simulator target, but the same approach can be used for other targets.
This example shows you how to fix the issue for the iOS simulator target, but
the same approach can be used for other targets.
</Alert>

**1. Download the Sentry xcframework**
Expand All @@ -28,6 +30,7 @@ This example shows you how to fix the issue for the iOS simulator target, but th
**2. Create a frameworks directory and insert `Sentry.framework`**

Create a `/Frameworks` directory in the directory where the `test.kexe` resides and put the `Sentry.framework` in it.

- The `Sentry.framework` can be found inside of the `ios-arm64_x86_64-simulator`.
- The `test.kexe` will usually reside in `build/bin/iosSimulatorArm64/debugTest`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Usage
description: "Use the SDK to manually capture errors and other events."
sidebar_order: 5
sidebar_section: features
---

Sentry's SDK hooks into your runtime environment and automatically reports errors, uncaught exceptions, and unhandled rejections as well as other types of errors depending on the platform.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Set Up User Feedback
description: "Learn more about collecting user feedback when an event occurs. Sentry pairs the feedback with the original event, giving you additional insight into issues."
sidebar_order: 6000
sidebar_section: features
---

When a user experiences an error, Sentry provides the ability to collect additional feedback. You can collect feedback according to the method supported by the SDK.
Expand Down
2 changes: 2 additions & 0 deletions docs/platforms/native/advanced-usage/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
title: Advanced Usage
description: "Learn how the Native SDK backends handle errors on their supported platforms and how that affects your usage."
sidebar_order: 11
sidebar_section: configuration
---

This section discusses recurring topics that go beyond what the SDK can abstract away from users.

While not a complete reference, this section covers topics like how different operating systems handle errors and where some platforms don't follow usual standards. Here, we also offer solutions to help users deal with specific platform quirks.
Expand Down
5 changes: 3 additions & 2 deletions docs/platforms/native/common/configuration/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Configuration
title: Basic Configuration
notSupported:
- native.breakpad
- native.crashpad
Expand All @@ -8,7 +8,8 @@ notSupported:
- perl
- kotlin
description: "Additional configuration options for the SDK."
sidebar_order: 5
sidebar_order: 10
sidebar_section: configuration
---

<PageGrid />
3 changes: 2 additions & 1 deletion docs/platforms/native/common/data-management/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Data Management
description: Manage your events by pre-filtering, scrubbing sensitive information, and forwarding them to other systems.
sidebar_order: 2500
sidebar_order: 12
sidebar_section: configuration
---

<PageGrid />
1 change: 1 addition & 0 deletions docs/platforms/native/common/debug-information.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Debug Information
description: "Learn about allowing Sentry to fully process native crashes and provide you with symbolicated stack traces, by uploading Debug Information Files (sometimes also referred to as Debug Symbols or just Symbols)."
sidebar_order: 100
sidebar_section: features
---

To allow Sentry to fully process native crashes and provide you with
Expand Down
1 change: 1 addition & 0 deletions docs/platforms/native/common/enriching-events/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Enriching Events
description: Enrich events with additional context to make debugging simpler.
sidebar_order: 2300
sidebar_section: configuration
notSupported:
- native.breakpad
- native.crashpad
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: Set Up Security Policy Reporting
sidebar_title: Security Policy Reporting
sidebar_order: 7500
sidebar_order: 13
description: "Learn how Sentry can help manage Content-Security-Policy violations and reports here."
sidebar_section: configuration
---

<Include name="platforms/security-policy-reporting/content.mdx" />
1 change: 1 addition & 0 deletions docs/platforms/native/common/tracing/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Set Up Tracing
sidebar_title: Tracing
description: "Learn how to enable tracing in your app and discover valuable performance insights of your application."
sidebar_order: 4000
sidebar_section: features
notSupported:
- native.breakpad
- native.crashpad
Expand Down
1 change: 1 addition & 0 deletions docs/platforms/native/common/usage/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Usage
description: "Use the SDK to manually capture errors and other events."
sidebar_order: 10
sidebar_section: features
notSupported:
- native.breakpad
- native.crashpad
Expand Down
5 changes: 3 additions & 2 deletions docs/platforms/native/configuration/backends/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Backends
sidebar_order: 80
description: Learn more about backends, extending the functionality of the Sentry SDK for crash reporting.
sidebar_section: configuration
---

_Backends_ extend the functionality of the SDK for some common frameworks
Expand All @@ -16,7 +17,7 @@ CMake option, with support for the following options:
It is used as the default on Windows, macOS, and Linux.
- `breakpad`: This uses the in-process breakpad handler.
- `inproc`: A small in-process handler supported on all platforms
and used as a default on Android. It has no longer worked on macOS since version 13 ("Ventura").
and used as a default on Android. It has no longer worked on macOS since version 13 ("Ventura").
- `none`: This builds `sentry-native` without a backend, so it does not handle
crashes. It is primarily used for tests.

Expand All @@ -26,5 +27,5 @@ send a crash to Sentry immediately after it happens. Instead, the crash report i
written to disk and sent the next time the application is run. Since `Crashpad`
runs in a different process, it doesn't have this limitation.

The [Advanced Usage](/platforms/native/advanced-usage/backend-tradeoffs) section
The [Advanced Usage](/platforms/native/advanced-usage/backend-tradeoffs) section
explains the trade-offs in choosing the correct backend for your use case.
1 change: 1 addition & 0 deletions docs/platforms/native/logs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Set Up Logs
sidebar_title: Logs
description: "Structured logs allow you to send, view and query logs sent from your applications within Sentry."
sidebar_order: 5755
sidebar_section: features
---

With Sentry Structured Logs, you can send text-based log information from your applications to Sentry. Once in Sentry, these logs can be viewed alongside relevant errors, searched by text-string, or searched using their individual attributes.
Expand Down
1 change: 1 addition & 0 deletions docs/platforms/native/metrics/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_title: Metrics
description: "Metrics allow you to send, view and query counters, gauges and measurements from your Sentry-configured apps to track application health and drill down into related traces, logs, and errors."
sidebar_order: 5756
beta: true
sidebar_section: features
---

With Sentry Metrics, you can send counters, gauges, and distributions from your applications to Sentry. Once in Sentry, these metrics can be viewed alongside relevant errors, and searched using their individual attributes.
Expand Down
1 change: 1 addition & 0 deletions docs/platforms/native/usage/crashes.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Application Crashes
description: Depending on the backend, the Native SDK can intercept application crashes and report minidumps to Sentry.
sidebar_section: features
---

By default, the Native SDK intercepts crash signals and unhandled exceptions to
Expand Down
1 change: 1 addition & 0 deletions docs/platforms/native/user-feedback/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Set Up User Feedback
sidebar_title: User Feedback
description: "Learn how to view user feedback submissions which, paired with the original event, give you additional insight into issues."
sidebar_order: 6000
sidebar_section: features
---

Sentry makes it possible to collect additional feedback when a user experiences an error. You can collect feedback according to the method supported by your SDK of choice.
Expand Down
Loading