From e687544289e7e32cea93acb0536f29a594a137be Mon Sep 17 00:00:00 2001 From: Karl Heinz Struggl Date: Thu, 19 Dec 2024 14:50:36 -0800 Subject: [PATCH 01/10] fix: Removes duplicate feature descriptions (#12191) --- docs/platforms/android/index.mdx | 2 -- docs/platforms/apple/common/index.mdx | 2 -- 2 files changed, 4 deletions(-) diff --git a/docs/platforms/android/index.mdx b/docs/platforms/android/index.mdx index fa10c726d5718..52b39b1be027c 100644 --- a/docs/platforms/android/index.mdx +++ b/docs/platforms/android/index.mdx @@ -49,8 +49,6 @@ Select which Sentry features you'd like to install in addition to Error Monitori Sentry captures data by using an SDK within your application's runtime. These are platform-specific and allow Sentry to have a deep understanding of how your application works. -In addition to capturing errors, you can monitor interactions between multiple services or applications by [enabling tracing](https://docs.sentry.io/concepts/key-terms/tracing/). You can also collect and analyze performance profiles from real users with [profiling](https://docs.sentry.io/product/explore/profiling/). To enable tracing and/or profiling, click the corresponding checkmarks to get the code snippets. - We recommend installing the SDK through our [Sentry Wizard](https://github.com/getsentry/sentry-wizard) by running the following command inside your project directory: ```bash diff --git a/docs/platforms/apple/common/index.mdx b/docs/platforms/apple/common/index.mdx index 8c357e9873029..3c7d1d8aea887 100644 --- a/docs/platforms/apple/common/index.mdx +++ b/docs/platforms/apple/common/index.mdx @@ -34,8 +34,6 @@ Select which Sentry features you'd like to install in addition to Error Monitori Sentry captures data by using an SDK within your application's runtime. These are platform-specific and allow Sentry to have a deep understanding of how your application works. -In addition to capturing errors, you can monitor interactions between multiple services or applications by [enabling tracing](https://docs.sentry.io/concepts/key-terms/tracing/). You can also collect and analyze performance profiles from real users with [profiling](https://docs.sentry.io/product/profiling/). To enable tracing and/or profiling, click the corresponding checkmarks to get the code snippets. - We recommend installing the SDK with Swift Package Manager (SPM), but we also support alternate [installation methods](install/). To integrate Sentry into your Xcode project, open your App in Xcode and open **File > Add Packages**. Then add the SDK by entering the git repo url in the top right search field: From 649dcd9797231ede120fd03712e1e566ca974b8d Mon Sep 17 00:00:00 2001 From: Karl Heinz Struggl Date: Thu, 19 Dec 2024 14:54:07 -0800 Subject: [PATCH 02/10] chore(Apple): Show Profiling only on supported platforms' landing pages (#12192) * fixes duplicate feature descriptions * fix snippets, show profiling only where supported --- docs/platforms/apple/common/index.mdx | 126 +++++++++++++++++++++----- 1 file changed, 101 insertions(+), 25 deletions(-) diff --git a/docs/platforms/apple/common/index.mdx b/docs/platforms/apple/common/index.mdx index 3c7d1d8aea887..78ba49ba5e5be 100644 --- a/docs/platforms/apple/common/index.mdx +++ b/docs/platforms/apple/common/index.mdx @@ -18,19 +18,34 @@ The support for [visionOS](https://developer.apple.com/visionos/) is currently e ## Features + + In addition to capturing errors, you can monitor interactions between multiple services or applications by [enabling tracing](/concepts/key-terms/tracing/). You can also collect and analyze performance profiles from real users with [profiling](/product/explore/profiling/). + + + + +In addition to capturing errors, you can monitor interactions between multiple services or applications by [enabling tracing](/concepts/key-terms/tracing/). + + + Select which Sentry features you'd like to install in addition to Error Monitoring to get the corresponding installation and configuration instructions below. ## Install - + + + + + + + + + + + + Sentry captures data by using an SDK within your application's runtime. These are platform-specific and allow Sentry to have a deep understanding of how your application works. @@ -70,8 +85,9 @@ If you prefer, you can also [set up the SDK manually](/platforms/apple/guides/io To capture all errors, initialize the SDK as soon as possible, such as in your `AppDelegate` `application:didFinishLaunchingWithOptions` method: + -```swift {tabTitle:Swift} {"onboardingOptions": {"performance": "9-12", "profiling": "13-16"}} +```swift {tabTitle:Swift} {"onboardingOptions": {"performance": "9-12", "profiling": "14-24"}} import Sentry func application(_ application: UIApplication, @@ -86,22 +102,22 @@ func application(_ application: UIApplication, options.tracesSampleRate = 1.0 } - // Manually call startProfiler and stopProfiler to profile any code that runs in between. - SentrySDK.startProfiler() + // Manually call startProfiler and stopProfiler to profile any code that runs in between. + SentrySDK.startProfiler() - // - // ...anything here will be profiled... - // + // + // ...anything here will be profiled... + // - // Calls to stopProfiler are optional - if you don't stop the profiler, it will keep profiling - // your application until the process exits, the app goes to the background, or stopProfiling is called. - SentrySDK.stopProfiler() + // Calls to stopProfiler are optional - if you don't stop the profiler, it will keep profiling + // your application until the process exits, the app goes to the background, or stopProfiling is called. + SentrySDK.stopProfiler() return true } ``` -```objc {tabTitle:Objective-C} {"onboardingOptions": {"performance": "8-11", "profiling": "12-15"}} +```objc {tabTitle:Objective-C} {"onboardingOptions": {"performance": "8-11", "profiling": "13-23"}} @import Sentry; - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { @@ -115,16 +131,16 @@ func application(_ application: UIApplication, options.tracesSampleRate = @1.0; }]; - // Manually call startProfiler and stopProfiler to profile any code that runs in between. - [SentrySDK startProfiler]; + // Manually call startProfiler and stopProfiler to profile any code that runs in between. + [SentrySDK startProfiler]; - // - // ...anything here will be profiled... - // + // + // ...anything here will be profiled... + // - // Calls to stopProfiler are optional - if you don't stop the profiler, it will keep profiling - // your application until the process exits, the app goes to the background, or stopProfiling is called. - [SentrySDK stopProfiler]; + // Calls to stopProfiler are optional - if you don't stop the profiler, it will keep profiling + // your application until the process exits, the app goes to the background, or stopProfiling is called. + [SentrySDK stopProfiler]; return YES; } @@ -151,6 +167,66 @@ struct SwiftUIApp: App { } } ``` + + + + +```swift {tabTitle:Swift} {"onboardingOptions": {"performance": "9-12"}} +import Sentry + +func application(_ application: UIApplication, + didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool { + + SentrySDK.start { options in + options.dsn = "___PUBLIC_DSN___" + options.debug = true // Enabled debug when first installing is always helpful + + // Set tracesSampleRate to 1.0 to capture 100% of transactions for performance monitoring. + // We recommend adjusting this value in production. + options.tracesSampleRate = 1.0 + } + + return true +} +``` + +```objc {tabTitle:Objective-C} {"onboardingOptions": {"performance": "8-11"}} +@import Sentry; + +- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { + + [SentrySDK startWithConfigureOptions:^(SentryOptions *options) { + options.dsn = @"___PUBLIC_DSN___"; + options.debug = YES; // Enabled debug when first installing is always helpful + + // Set tracesSampleRate to 1.0 to capture 100% of transactions for performance monitoring. + // We recommend adjusting this value in production. + options.tracesSampleRate = @1.0; + }]; + + return YES; +} +``` + +```swift {tabTitle:SwiftUI with App conformer} {"onboardingOptions": {"performance": "9-12"}} +import Sentry + +@main +struct SwiftUIApp: App { + init() { + SentrySDK.start { options in + options.dsn = "___PUBLIC_DSN___" + options.debug = true // Enabled debug when first installing is always helpful + + // Set tracesSampleRate to 1.0 to capture 100% of transactions for performance monitoring. + // We recommend adjusting this value in production. + options.tracesSampleRate = 1.0 + } + } +} +``` + + ## Verify From 6db67a611450c8ed5b877216c36b75df76ae9157 Mon Sep 17 00:00:00 2001 From: Bruno Garcia Date: Thu, 19 Dec 2024 18:26:33 -0500 Subject: [PATCH 03/10] unreal: Improve environment doc (#12062) * unreal: Improve environment doc * Update docs/platforms/unreal/configuration/environments.mdx --- .../unreal/configuration/environments.mdx | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/docs/platforms/unreal/configuration/environments.mdx b/docs/platforms/unreal/configuration/environments.mdx index f531dd4c1e68e..b9d9a03caed06 100644 --- a/docs/platforms/unreal/configuration/environments.mdx +++ b/docs/platforms/unreal/configuration/environments.mdx @@ -4,14 +4,14 @@ description: "Learn how to configure your SDK to tell Sentry about your environm sidebar_order: 30 --- -Environments tell you where an error occurred, whether that's in your production system, your staging server, or elsewhere. -It help you better filter issues, releases, and user feedback in the Issue Details page of sentry.io, which you learn more about in our [documentation that covers using environments](/product/sentry-basics/environments/). +Environments in Sentry let you know where an error occurred, (such as in production, staging server, or another location). +They make it easier to filter issues, releases, and user feedback on the Issue Details page, (which you can navigate to by clicking any issue on the [**Issues**](https://sentry.io/orgredirect/organizations/:orgslug/issues/) page). To learn more, read our docs about [using environments](/product/sentry-basics/environments/). Sentry automatically creates an environment when it receives an event with the `environment` parameter set. -By default, the SDK reports `Editor` when running inside the Unreal Engine Editor. -For shipping builds it'll use `Release` and in other configurations it'll use `FApp::GetBuildConfiguration()` -You can also set the default environment to `Release`, `Development`, or `Debug` in your build configuration or override the environment value programatically. +When running inside the Unreal Engine Editor, the SDK reports the environment as `Editor`. For shipping builds, it defaults to `Release`. +In other configurations it uses the `FApp::GetBuildConfiguration()`. +You can also set the default environment to `Release`, `Development`, or `Debug` in your build configuration, or override it programmatically. ```cpp FConfigureSettingsDelegate SettingsDelegate; @@ -29,4 +29,11 @@ USentrySubsystem* SentrySubsystem = GEngine->GetEngineSubsystemInitializeWithSettings(SettingsDelegate); ``` -Environments are case-sensitive. The environment name can't contain newlines, spaces or forward slashes, can't be the string "None", or exceed 64 characters. You can't delete environments, but you can [hide](/product/sentry-basics/environments/#hidden-environments) them. +**Important things to note about environments:** + + - Environment names are case-sensitive. + - Names cannot include new lines, spaces, or forward slashes. + - Certain strings, like "None", aren't allowed. + - The maximum length for an environment name is 64 characters. + - Environments can't be deleted, but can be [hidden](/product/sentry-basics/environments/#hidden-environments) if no longer needed. + From bf4123f3c59c434be1d39a7907827667fa973838 Mon Sep 17 00:00:00 2001 From: Charly Gomez Date: Fri, 20 Dec 2024 13:34:19 +0100 Subject: [PATCH 04/10] feat(platform): Kapa.ai integration (#11935) --- app/layout.tsx | 11 +++++++ src/components/search/index.tsx | 52 ++++++++++++++++++--------------- vercel.json | 4 +-- 3 files changed, 42 insertions(+), 25 deletions(-) diff --git a/app/layout.tsx b/app/layout.tsx index be767d6f9b824..3d456147f5c81 100644 --- a/app/layout.tsx +++ b/app/layout.tsx @@ -49,6 +49,17 @@ export default function RootLayout({children}: {children: React.ReactNode}) { data-api="https://plausible.io/api/event" src="https://plausible.io/js/script.tagged-events.js" /> +