跳至主要內容
Telemetry
整合指南

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

    埋點邊界

    包裝您需要測量的應用程式操作;不要對 Redis 客戶端進行猴子修補或預設發出每個命令。

  4. 4

    核實證據

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

開始之前

先決條件和界限

  • node-redis 和 telemetry-sh 在受信任的 Node.js 處理程序中初始化一次
  • 排除原始鍵和命令參數的有界操作分類法
  • 針對命令失敗、連線事件和遙測傳輸失敗的單獨策略

交貨設定

安裝並初始化伺服器端

在僅伺服器程式碼中匯入 telemetry-sh 並使用 process.env.TELEMETRY_API_KEY 對其進行一次初始化。 將攝取憑據保留在瀏覽器包、客戶端可見的環境變數、原始碼控制、日誌和異常訊息之外。

redis-node-install

npm安裝

bash
npm install telemetry-sh
  1. 1準備一個具有有限網路行為的可重用伺服器端交付客戶端。
  2. 2在成功、失敗、重試或超時邊界處新增結果事件。
  3. 3在啟用警示之前傳送受控裝置並檢查儲存的行。

片段

從一個結構化事件開始

在工作流程完成、失敗或重試的位置新增此形狀。然後從真實的欄位建置儀表板。

redis-node

Redis and node-redis Telemetry事件

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;
  }
}

活動合約

操作、cache_name、狀態、命中和 fallback_used

latency_ms、error_type、重連、釋放、環境

key_namespace 僅當它是固定類別而不是客戶派生金鑰時

實施檢查點

檢查站 1

包裝您需要測量的應用程式操作;不要對 Redis 客戶端進行猴子修補或預設發出每個命令。

檢查站 2

切勿傳送 Redis URL、憑證、原始鍵、值、命令參數、通道訊息或 Lua 源。

檢查站 3

保留 node-redis 所需的 Redis 錯誤偵聽器,但限制連線遙測速率,以便重新連線風暴不會造成第二次過載。

驗證

證明事件已到達

在演練已知的成功和失敗案例後執行此命令。如果您的最終事件契約與程式碼片段不同,請替換後備資料表名稱。

redis-node-verification

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 回答下一個問題

針對此工作流程中的結構化欄位執行查詢,檢查範例結果,並將有用的答案轉換為儀表板或警示。

瀏覽所有查詢範例

按實施系列瀏覽

比較相關整合模式

與此整合配對的範本

更多整合