@scout_apm/scout-apm v0.2.3

Scout APM NodeJS クライアント

ScoutはNodeJSのアプリのパーフォーマンすを監視するツールです。インストールするとメトリック、リクエスト速度、トランスアクションのデータを@scout_apm/scout-apmで収集して、文責出来ます。

必須

NodeJS バージョン:

• 10+

Scout APM は下記に書いてあるフレームワークと簡単に使えます:

• ExpressJS 4.x

セットアップ

Scoutのアカウントが必要です。Scoutサインアップ.

インストール

npmで@scout_apm/scout-apmをインストール出来ます:

$ npm install @scout_apm/scout-apm

@scout_apm/scout-apm と express

Scoutはexpressのアプリケーションミドルウェアでと簡単にリクエストをトレース出来ます:

const express = require("express");
const app = express();
const scout = require("@scout_apm/scout-apm").expressMiddleware;

// ミドルウェアをインストール
app.use(scout());

// ルート設定
app.get('/', function (req, res) {
  res.send('hello, world!')
})

設定についての情報はdocs/configuration.mdに書いてます。

他のフレームワークやライブラリーと@scout_apm/scout-apm

他のフレームワークやライブラリーをトレースするためにPromiseのAPIが使えます:

const Scout = require("@scout_apm/scout-apm").Scout;
const scout = new Scout();

// Scoutオブジェクトのセットアップ
scout.setup()
    .then(scout => {
        // リクエスト開始
        return scout.startRequest()
            .then(scoutRequest => {
                // タスク実行
                return bigHeavyTaskThatReturnsAPromise()
                    // リクエスト終了
                    .then(() => scoutRequest.finishAndSend());
            });
    });
});

他の実例はdocs/cookbook.mdに書いてます。 アーキテクチャについて docs/architecture.mdをご覧になってください。

開発

@scout_apm/scout-apmを開発したい方は,下記に書いてるコマンドを実行してください:

$ make dev-setup

実行すると開発ための環境が作られます。gitのフックや他の開発に便利なものはインストールされます。

Makefileに開発してる時に便利なコマンドも含めています:

$ make lint # tslint実行
$ make lint-watch # 継続的にtslint実行

$ make build # tsc(タイプスクリプトのコンパイラ)実行
$ make build-watch # 継続的にtsc実行

開発についてdocs/development.mdをご覧になってください。

寄付 / 開発応援

@scout_apm/scout-apmの開発に参加手引き:

0. リポジトリーをクローン(git clone)
1. make dev-setup でローカル環境セットアップ
2. make build でプロジェクトをビルド
3. コードを書く
4. make testでテスト実行(テストについてはdocs/tests.mdを読んでください)
5. PR(プールリクエスト)を作る

ドキュメント

インストールとかトラブルシューティングのドキュメントはScoutのヘルプサイにあります。

サポート

@scout_apm/scout-apmに問題が発生したら:

• issueを作成してください
• メールでScoutを連絡してください: support@scoutapp.com