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.

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

import { getNuxtSteps as getNuxtStepsPA } from '../product-analytics/nuxt'
import { StepDefinition } from '../steps'

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

    const installSteps = getNuxtStepsPA(ctx)

    const manualCaptureStep: StepDefinition = {
        title: 'Manually capturing exceptions',
        badge: 'optional',
        content: (
            <>
                <Markdown>
                    {dedent`
                        To send errors directly using the PostHog client, import it and use the \`captureException\` method like this:
                    `}
                </Markdown>
                <CodeBlock
                    blocks={[
                        {
                            language: 'html',
                            file: 'Vue',
                            code: dedent`
                              <script>
                                const { $posthog } = useNuxtApp()
                                if ($posthog) {
                                  const posthog = $posthog()
                                  posthog.captureException(new Error("Important error message"))
                                }
                              </script>
                            `,
                        },
                    ]}
                />
                <Markdown>
                    {dedent`
                        On the server side, you can use the \`posthog\` object directly.
                    `}
                </Markdown>
                <CodeBlock
                    blocks={[
                        {
                            language: 'javascript',
                            file: 'server/api/example.js',
                            code: dedent`
                              const runtimeConfig = useRuntimeConfig()
                              const posthog = new PostHog(
                                runtimeConfig.public.posthogPublicKey,
                                {
                                  host: runtimeConfig.public.posthogHost,
                                }
                              );
                              try {
                                const results = await DB.query.users.findMany()
                                return results
                              } catch (error) {
                                posthog.captureException(error)
                              }
                            `,
                        },
                    ]}
                />
            </>
        ),
    }

    const exceptionAutocaptureStep: StepDefinition = {
        title: 'Configuring exception autocapture',
        badge: 'recommended',
        content: (
            <>
                <Markdown>
                    {dedent`
                        Update your \`posthog.client.js\` to add an error hook.
                    `}
                </Markdown>
                <CodeBlock
                    blocks={[
                        {
                            language: 'javascript',
                            file: 'JavaScript',
                            code: dedent`
                              export default defineNuxtPlugin((nuxtApp) => {
                                  ...
                                  nuxtApp.hook('vue:error', (error) => {
                                      posthogClient.captureException(error)
                                  })
                                  ...
                              })
                            `,
                        },
                    ]}
                />
            </>
        ),
    }

    const verifyStep: StepDefinition = {
        title: 'Verify error tracking',
        badge: 'recommended',
        checkpoint: true,
        content: (
            <Markdown>
                {dedent`
                    Before proceeding, let's make sure exception events are being captured and sent to PostHog. You should see events appear in the activity feed.

                    [Check for exceptions in PostHog](https://app.posthog.com/activity/events)
                `}
            </Markdown>
        ),
    }

    return [...installSteps, manualCaptureStep, exceptionAutocaptureStep, verifyStep]
}

export const Nuxt36Installation = createInstallation(getNuxt36Steps)