import ExternalLink from 'sentry/components/links/externalLink';
import {Layout, LayoutProps} from 'sentry/components/onboarding/gettingStartedDoc/layout';
import {ModuleProps} from 'sentry/components/onboarding/gettingStartedDoc/sdkDocumentation';
import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/step';
import {t, tct} from 'sentry/locale';
// Configuration Start
export const steps = ({
dsn,
}: {
dsn?: string;
} = {}): LayoutProps['steps'] => [
{
type: StepType.INSTALL,
description: (
{tct(
'We recommend installing the SDK with Swift Package Manager (SPM), but we also support [alternateMethods: alternate installation methods]. To integrate Sentry into your Xcode project using SPM, open your App in Xcode and open [addPackage: File > Add Packages]. Then add the SDK by entering the Git repo url in the top right search field:',
{
alternateMethods: (
),
addPackage: ,
}
)}
),
configurations: [
{
language: 'text',
code: `
https://github.com/getsentry/sentry-cocoa.git
`,
},
{
description: (
{tct(
'Alternatively, when your project uses a [packageSwift: Package.swift] file to manage dependencies, you can specify the target with:',
{
packageSwift:
,
}
)}
),
language: 'swift',
code: `
.package(url: "https://github.com/getsentry/sentry-cocoa", from: "8.9.3"),
`,
},
],
},
{
type: StepType.CONFIGURE,
description: (
{tct(
'Make sure you initialize the SDK as soon as possible in your application lifecycle e.g. in your AppDelegate [appDelegate: application:didFinishLaunchingWithOptions] method:',
{
appDelegate:
,
}
)}
),
configurations: [
{
language: 'swift',
code: `
import Sentry
// ....
func application(_ application: UIApplication,
didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
SentrySDK.start { options in
options.dsn = "${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
}
`,
},
{
description: (
{tct(
"When using SwiftUI and your app doesn't implement an app delegate, initialize the SDK within the [initializer: App conformer's initializer]:",
{
initializer: (
),
}
)}
),
language: 'swift',
code: `
import Sentry
@main
struct SwiftUIApp: App {
init() {
SentrySDK.start { options in
options.dsn = "${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
}
}
}
`,
},
],
},
{
type: StepType.VERIFY,
description: (
{tct(
'This snippet contains an intentional error you can use to test that errors are uploaded to Sentry correctly. You can add it to your main [viewController: ViewController].',
{
viewController:
,
}
)}
),
configurations: [
{
language: 'swift',
code: `
let button = UIButton(type: .roundedRect)
button.frame = CGRect(x: 20, y: 50, width: 100, height: 30)
button.setTitle("Break the world", for: [])
button.addTarget(self, action: #selector(self.breakTheWorld(_:)), for: .touchUpInside)
view.addSubview(button)
@IBAction func breakTheWorld(_ sender: AnyObject) {
fatalError("Break the world")
}
`,
},
],
},
{
title: t('Experimental Features'),
description: (
{tct(
'Want to play with some new features? Try out our experimental features for [vh: View Hierarchy], [ttfd: Time to Full Display (TTFD)], [metricKit: MetricKit], [prewarmedAppStart: Prewarmed App Start Tracing], and [asyncStacktraces: Swift Async Stacktraces]. Experimental features are still a work-in-progress and may have bugs. We recognize the irony. [break] Let us know if you have feedback through [gh: GitHub issues].',
{
vh: (
),
ttfd: (
),
metricKit: (
),
prewarmedAppStart: (
),
asyncStacktraces: (
),
gh: ,
break:
,
}
)}
),
configurations: [
{
language: 'swift',
code: `
import Sentry
SentrySDK.start { options in
// ...
// Enable all experimental features
options.attachViewHierarchy = true
options.enablePreWarmedAppStartTracing = true
options.enableMetricKit = true
options.enableTimeToFullDisplayTracing = true
options.swiftAsyncStacktraces = true
}
`,
},
],
},
];
export const nextSteps = [
{
id: 'cocoapods-carthage',
name: t('CocoaPods/Carthage'),
description: t(
'Learn about integrating Sentry into your project using CocoaPods or Carthage.'
),
link: 'https://docs.sentry.io/platforms/apple/install/',
},
{
id: 'debug-symbols',
name: t('Debug Symbols'),
description: t('Symbolicate and get readable stacktraces in your Sentry errors.'),
link: 'https://docs.sentry.io/platforms/apple/dsym/',
},
{
id: 'swiftui',
name: t('SwiftUI'),
description: t('Learn about our first class integration with SwiftUI.'),
link: 'https://docs.sentry.io/platforms/apple/performance/instrumentation/swiftui-instrumentation/',
},
{
id: 'profiling',
name: t('Profiling'),
description: t(
'Collect and analyze performance profiles from real user devices in production.'
),
link: 'https://docs.sentry.io/platforms/apple/profiling/',
},
];
// Configuration End
export function GettingStartedWithIos({dsn, ...props}: ModuleProps) {
return ;
}
export default GettingStartedWithIos;