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.

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

import { StepDefinition } from '../steps'

export const getRobloxSteps = (ctx: OnboardingComponentsContext): StepDefinition[] => {
    const { CodeBlock, Markdown, dedent } = ctx

    return [
        {
            title: 'Install the Roblox SDK',
            badge: 'required',
            content: (
                <>
                    <Markdown>
                        {dedent`
                            Install PostHog through Wally, or download the latest \`posthog-roblox.rbxm\` from the [SDK releases](https://github.com/PostHog/posthog-roblox/releases) and insert it into \`ReplicatedStorage\`.

                            For Wally and Rojo, add this dependency and run \`wally install\`:
                        `}
                    </Markdown>
                    <CodeBlock
                        language="toml"
                        code={dedent`
                            [dependencies]
                            PostHog = "posthog/[email protected]"
                        `}
                    />
                    <Markdown>
                        {dedent`
                            Then map the installed package into \`ReplicatedStorage\` in your Rojo project file:
                        `}
                    </Markdown>
                    <CodeBlock
                        language="json"
                        code={dedent`
                            "ReplicatedStorage": {
                                "$className": "ReplicatedStorage",
                                "PostHog": { "$path": "Packages/PostHog" }
                            }
                        `}
                    />
                    <Markdown>
                        {dedent`
                            In Studio, enable **Game Settings > Security > Allow HTTP Requests**.
                        `}
                    </Markdown>
                </>
            ),
        },
        {
            title: 'Configure PostHog',
            badge: 'required',
            content: (
                <>
                    <Markdown>
                        {dedent`
                            Initialize PostHog once from a server \`Script\`. Exception autocapture is enabled by default.
                        `}
                    </Markdown>
                    <CodeBlock
                        language="lua"
                        code={dedent`
                            local ReplicatedStorage = game:GetService("ReplicatedStorage")
                            local PostHog = require(ReplicatedStorage:WaitForChild("PostHog"))

                            PostHog:Init({
                                apiKey = "<ph_project_token>",
                                host = "<ph_client_api_host>",
                                captureErrors = true,
                                errorDebounceSeconds = 1,
                            })
                        `}
                    />
                </>
            ),
        },
        {
            title: 'Capture handled exceptions',
            badge: 'optional',
            content: (
                <>
                    <Markdown>
                        {dedent`
                            The SDK automatically listens for unhandled server errors. Require it from a \`LocalScript\` to relay unhandled client errors to the server. Call \`CaptureException\` for handled errors.
                        `}
                    </Markdown>
                    <CodeBlock
                        language="lua"
                        code={dedent`
                            local capturedMessage
                            local ok, capturedTraceback = xpcall(
                                function()
                                    saveGame(player)
                                end,
                                function(errorMessage)
                                    capturedMessage = tostring(errorMessage)
                                    return debug.traceback(capturedMessage, 2)
                                end
                            )

                            if not ok then
                                PostHog:CaptureException(player, capturedMessage, capturedTraceback, {
                                    flow = "save_game",
                                })
                            end
                        `}
                    />
                </>
            ),
        },
        {
            title: 'Verify error tracking',
            badge: 'recommended',
            checkpoint: true,
            content: (
                <>
                    <Markdown>
                        {dedent`
                            Raise a test error from a server \`Script\` and confirm it appears in [Error tracking](https://app.posthog.com/error-tracking).
                        `}
                    </Markdown>
                    <CodeBlock language="lua" code='error("Automatic test exception from Roblox")' />
                </>
            ),
        },
    ]
}

export const RobloxInstallation = createInstallation(getRobloxSteps)