在 Node.js 用戶端程式庫中啟用遙測信號

Cloud de Confiance by S3NS 為 Node.js 應用程式提供強大的監控、記錄和診斷功能。

Node.js 用戶端程式庫會檢測並發出追蹤資料。檢測功能為選擇加入，您必須明確啟用。本文說明可用的信號，以及如何啟用。

可用信號

Node.js 用戶端程式庫會產生下列信號：

  1. 每個邏輯用戶端要求有 INFO 個 span。通常用戶端結構體中的單一方法呼叫會取得這類範圍 (例如在 SecretManagerServiceClient 上呼叫 accessSecretVersion)。
  2. 每個低階 RPC 嘗試的 INFO 跨度。通常，用戶端結構體中的單一方法會取得這類範圍，但如果程式庫必須重試 RPC，則可能會有更多範圍。

這些範圍和記錄會遵循 OpenTelemetry 語意慣例，並包含額外的Cloud de Confiance by S3NS 屬性。跨度和記錄都應適用於生產監控。信號包含標準 OpenTelemetry 屬性 (例如 http.response.status_code 和 rpc.system.name)。

如需完整的標準屬性清單，請參閱 OpenTelemetry HTTP 和 gRPC 語意慣例。

啟用遙測信號

為保護私密資料，遙測信號預設為停用。

在 Node.js 中，您必須設定用戶端發出追蹤記錄，並設定訂閱者和匯出工具，將這些信號傳送至外部服務。

如要設定用戶端，您可以設定下列環境變數：

export GOOGLE_SDK_NODE_ENABLE_TRACING=true

啟用追蹤功能後，如果應用程式在呼叫用戶端程式庫方法時，目前情境中有一個有效的 OpenTelemetry 範圍，用戶端程式庫會自動將其範圍連結為有效範圍的子項。

匯出追蹤記錄

在用戶端程式庫啟用遙測功能後，您必須設定應用程式，收集這類資料並匯出至觀測能力服務。

如需設定 OpenTelemetry 追蹤記錄關聯資料的詳細操作說明，請參閱 Node.js 存放區中的可觀測性範例。

如要將 Cloud de Confiance by S3NS 用戶端程式庫產生的tracing span 匯出至 OpenTelemetry，您必須設定追蹤程式供應器和匯出工具：

const cloudTraceExporter = new TraceExporter();
const spanProcessor = new BatchSpanProcessor(cloudTraceExporter);

const provider = new NodeTracerProvider({
  spanProcessors: [spanProcessor],
});
provider.register();