為 Node.js 設定 Stackdriver Trace

您可以使用 Node.js 適用的 Stackdriver Trace 程式庫來啟用 Stackdriver Trace 以追蹤 Node.js 應用程式的效能。

安裝用戶端程式庫

  1. 安裝 Node.js 適用的 Stackdriver Trace 程式庫前,請確認您已備妥適合開發 Node.js 的環境

  2. 要安裝 Node.js 適用的 Stackdriver Trace 程式庫,最簡單的方法是使用 npm

    npm install --save @google-cloud/trace-agent
  3. 在應用程式主要指令碼的最上方,或在任何其他程式碼之前的進入點,匯入 Node.js 適用的 Stackdriver Trace 程式庫:

    require('@google-cloud/trace-agent').start();

如要進一步瞭解 Node.js 適用的 Stackdriver Trace 程式庫,或回報相關問題,請參閱代理程式的原始碼存放區

設定用戶端程式庫

您可以自訂 Node.js 適用的 Stackdriver Trace 程式庫的行為。如需可能設定選項的清單,請參閱 GitHub 上的程式庫設定說明。這些選項可傳入已傳遞至程式庫的 start 方法的 options 物件中。

在 Google Cloud Platform 上執行

只要在 Google Cloud Platform 運作的執行個體上啟用了 Stackdriver Trace API 存取權範圍,就不需要為這個執行個體手動提供驗證憑證,Node.js 適用的 Stackdriver Trace 程式庫也可以運作。

App Engine 彈性環境

App Engine 彈性環境預設會啟用 Stackdriver Trace API 存取權範圍,因此您不需提供憑證或專案 ID,就可以使用 Node.js 適用的 Stackdriver Trace 程式庫。

App Engine 標準環境

App Engine 標準環境預設會啟用 Stackdriver Trace API 存取權範圍,因此您不需提供憑證或專案 ID,就可以使用 Node.js 適用的 Stackdriver Trace 程式庫。

Google Kubernetes Engine

如要將 Trace 與 GKE 搭配使用,請在建立叢集時新增 trace.append OAuth 存取權範圍。

如要使用 gcloud 建立叢集,請執行下列操作:

  1. (選用) 將 gcloud 更新到最新版本:
    gcloud components update
  2. 設定預設的專案 ID
    gcloud config set project [PROJECT_ID]
  3. 如果您使用區域叢集,請設定預設的運算區域
    gcloud config set compute/zone [COMPUTE_ZONE]
  4. 如果您使用地區叢集,請設定預設的運算地區
    gcloud config set compute/region [COMPUTE_REGION]
  5. 發出 create 指令:
    gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/trace.append

如需建立叢集的詳細資訊,請參閱建立叢集一文。

Compute Engine

針對 Compute Engine VM 執行個體,您必須明確地為每個 VM 執行個體啟用 trace.append Stackdriver Trace API 存取權範圍。透過 Google Cloud Platform 主控台新建執行個體時,請在「Create an instance」(建立執行個體) 面板的「Identity and API access」(身分與 API 存取權) 部分選取下列值:

  1. 為「Service account」(服務帳戶)選取 [Compute Engine default service account] (Compute Engine 預設服務帳戶)
  2. 為「Access Scopes」(存取權範圍) 選取 [Allow full access to all Cloud APIs] (允許所有 Cloud API 的完整存取權)。

如要使用 Compute Engine 預設服務帳戶以外的帳戶,請參閱為執行個體建立及啟用服務帳戶,以及在本機和其他地方執行一節。重點是您使用的服務帳戶必須具有 Cloud Trace 代理者角色

在本機及其他地方執行

如要在 GCP 以外的地方執行 Stackdriver Trace,您必須將 GCP 專案 ID 和適當的服務帳戶憑證直接提供給 Node.js 適用的 Stackdriver Trace 程式庫。您的服務帳戶必須包含 Cloud Trace 代理者角色。如需詳細操作說明,請參閱建立服務帳戶一文。

專案 ID

如要向 Node.js 適用的 Stackdriver Trace 程式庫提供專案 ID,請在已傳遞到程式庫的 start 方法的 options 物件中設定 projectId 值,或設定 GCLOUD_PROJECT 環境變數:

Linux 或 macOS

export GCLOUD_PROJECT=your-project-id

Windows

set GCLOUD_PROJECT=your-project-id

PowerShell:

$env:GCLOUD_PROJECT="your-project-id"

憑證

GCP 用戶端程式庫會使用應用程式預設憑證 (ADC) 來尋找應用程式的憑證。如要將憑證提供給 Node.js 適用的 Stackdriver Trace 程式庫,請設定 GOOGLE_APPLICATION_CREDENTIALS 環境變數:

Linux/macOS

    export GOOGLE_APPLICATION_CREDENTIALS=path-to-your-service-accounts-private-key

Windows

    set GOOGLE_APPLICATION_CREDENTIALS=path-to-your-service-accounts-private-key

PowerShell:

    $env:GOOGLE_APPLICATION_CREDENTIALS="path-to-your-service-accounts-private-key"

範例

require('@google-cloud/trace-agent').start({
  projectId: 'your-project-id',
  keyFilename: '/path/to/key.json'
});

應用程式範例

if (process.env.NODE_ENV === 'production') {
  require('@google-cloud/trace-agent').start();
}

const express = require('express');
const got = require('got');

const app = express();
const DISCOVERY_URL = 'https://www.googleapis.com/discovery/v1/apis';

// This incoming HTTP request should be captured by Trace
app.get('/', async (req, res) => {
  // This outgoing HTTP request should be captured by Trace
  try {
    const { body } = await got(DISCOVERY_URL, { json: true });
    const names = body.items.map((item) => item.name);
    res
      .status(200)
      .send(names.join('\n'))
      .end();
  }
  catch (err) {
    console.error(err);
    res
      .status(500)
      .end();
  }
});

// Start the server
const PORT = process.env.PORT || 8080;
app.listen(PORT, () => {
  console.log(`App listening on port ${PORT}`);
  console.log('Press Ctrl+C to quit.');
});

查看追蹤記錄

完成部署之後,您可在「GCP Console Trace Viewer」(GCP 主控台追蹤記錄檢視器) 中查看追蹤記錄。

前往「Trace Viewer」(追蹤記錄檢視器) 頁面

本頁內容對您是否有任何幫助?請提供意見:

傳送您對下列選項的寶貴意見...

這個網頁
Stackdriver Trace
需要協助嗎?請前往我們的支援網頁