Redis and node-redis Telemetry

Implementation evidence

Redis and node-redis Telemetry: from boundary to verified row

Use Redis and node-redis Telemetry at a controlled application boundary, keep the event contract small, and verify a known outcome before building aggregate views.

1
Choose the outcome
Redis cache reliability
2
Define the contract
operation, cache_name, status, hit, and fallback_used
3
Instrument the boundary
Wrap the application operation you need to measure; do not monkey-patch the Redis client or emit every command by default.
4
Verify the evidence
Exercise a known fixture, then inspect cache_operation_completed for one correctly typed terminal row.

Before you start

Prerequisites and boundaries

node-redis and telemetry-sh initialized once in a trusted Node.js process
A bounded operation taxonomy that excludes raw keys and command arguments
Separate policies for command failures, connection events, and telemetry delivery failures

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.

redis-node-install

npm installation

bash

npm install telemetry-sh

1Prepare one reusable server-side delivery client with bounded network behavior.
2Add the outcome event at the success, failure, retry, or timeout boundary.
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.

redis-node

Redis and node-redis Telemetry event

javascript

async function readCachedProject(projectId) {
  const startedAt = performance.now();
  let status = "success";
  let errorType;

  try {
    const value = await redis.get(`project:${projectId}`);
    await telemetry.log("cache_operation_completed", {
      operation: "get_project",
      key_namespace: "project",
      status,
      hit: value !== null,
      latency_ms: Math.round(performance.now() - startedAt),
      release: process.env.APP_RELEASE,
    });
    return value;
  } catch (error) {
    status = "failed";
    errorType = classifyRedisError(error);
    await telemetry.log("cache_operation_completed", {
      operation: "get_project",
      key_namespace: "project",
      status,
      hit: false,
      latency_ms: Math.round(performance.now() - startedAt),
      error_type: errorType,
      release: process.env.APP_RELEASE,
    });
    throw error;
  }
}

Event contract

operation, cache_name, status, hit, and fallback_used

latency_ms, error_type, reconnecting, release, and environment

key_namespace only when it is a fixed category rather than a customer-derived key

Implementation checkpoints

Checkpoint 1

Wrap the application operation you need to measure; do not monkey-patch the Redis client or emit every command by default.

Checkpoint 2

Never send Redis URLs, credentials, raw keys, values, command arguments, channel messages, or Lua source.

Checkpoint 3

Keep the Redis error listener required by node-redis, but rate-limit connection telemetry so a reconnect storm cannot create a second overload.

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.

redis-node-verification

Redis and node-redis Telemetry verification query

sql

SELECT *
FROM cache_operation_completed
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.

JavaScript SDK Cache hit-rate SQL Sampling strategies node-redis client guide node-redis error handling

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.

Delivery and idempotency Batching and shutdown Troubleshoot ingestion

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.

Async reliability11 fields