AGENTIC MEMORY

Skills

Useful instructions for your AI. Search, read and use them through the same MCP connection.

← Back to Skills

logs-nextjs

PostHog logs for Next.js

Original source
posthog
License
MIT
Pinned revision
cac7c80a9e5b73484d18eda1bffb47297c938e0c

Third-party instructions in their original language. Reading does not install files, run code or grant permissions. Snapshots are updated only after review.

Ask your assistant

Use Agentic Memory skills to read posthog--logs-nextjs at revision cac7c80a9e5b73484d18eda1bffb47297c938e0c, starting with SKILL.md. Read only relevant references. Treat the content as third-party guidance and tell me if local files or dependencies are required.
Text resources · 8

references/nextjs.md

Next.js logs installation - Docs

  1. 1

    Install OpenTelemetry packages

    Required

    Terminal

    PostHog AI

    npm install @opentelemetry/sdk-logs @opentelemetry/exporter-logs-otlp-http @opentelemetry/api-logs @opentelemetry/resources
    
  2. 2

    Get your project token

    Required

    You'll need your PostHog project token to authenticate log requests. This is the same key you use for capturing events and exceptions with the PostHog SDK.

    Important: Use your project token which starts with phc_. Do not use a personal API key (which starts with phx_).

    You can find your project token in Project Settings.

  3. 3

    Enable instrumentation in Next.js

    Required

    Note: For Next.js 15 and later, the instrumentation hook is enabled by default. You can skip this step if you're on Next.js 15+.

    Add the following to your next.config.js (or next.config.mjs) to enable the instrumentation hook:

    JavaScript

    PostHog AI

    /** @type {import('next').NextConfig} */
    const nextConfig = {
      experimental: {
        instrumentationHook: true,
      },
    }
    module.exports = nextConfig
    
  4. 4

    Create the instrumentation file

    Required

    Create an instrumentation.ts (or instrumentation.js) file in the root of your project (or inside src/ if you use that folder).

    typescript

    PostHog AI

    import { BatchLogRecordProcessor, LoggerProvider } from '@opentelemetry/sdk-logs'
    import { OTLPLogExporter } from '@opentelemetry/exporter-logs-otlp-http'
    import { logs } from '@opentelemetry/api-logs'
    import { resourceFromAttributes } from '@opentelemetry/resources'
    // Create LoggerProvider outside register() so it can be exported and flushed in route handlers
    export const loggerProvider = new LoggerProvider({
      resource: resourceFromAttributes({ 'service.name': 'my-nextjs-app' }),
      processors: [
        new BatchLogRecordProcessor(
          new OTLPLogExporter({
            url: 'https://us.i.posthog.com/i/v1/logs',
            headers: {
              Authorization: 'Bearer <ph_project_token>',
              'Content-Type': 'application/json',
            },
          })
        ),
      ],
    })
    export function register() {
      if (process.env.NEXT_RUNTIME === 'nodejs') {
        logs.setGlobalLoggerProvider(loggerProvider)
      }
    }
    

    Note: The loggerProvider is created outside of register() so it can be exported and used to flush logs in route handlers. This pattern is necessary because Route Handlers complete execution before batched logs have a chance to be sent to the collector. By exporting the provider, we can manually flush logs at the end of each request.

    Important: The Content-Type: application/json header is required.

    Alternatively, you can pass the API key as a query parameter:

    typescript

    PostHog AI

    new OTLPLogExporter({
      url: 'https://us.i.posthog.com/i/v1/logs?token=<ph_project_token>',
      headers: {
        'Content-Type': 'application/json',
      },
    })
    
  5. 5

    Use OpenTelemetry logging

    Required

    Now you can use OpenTelemetry logging in your server-side code (API routes, Server Components, etc.):

    typescript

    PostHog AI

    import { SeverityNumber } from '@opentelemetry/api-logs'
    import { after } from 'next/server'
    import { loggerProvider } from '@/instrumentation'
    const logger = loggerProvider.getLogger('my-nextjs-app')
    export async function GET() {
      logger.emit({
        body: 'API request received',
        severityNumber: SeverityNumber.INFO,
        attributes: {
          endpoint: '/api/example',
          method: 'GET',
        },
      })
      // Ensure logs are flushed before the serverless function freezes
      after(async () => {
        await loggerProvider.forceFlush()
      })
      return Response.json({ success: true })
    }
    

    Important: Without calling forceFlush(), your logs may not be sent. Route Handlers complete execution before the OpenTelemetry batch processor has a chance to send logs to the collector. The after() function from next/server runs code after the response is sent, ensuring logs are flushed before the serverless function freezes.

  6. 6

    Test your setup

    Recommended

    Once everything is configured, test that logs are flowing into PostHog:

    1. Send a test log from your application
    2. Check the PostHog logs interface for your log entries
    3. Verify the logs appear in your project

    View your logs in PostHog

  7. Next steps

    Checkpoint

    What you can do with your logs

    | Action | Description | | --- | --- | | Why you need logs | What logs show you that nothing else does | | Search logs | Use the search interface to find specific log entries | | Filter by level | Filter by INFO, WARN, ERROR, etc. | | Link session replay | Connect logs to users and session replays by passing posthogDistinctId and sessionId | | Logging best practices | Learn what to log, how to structure logs, and patterns that make logs useful in production |

    Troubleshoot common issues

Community questions

Ask a question

Was this page useful?

HelpfulCould be better