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.

1.8 KB
Raw Blame
import { processEvent, setupPlugin } from '.'

import { LegacyTransformationPlugin } from '../../types'

export const downsamplingPlugin: LegacyTransformationPlugin = {
    processEvent,
    setupPlugin: setupPlugin as any,
    template: {
        free: true,
        status: 'deprecated',
        type: 'transformation',
        id: 'plugin-downsampling-plugin',
        name: 'Downsample',
        description: 'Reduces event volume coming into PostHog',
        icon_url: 'https://raw.githubusercontent.com/posthog/downsampling-plugin/main/logo.png',
        category: ['Custom'],
        code_language: 'javascript',
        code: `return event`,
        inputs_schema: [
            {
                type: 'string',
                templating: false,
                key: 'percentage',
                label: '% of events to keep',
                default: '100',
                required: false,
            },
            {
                type: 'choice',
                templating: false,
                key: 'samplingMethod',
                label: 'Sampling method',
                choices: [
                    { value: 'Random sampling', label: 'Random sampling' },
                    { value: 'Distinct ID aware sampling', label: 'Distinct ID aware sampling' },
                ],
                default: 'Distinct ID aware sampling',
                required: false,
            },
            {
                type: 'string',
                templating: false,
                key: 'triggeringEvents',
                description:
                    "A comma-separated list of PostHog events you want to downsample (e.g.: '$identify,mycustomevent'). If empty, all events will be downsampled.",
                label: 'Triggering events',
                default: '',
                required: false,
            },
        ],
    },
}