Posthog

Плагин, который удобно оборачивает клиент PostHog. Автоматически ловит ошибки (и включает в них senderId и chatId). Предоставляет методы к которым уже привязан distinctId (в виде from.id)

Вы можете использовать PostHog Cloud free tier или self-hosted.

Установка

npm

npm install @gramio/posthog

yarn

yarn add @gramio/posthog

pnpm

pnpm add @gramio/posthog

bun

bun install @gramio/posthog

Использование

import { PostHog } from "posthog-node";
import { posthogPlugin } from "@gramio/posthog";
import { Bot } from "gramio";

const posthog = new PostHog(process.env.POSTHOG_API_KEY!, {
    host: process.env.POSTHOG_HOST,
});

const bot = new Bot(process.env.BOT_TOKEN!)
    .extend(posthogPlugin(posthog))
    .on("message", (context) => {
        context.capture("message", {
            text: context.message.text,
        });

        throw new Error("Будет поймано PostHog");
    });

await bot.start();

Методы

capture(event: string, properties?: Record<string, unknown>)

Ловит события и отправляет их в PostHog вместе с senderId.

context.capture("message", {
    text: context.message.text,
});

Feature Flags

isEnabled(feature: string, options?: IsFeatureEnabledOptions)

Проверяет включен ли feature flag для текущего пользователя.

const isEnabled = await context.featureFlags.isEnabled("beta-feature", {
    groups: { organization: "org_id" },
});
// Возвращает boolean

getPayload(feature: string, value?: GetFeatureFlagPayloadValue, options?: GetFeatureFlagPayloadOptions)

Получает payload (дополнительные данные) для feature flag.

const payload = await context.featureFlags.getPayload("pricing-page", {
    sendEmail: true,
});
// Возвращает any | undefined

get(feature: string, options?: GetFeatureFlagOptions)

Получает полную информацию о feature flag.

const flag = await context.featureFlags.get("new-onboarding", {
    personProperties: { plan: "pro" },
});
// Возвращает boolean | string | number | Record<string, any>

getAll(options?: GetAllFlagsOptions)

Получает все feature flags для пользователя.

const allFlags = await context.featureFlags.getAll({
    groups: { company: "acme" },
});
// Возвращает Record<string, boolean | string | number>

getAllPayload(options?: GetAllFlagsPayloadOptions)

Получает все флаги вместе с их payloads.

const flagsWithPayloads = await context.featureFlags.getAllPayload({
    personProperties: { country: "US" },
});
/* Возвращает:
{
  flags: Record<string, boolean | string | number>
  payloads: Record<string, any>
} */