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.

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

import { StepDefinition } from '../steps'

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

    return [
        {
            title: 'Install dependencies',
            badge: 'required',
            content: (
                <>
                    <Markdown>
                        PostHog logs uses the standard OpenTelemetry SDK. No PostHog-specific packages required. Install
                        the OTel SDK and the logs signal package:
                    </Markdown>
                    <CodeBlock
                        blocks={[
                            {
                                language: 'bash',
                                file: 'npm',
                                code: dedent`
                                    npm install @opentelemetry/sdk-node@latest @opentelemetry/sdk-logs@latest @opentelemetry/exporter-logs-otlp-http@latest @opentelemetry/api@latest @opentelemetry/api-logs@latest @opentelemetry/resources@latest
                                `,
                            },
                            {
                                language: 'bash',
                                file: 'yarn',
                                code: dedent`
                                    yarn add @opentelemetry/sdk-node@latest @opentelemetry/sdk-logs@latest @opentelemetry/exporter-logs-otlp-http@latest @opentelemetry/api@latest @opentelemetry/api-logs@latest @opentelemetry/resources@latest
                                `,
                            },
                            {
                                language: 'bash',
                                file: 'pnpm',
                                code: dedent`
                                    pnpm add @opentelemetry/sdk-node@latest @opentelemetry/sdk-logs@latest @opentelemetry/exporter-logs-otlp-http@latest @opentelemetry/api@latest @opentelemetry/api-logs@latest @opentelemetry/resources@latest
                                `,
                            },
                            {
                                language: 'bash',
                                file: 'bun',
                                code: dedent`
                                    bun add @opentelemetry/sdk-node@latest @opentelemetry/sdk-logs@latest @opentelemetry/exporter-logs-otlp-http@latest @opentelemetry/api@latest @opentelemetry/api-logs@latest @opentelemetry/resources@latest
                                `,
                            },
                        ]}
                    />
                    <Markdown>
                        These steps need `@opentelemetry/sdk-logs` 0.220.0 or later. The `@latest` tags upgrade any
                        older version already in your project. OpenTelemetry lists Node.js 18 (18.19 or later) and
                        Node.js 20.6 or later as supported for versions 0.220.0 through 0.222.0. Later releases may
                        change this.
                    </Markdown>
                </>
            ),
        },
        {
            title: 'Configure the OTLP log exporter',
            badge: 'required',
            content: (
                <>
                    <Markdown>
                        {dedent`
                            Create a logger setup file that configures the OpenTelemetry log exporter to send logs to
                            PostHog. Call this before your application starts.
                        `}
                    </Markdown>
                    <CodeBlock
                        blocks={[
                            {
                                language: 'typescript',
                                file: 'logger.ts',
                                code: dedent`
                                    import { OTLPLogExporter } from '@opentelemetry/exporter-logs-otlp-http'
                                    import { resourceFromAttributes } from '@opentelemetry/resources'
                                    import { LoggerProvider, SimpleLogRecordProcessor } from '@opentelemetry/sdk-logs'

                                    const exporter = new OTLPLogExporter({
                                      url: '<ph_client_api_host>/i/v1/logs',
                                      headers: {
                                        Authorization: 'Bearer <ph_project_token>',
                                      },
                                    })

                                    const loggerProvider = new LoggerProvider({
                                      resource: resourceFromAttributes({
                                        'service.name': 'my-app',
                                      }),
                                      processors: [new SimpleLogRecordProcessor({ exporter })],
                                    })

                                    export const logger = loggerProvider.getLogger('my-app')
                                `,
                            },
                        ]}
                    />
                </>
            ),
        },
        {
            title: 'Send a log',
            badge: 'required',
            content: (
                <>
                    <Markdown>Use the logger to emit logs from your application:</Markdown>
                    <CodeBlock
                        blocks={[
                            {
                                language: 'typescript',
                                file: 'app.ts',
                                code: dedent`
                                    import { SeverityNumber } from '@opentelemetry/api-logs'
                                    import { logger } from './logger'

                                    logger.emit({
                                      severityNumber: SeverityNumber.INFO,
                                      severityText: 'INFO',
                                      body: 'Server started',
                                      attributes: {
                                        'server.port': 3000,
                                        'server.env': 'production',
                                      },
                                    })
                                `,
                            },
                        ]}
                    />
                    <Markdown>
                        {dedent`
                            Logs appear in PostHog within a few seconds. Use the [Logs page](https://app.posthog.com/logs) to search and filter
                            by service name, severity, or any attribute you attach.
                        `}
                    </Markdown>
                </>
            ),
        },
    ]
}

export const NodeJSInstallation = createInstallation(getNodeJSSteps)