跳转到内容
集成指南

Redis 和节点-redis Telemetry

与 Node-Redis 一起测量 Redis 命令结果、延迟、缓存行为、重新连接和有限错误类别。

审阅者 Telemetry产品团队 上 . 我们检查了要发送的事件、要排除的数据和代码添加方法. 谁负责审核此页面

有用于
  • Redis缓存可靠性
  • 命令延迟监控
  • 重连和超时分析
实施证据

使用 Redis and node-redis telemetry 发送并验证事件

在受控应用程序边界使用 Redis and node-redis telemetry,保持事件契约较小,并在构建聚合视图之前验证已知结果。

  1. 1

    选择结果

    Redis缓存可靠性

  2. 2

    定义合同

    操作、cache_name、状态、命中和 fallback_used

  3. 3

    在结果处发出

    Delivery is best-effort with a two-second fetch timeout. Ingestion failure preserves the application result or original error; verify the event with a query and use a durable outbox when loss is unacceptable.

  4. 4

    核实证据

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

开始之前

开始之前

  • An initialized node-redis client 中 a trusted Node.js runtime with fetch, AbortSignal.timeout, and a server-side Telemetry key
  • 排除原始键和命令参数的有界操作分类法
  • 针对命令失败、连接事件和遥测传输失败的单独策略

交货设置

安装并初始化服务器端

此服务端示例通过 Log API 发送事件,使用服务端密钥和有时限的 fetch 请求;无需初始化 Telemetry SDK。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。

redis-node-安装

npm安装

bash
npm install redis
  1. 1准备一个具有有限网络行为的可重用服务器端交付客户端。
  2. 2在成功、失败、重试或超时边界处添加结果事件。
  3. 3在启用警报之前发送受控装置并检查存储的行。

片段

从一个结构化事件开始

在工作流程完成、失败或重试的位置添加此形状。然后从真实的字段构建仪表板。

redis-node

Redis and node-redis telemetry事件

javascript
async function recordOutcome(data) {
  try {
    const receipt = await fetch("https://api.telemetry.sh/log", {
      method: "POST",
      headers: {
        Authorization: process.env.TELEMETRY_API_KEY,
        "Content-Type": "application/json",
      },
      body: JSON.stringify({ table: "cache_operation_completed", data }),
      signal: AbortSignal.timeout(2_000),
    });
    if (!receipt.ok) console.warn("Telemetry ingestion failed", receipt.status);
  } catch {
    console.warn("Telemetry ingestion unavailable");
  }
}

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

  try {
    const value = await redis.get(`project:${projectId}`);
    await recordOutcome({
      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 = "redis_error";
    await recordOutcome({
      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;
  }
}

事件结构

操作、cache_name、状态、命中和 fallback_used

latency_ms、error_type、重连、释放、环境

key_namespace 仅当它是固定类别而不是客户派生密钥时

检查配置

检查站 1

Delivery is best-effort with a two-second fetch timeout. Ingestion failure preserves the application result or original error; verify the event with a query and use a durable outbox when loss is unacceptable.

检查站 2

包装您需要测量的应用程序操作;不要对 Redis 客户端进行猴子修补或默认发出每个命令。

检查站 3

切勿发送 Redis URL、凭证、原始键、值、命令参数、通道消息或 Lua 源。

检查站 4

保留 node-redis 所需的 Redis 错误侦听器,但限制连接遥测速率,以便重新连接风暴不会造成第二次过载。

验证

证明事件已到达

在演练已知的成功和失败案例后运行此命令。如果您的最终事件契约与代码片段不同,请替换后备表名称。

redis-node-验证

Redis and node-redis telemetry 验证查询

sql
SELECT *
FROM cache_operation_completed
ORDER BY timestamp_utc DESC
LIMIT 20;
确认每个逻辑结果的一个终端行,以及预期状态、标识符、单位和 UTC 时间。
检查推断的架构并验证重试不会更改字段类型或生成新的逻辑事件 ID。
在存储的字段中搜索凭据、原始有效负载、提示、私有内容和无限制的错误消息。
在将仪表板视为完整之前,请执行提供程序超时、摄取拒绝和进程关闭。

实施参考

在启用新的生产路径之前,请检查事件合同、数据安全指南和上游主要文档。

在哪里记录事件

保持结果事件小且可恢复

该模式提供了

  • 除了上游工作流程之外,还有一个有界的、SQL 就绪的结果。
  • 用于仪表板、警报和跨事件关联的稳定字段。
  • 用于验证成功、失败、重试和超时行为的夹具驱动路径。

该模式不提供

  • OTLP 导出器、自动收集管道或详细跟踪和诊断日志的替代品。
  • 仅因为有效负载包含事件 ID,所以仅传送一次。
  • 收集原始提供商有效负载、用户内容、凭证或受监管数据的权限。

事件模式示例

在将查询或代码片段适应生产之前,请检查行粒度、发出边界、所需类型、隐私类、示例有效负载和验证清单。

相关产品功能

继续此工作流程 告警

将经过审查的可靠性查询提升到拥有的阈值和响应工作流程中。

相关 SQL 查询示例

更多 SQL 示例

针对此工作流程中的结构化字段运行查询,检查示例结果,并将有用的答案转换为仪表板或警报。

浏览所有查询示例

按实施系列浏览

比较相关集成模式

与此集成配对的模板

更多集成