AGENTIC MEMORY

Skills

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

← Back to Skills

instrument-metrics

Add PostHog metric capture to track counters, gauges, and histograms. Use after implementing features or reviewing PRs to ensure key operations are measured, or when asked to add metrics, counters, or track a value over time. Also handles mirroring existing Prometheus/StatsD/OpenTelemetry metrics into PostHog and initial OTLP exporter setup.

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--instrument-metrics 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 · 10

references/nodejs.md

AI agents: this is one page from PostHog's docs. Full index of Markdown docs for LLMs: https://posthog.com/llms.txt

Node.js metrics installation

Canonical URL: https://posthog.com/docs/metrics/installation/nodejs

Cloud region: This page uses US Cloud hosts. For an EU Cloud project, use https://eu.i.posthog.com instead of https://us.i.posthog.com (ingestion host), and use https://eu.posthog.com instead of https://app.posthog.com (app host for links).

On this page

Note: Metrics is in open alpha. Any team can turn it on — open Metrics and select Enable metrics in the onboarding view. Setup details may change before general availability.

The posthog-node SDK includes the posthog.metrics API, so you can record metrics with the same client you use for events and feature flags.

  1. 1

    Install posthog-node

    Required

    npm install posthog-node
    

    Metrics requires an up-to-date SDK version, so upgrade if you're on an older release.

  2. 2

    Initialize the client

    Required

    Set a service name so metrics from different systems stay easy to tell apart. It's attached to every series and used by the Metrics UI for filtering.

    import { PostHog } from 'posthog-node'
    
    const posthog = new PostHog('<ph_project_token>', {
        host: 'https://us.i.posthog.com',
        metrics: { serviceName: 'billing-worker' },
    })
    

    Use your project token (the same one you use for capturing events), not a personal API key.

  3. 3

    Record metrics

    Required

    Use the metric type that matches what you're measuring:

    // Counters only go up: things you count
    posthog.metrics.count('jobs.processed', 1, { attributes: { queue: 'default' } })
    
    // Gauges go up and down: current values
    posthog.metrics.gauge('queue.depth', 7)
    
    // Histograms record distributions: durations, sizes
    posthog.metrics.histogram('job.duration', 42, { unit: 'ms' })
    

    Samples aggregate in memory and flush as one OTLP data point per series every few seconds, so recording in hot paths is cheap. A burst of 10k count() calls costs one data point on the wire.

    Keep attribute values small and bounded: route, status, and plan are good attributes; user IDs, session IDs, and request IDs are not. Every unique combination creates a new series.

  4. 4

    Instrument alongside existing metrics

    Optional

    If your service already records metrics with Prometheus, StatsD, or another system, don't rip it out. Add the PostHog call next to the existing one, reusing the same metric name and attributes, so both systems chart the same series while you evaluate.

  5. 5

    Flush before exit

    Required

    For short-lived processes (cron jobs, CLIs, serverless functions), flush before exiting so the last aggregation window isn't lost:

    await posthog.metrics.flush()
    // or, when tearing down the whole client:
    await posthog.shutdown()
    
  6. 6

    Test your setup

    Recommended

    1. Trigger the code path that records a metric
    2. Open Metrics in the PostHog sidebar and pick your metric from the name picker
    3. Data points should appear within a minute of sending

    View your metrics in PostHog

  7. Next steps

    Checkpoint

    What you can do with your metrics

    | Action | Description | | --- | --- | | Why you need metrics | What metrics show you that events and logs don't | | Getting started guide | Pick the right metric type, add attributes carefully, and chart what matters | | Group and filter | Group by an attribute for one line per value, or filter with key=value chips | | How metrics works | How metrics are ingested, stored, and queried | | Query with SQL | Every metric lands in the posthog.metrics table, queryable from the SQL tab |

    Continue with the getting started guide