Node.js エージェント

SixthSense Node 監視を使用し、コード内の正確なエラーを追跡します。これによりアプリケーション環境の全体像が把握できるため問題の解決がより容易となります。

前提条件

エージェントのインストールに必要な前提条件についてはエージェントのインストールに必要な前提条件の確認を参照してください。
SixthSense エージェント：Node パッケージエージェントのダウンロードを参照してください。
SixthSense コレクターの URL/IP（SixthSense カスタマーサポートから提供されるテナント URL）
アクセストークン：トークンへのアクセスについては「SixthSense ポータルを利用開始する」にあるアクセストークンの取得を参照してください。
PACKAGE_TOKEN：カスタマーサポートから提供されるSixthSense パッケージのダウンロードに必要なアクセストークン

エージェントのダウンロード

SixthSense エージェントをプロジェクトの依存関係としてダウンロードします。「@SixthSense/SixthSense-node-js": "^2.2.5」
エージェント構成はアプリケーションのエントリーポイントに追加されます。例えば、Node.js アプリケーションのエントリーポイントは package.json ファイルで定義され、以下の例では server.js ファイルがエントリーポイントとなります。以下は package.json ファイルです。

{
 
    "name": "SixthSense-node-demo",
    "version": "2.2.5",
    "description": "RESTful API with Node Demo",
    "main": "server.js",
    "scripts":{
        "test": "echo \"Error: no tests specified\"&& exit 1"
    }
}

依存関係のあるエージェントを追加します。

"dependencies": {
    "@sixthsense/sixthsense-node-js": "^2.2.5"
}

エージェントを初期化し、名前を指定する

アプリケーションへのエントリーポイントは「server.js」です。ユーザーのアプリケーションによっては、エントリーポイントが異なる場合があります。そのため、以下に記載されているように、エントリーポイントファイルに楽天によるエージェント構成を追加してください。
serviceName 変数を使用してサービス名を指定します。

// Sixthsense Agent
var agent = require('@sixthsense/sixthsense-node-js').default
agent.start({
  serviceName: 'NAME_OF_THE_SERVICE',
  // The identifier of the instance
  // Collector agent_gRPC/grpc service addresses.
  directServers: 'grpc-collector-observability.sixthsense.rakuten.com:443',
  collectorAddress: 'grpc-collector-observability.sixthsense.rakuten.com:443',
  enableLogs: true,
  caPath: true,
  authorization: process.env.TOKEN
});

OneCloud Platform の場合は、以下のコマンドを使用します。

// Sixthsense Agent
var agent = require('@sixthsense/sixthsense-node-js').default
agent.start({
  serviceName: 'NAME_OF_THE_SERVICE',
  // The identifier of the instance
  // Collector agent_gRPC/grpc service addresses.
  // For connectivity to backend using onecloud  private network:  100.99.116.221:80
  // For connectivity to backend using intra public network: 133.237.176.44:80
  directServers: '133.237.176.44:80',
  collectorAddress: '133.237.176.44:80',
  enableLogs: true,
  agent.force_tls=${SW_AGENT_FORCE_TLS:false},
  caPath: true,
  authorization: process.env.TOKEN
});

SixthSense ポータルからアクセストークンを取得します。アクセストークンへのアクセスについては「SixthSense ポータルを利用開始する」にあるアクセストークンの取得を参照してください。
エントリーポイントファイルにアクセストークンを追加します。authorization: 'Access token'。

例として、上記のスニペットを参照してください。

アプリケーションの実行

npm install コマンドを実行する前に、以下のコマンドを実行します。

エージェントをダウンロードするには、Gitlab Package Registry からパッケージをダウンロードします。

npm config set @sixthsense:registry https://artifacts-observability.sixthsense.rakuten.com/api/v4/projects/3/packages/npm/
npm config set -- '//artifacts-observability.sixthsense.rakuten.com/api/v4/projects/3/packages/npm/:_authToken' "PACKAGE_TOKEN"

PACKAGE_TOKEN: SixthSense カスタマーサポートより提供
npm install コマンドを実行して、すべての依存関係をダウンロードします。

npm install @sixthsense/sixthsense-node-js

スタートコマンドを実行して、Node　アプリケーションを起動します。

SixthSense バックエンドへのネットワーク制限がある場合は、プロキシを使用するか、ネットワークチームに SixthSense バックエンドアドレスのホワイトリスト化を依頼して、データの送信を許可します。

システム/コンテナレベルでプロキシを設定します。

例： a. Windowsサーバー：システムレベルの環境変数に http_proxy、https_proxy を追加します。 b. Linux サーバー： ~/.bashrc ファイルに以下のようにプロキシを追加します。 export http_proxy=10.0.0.1:3128

ノードレベルでプロキシを渡します。

npm config set proxy http://username:password@host:port npm config set https-proxy https://username:password@host:port

npm のプロキシおよびその他の設定を行うには、コンソールで以下のコマンドを入力します。

npm config edit

このコマンドにより、.npmrc ファイルが開きます。このファイルに、npm に関連するプロキシ、https-proxy を設定します。

note

SW_IGNORE_SUFFIX、SW_TRACE_IGNORE_PATH、SW_HTTP_IGNORE_METHOD 等の様々な無視オプション、および SW_AGENT_MAX_BUFFER_SIZE を超過するため記録されなかったエンドポイントは、無視されたステータスのすべてを、それらを呼び出す可能性のある他のエンドポイントに対して伝達します。そのエンドポイントが Node Sixthsense エージェントを実行している場合、無視の設定に関わらず記録がされません（上流の親が記録されていないため）。これにより、関心のないエンドポイントのツリー全体を削除できるだけでなく、チェーンの一部が無視された場合でも、他のエンドポイントが実際の親ではなく ROOT の子として記録されている場合は、その部分的なトレースを削除することが可能です。