Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

9.6 KB
Raw Blame
import { OnboardingComponentsContext, createInstallation } from 'scenes/onboarding/shared/OnboardingDocsContentWrapper'

import { StepDefinition } from '../steps'

export const getIOSSteps = (ctx: OnboardingComponentsContext): StepDefinition[] => {
    const { CodeBlock, Markdown, CalloutBox, dedent, snippets } = ctx
    const SessionReplayFinalSteps = snippets?.SessionReplayFinalSteps

    return [
        {
            title: 'Install the SDK',
            badge: 'required',
            content: (
                <>
                    <Markdown>Add PostHog to your Podfile:</Markdown>
                    <CodeBlock
                        blocks={[
                            {
                                language: 'ruby',
                                file: 'Podfile',
                                code: dedent`
                                    pod "PostHog", "~> 3.56"
                                `,
                            },
                        ]}
                    />
                    <Markdown>Or install via Swift Package Manager:</Markdown>
                    <CodeBlock
                        blocks={[
                            {
                                language: 'swift',
                                file: 'Package.swift',
                                code: dedent`
                                    dependencies: [
                                      .package(url: "https://github.com/PostHog/posthog-ios.git", from: "3.56.0")
                                    ]
                                `,
                            },
                        ]}
                    />
                    <CalloutBox type="fyi" title="SDK version">
                        <Markdown>
                            Session replay requires PostHog iOS SDK version 3.6.0 or higher. We recommend always using
                            the latest version.
                        </Markdown>
                    </CalloutBox>
                </>
            ),
        },
        {
            title: 'Enable session recordings in project settings',
            badge: 'required',
            content: (
                <>
                    <Markdown>
                        Go to your PostHog [Project Settings](https://us.posthog.com/settings/project-replay) and enable
                        **Record user sessions**. Session recordings will not work without this setting enabled.
                    </Markdown>
                </>
            ),
        },
        {
            title: 'Configure PostHog with session replay',
            badge: 'required',
            content: (
                <>
                    <Markdown>
                        Add `sessionReplay = true` to your PostHog configuration. Here are all the available options:
                    </Markdown>
                    <CodeBlock
                        blocks={[
                            {
                                language: 'swift',
                                file: 'AppDelegate.swift',
                                code: dedent`
                                    import Foundation
                                    import PostHog
                                    import UIKit

                                    class AppDelegate: NSObject, UIApplicationDelegate {
                                        func application(_: UIApplication, didFinishLaunchingWithOptions _: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {
                                            let POSTHOG_PROJECT_TOKEN = "<ph_project_token>"
                                            let POSTHOG_HOST = "<ph_client_api_host>"

                                            let config = PostHogConfig(projectToken: POSTHOG_PROJECT_TOKEN, host: POSTHOG_HOST)

                                            // Enable session recording. Requires enabling in your project settings as well.
                                            // Default is false.
                                            config.sessionReplay = true

                                            // Whether text and text input fields are masked. Default is true.
                                            // Password inputs are always masked regardless
                                            config.sessionReplayConfig.maskAllTextInputs = true

                                            // Whether images are masked. Default is true.
                                            config.sessionReplayConfig.maskAllImages = true

                                            // Whether logs are captured in recordings. Default is false.
                                            //
                                            // Support for remote configuration 
                                            // in the [session replay settings](https://app.posthog.com/settings/project-replay#replay-log-capture)
                                            // requires SDK version 3.41.1 or higher.
                                            config.sessionReplayConfig.captureLogs = false

                                            // Whether network requests are captured in recordings. Default is true
                                            // Only metric-like data like speed, size, and response code are captured.
                                            // No data is captured from the request or response body.
                                            //
                                            // Support for remote configuration 
                                            // in the [session replay settings](https://app.posthog.com/settings/project-replay#replay-network)
                                            // requires SDK version 3.41.1 or higher.
                                            config.sessionReplayConfig.captureNetworkTelemetry = true

                                            // Whether replays are created using high quality screenshots. Default is false.
                                            // Required for SwiftUI.
                                            // If disabled, replays are created using wireframes instead.
                                            // The screenshot may contain sensitive information, so use with caution
                                            config.sessionReplayConfig.screenshotMode = true

                                            // Experimental. Only applies when \`screenshotMode\` is enabled.
                                            // Moves screenshot rendering off the main thread, which reduces jank
                                            // on high refresh rate (120Hz ProMotion) displays. May trigger Xcode's
                                            // Main Thread Checker and briefly freeze the app on the first capture.
                                            // Default is false. Requires SDK version 3.58.1 or higher.
                                            config.sessionReplayConfig.screenshotModeBackgroundCapture = false

                                            // Minimum time (in seconds) between snapshots. Default is 1.0s.
                                            // Snapshots are taken when views lay out, so this caps how often one
                                            // can be captured rather than setting a fixed frame rate.
                                            // Lower values can make playback smoother, at the cost of more
                                            // capture work on the device.
                                            // Note: called \`debouncerDelay\` before version 3.21.0
                                            config.sessionReplayConfig.throttleDelay = 1.0

                                            // Sample rate for session recordings. A value between 0.0 and 1.0.
                                            // 1.0 means 100% of sessions will be recorded. 0.5 means 50%, and so on.
                                            // Default is nil (all sessions are recorded).
                                            // 
                                            // Support for remote configuration
                                            // in the [session replay triggers](https://us.posthog.com/settings/project-replay#replay-triggers)
                                            // requires SDK version 3.42.0 or higher.
                                            config.sessionReplayConfig.sampleRate = nil

                                            PostHogSDK.shared.setup(config)

                                            return true
                                        }
                                    }
                                `,
                            },
                        ]}
                    />
                    <Markdown>
                        For more configuration options, see the [iOS session replay
                        docs](https://posthog.com/docs/session-replay/installation?tab=iOS).
                    </Markdown>
                    <CalloutBox type="fyi" title="SwiftUI support">
                        <Markdown>
                            SwiftUI is only supported if the `screenshotMode` option is enabled. Custom views and
                            WebViews also require screenshot mode for full support.
                        </Markdown>
                    </CalloutBox>
                </>
            ),
        },
        {
            title: 'Watch session recordings',
            badge: 'recommended',
            content: <>{SessionReplayFinalSteps && <SessionReplayFinalSteps />}</>,
        },
    ]
}

export const IOSInstallation = createInstallation(getIOSSteps)