Skip to content
Telemetry
Integration guide

Kafka Consumer Lag and Processing Analytics

Monitor Kafka consumer outcomes, partition lag, processing latency, retries, and poison-message handling with structured events.

Reviewed by the Telemetry product team on . Instrumentation contract, privacy boundaries, and implementation guidance. Review standards and ownership

Useful for
  • Consumer lag monitoring
  • Partition imbalance
  • Message processing reliability
Implementation evidence

Kafka Consumer Lag and Processing Analytics: from boundary to verified row

Use Kafka Consumer Lag and Processing Analytics at a controlled application boundary, keep the event contract small, and verify a known outcome before building aggregate views.

  1. 1

    Choose the outcome

    Consumer lag monitoring

  2. 2

    Define the contract

    topic, partition, consumer_group, and status

  3. 3

    Instrument the boundary

    Emit aggregate lag snapshots separately from per-message completion events at high volume.

  4. 4

    Verify the evidence

    Exercise a known fixture, then inspect kafka_consumer_snapshot for one correctly typed terminal row.

Before you start

Prerequisites and boundaries

  • A server-side TELEMETRY_API_KEY
  • Stable topic and consumer-group names
  • Offset and high-watermark metadata from the Kafka client

Delivery setup

Install and initialize server-side

Import telemetry-sh in server-only code and initialize it once with process.env.TELEMETRY_API_KEY. Keep ingestion credentials out of browser bundles, client-visible environment variables, source control, logs, and exception messages.

kafka-install

npm installation

bash
npm install telemetry-sh
  1. 1Prepare one reusable server-side delivery client with bounded network behavior.
  2. 2Add the outcome event at the success, failure, retry, or timeout boundary.
  3. 3Send controlled fixtures and inspect the stored rows before enabling an alert.

Snippet

Start with one structured event

Add this shape where the workflow completes, fails, or retries. Then build the dashboard from real fields.

kafka

Kafka Consumer Lag and Processing Analytics event

javascript
await telemetry.log("kafka_consumer_snapshot", {
  topic,
  partition,
  consumer_group: groupId,
  offset: Number(currentOffset),
  high_watermark: Number(highWatermark),
  lag: Number(highWatermark - currentOffset),
  status: "healthy",
  consumer_instance: instanceId,
  release: process.env.APP_RELEASE,
});

Event contract

topic, partition, consumer_group, and status

offset, high_watermark, lag, and duration_ms

attempt, error_type, consumer_instance, and release

Implementation checkpoints

Checkpoint 1

Emit aggregate lag snapshots separately from per-message completion events at high volume.

Checkpoint 2

Do not send message values, keys containing customer data, or authentication configuration.

Checkpoint 3

Preserve topic and consumer group while limiting partition-level charts to operational investigation.

Verification

Prove the event arrived

Run this after exercising known success and failure cases. Replace the fallback table name if your final event contract differs from the snippet.

kafka-verification

Kafka Consumer Lag and Processing Analytics verification query

sql
SELECT *
FROM kafka_consumer_snapshot
ORDER BY timestamp_utc DESC
LIMIT 20;
Confirm one terminal row per logical outcome, with the expected status, identifiers, units, and UTC time.
Inspect the inferred schema and verify that retries do not change field types or generate a new logical event ID.
Search the stored fields for credentials, raw payloads, prompts, private content, and unbounded error messages.
Exercise a provider timeout, ingestion rejection, and process shutdown before treating the dashboard as complete.

Implementation references

Review the event contract, data-safety guidance, and upstream primary documentation before enabling a new production path.

Production boundary

Keep the outcome event small and recoverable

This pattern provides

  • A bounded, SQL-ready outcome beside the upstream workflow.
  • Stable fields for dashboards, alerts, and cross-event correlation.
  • A fixture-driven path for validating success, failure, retry, and timeout behavior.

This pattern does not provide

  • An OTLP exporter, automatic collection pipeline, or replacement for detailed traces and diagnostic logs.
  • Exactly-once delivery merely because the payload contains an event ID.
  • Permission to collect raw provider payloads, user content, credentials, or regulated data.

Event schema starting points

Review the row grain, emit boundary, required types, privacy classes, example payload, and validation checklist before adapting a query or snippet to production.

Related product capability

Continue this workflow in Structured events

Capture stable event names, typed fields, and privacy-reviewed operational context.

Related SQL recipes

Answer the next question with SQL

Run the query against the structured fields from this workflow, inspect the example result, and turn a useful answer into a dashboard or alert.

Browse all recipes

Browse by implementation family

Compare related integration patterns

Templates to pair with this integration

More integrations