Skip to content

Latest commit

 

History

History
88 lines (73 loc) · 3.87 KB

File metadata and controls

88 lines (73 loc) · 3.87 KB

@posthog/rollup-plugin

Rollup plugin for uploading source maps to PostHog for error tracking.

SEE FULL DOCS

Installation

npm install @posthog/rollup-plugin --save-dev

Usage

Add the plugin to your Rollup configuration:

import posthog from '@posthog/rollup-plugin'

export default {
    input: './src/index.ts',
    output: {
        format: 'es',
        dir: 'dist',
    },
    plugins: [
        posthog({
            personalApiKey: process.env.POSTHOG_PERSONAL_API_KEY,
            projectId: process.env.POSTHOG_PROJECT_ID,
            sourcemaps: {
                enabled: true,
                releaseName: 'my-app',
                releaseVersion: '1.0.0',
            },
        }),
    ],
}

Configuration Options

Option Type Required Default Description
personalApiKey string Yes - Your PostHog personal API key
projectId string Yes - Your PostHog project/environment ID
envId string No - Deprecated alias for projectId
host string No https://us.i.posthog.com PostHog instance host
logLevel 'debug' | 'info' | 'warn' | 'error' | 'silent' No 'info' Logging verbosity
cliBinaryPath string No Auto-detected Path to the PostHog CLI binary
sourcemaps.enabled boolean No true Enable source map processing
sourcemaps.releaseName string No - Release name for source map grouping
sourcemaps.releaseVersion string No - Version identifier for the release
sourcemaps.deleteAfterUpload boolean No true Delete source maps after upload
sourcemaps.batchSize number No - Number of source maps to upload in parallel

Full Example

import posthog from '@posthog/rollup-plugin'
import packageJson from './package.json' with { type: 'json' }

export default {
    input: './src/index.ts',
    output: [
        {
            format: 'es',
            dir: 'dist/esm',
        },
    ],
    plugins: [
        posthog({
            personalApiKey: process.env.POSTHOG_PERSONAL_API_KEY,
            projectId: process.env.POSTHOG_PROJECT_ID,
            host: process.env.POSTHOG_API_HOST,
            logLevel: 'info',
            sourcemaps: {
                enabled: true,
                releaseName: packageJson.name,
                releaseVersion: packageJson.version,
            },
        }),
    ],
}

Questions?