このページは Cloud Translation API によって翻訳されました。

カスタムプラグインを開発する

<ph type="x-smartling-placeholder"></ph> 現在、Apigee Edge のドキュメントが表示されています。
Apigee X のドキュメント。詳細

Edge マネージャー v. 3.2.x

オーディエンス

このトピックは、次を書いて Edge Dataproc の機能を拡張するデベロッパーを対象としています。使用できます。新しいプラグインを作成する場合は、JavaScript と Node.js の使用経験を必要ありません。

カスタム Edge Scanner プラグインとは

プラグインは、Edge Scanner に機能を追加する Node.js モジュールです。プラグインモジュール一貫したパターンに従って、そのデータが Edge 自動的に検出、実行されます。いくつかの事前定義プラグインが用意されており、インストールします。これには、Authentication、Spike Arrest、Quota、分析できますこれらの既存のプラグインについては、プラグインを使用するをご覧ください。

custom プラグインをご覧ください。デフォルトでは、Edge Appliance は基本的に安全なパススループロキシです。変更されることなく、ターゲットサービス間でリクエストとレスポンスを渡す。カスタムプラグインを使用すると、マイクロゲートウェイを通過するリクエストおよびレスポンスをプログラムで操作します。

カスタムプラグインコードの配置場所

カスタムプラグイン用のフォルダは Edge Appliance のインストールに含まれています。こちらをご覧ください。

[prefix]/lib/node_modules/edgemicro/node_modules/microgateway-plugins

ここで、[prefix] は npm 接頭辞ディレクトリです。詳細は、このモジュールのコースリソースに記載のEdge のインストールに関するページできます。

このデフォルトのプラグインディレクトリは変更できます。詳しくは、設定方法プラグインをご覧ください。

事前定義プラグインの確認

独自のプラグインを開発する前に、事前定義されたプラグインが実装されていないことを要件を満たす必要があります。これらのプラグインは次の場所にあります。

[prefix]/lib/node_modules/edgemicro/node_modules/microgateway-plugins

ここで、[prefix] は npm 接頭辞ディレクトリです。詳しくは、「Edge Apigee がインストールされている場所」もご覧ください。Edge のインストールに関するページできます。

詳しくは、事前定義プラグインをご覧ください。

シンプルなプラグインを作成する

このセクションでは、簡単なプラグインの作成に必要な手順を説明します。このプラグインレスポンスデータ（その内容）を文字列「Hello, World!」でオーバーライドします。出力し、終端します。

Edge Appliance が実行中の場合は、この時点で停止します。
```
edgemicro stop
```
cd でカスタムプラグインディレクトリに移動します。
cd [prefix]/lib/node_modules/edgemicro/plugins

ここで、[prefix] は npm 接頭辞ディレクトリです。（詳細は「Edge Gateway のインストール場所」を参照）Edge のインストールに関するページできます。
response-override と cd という名前の新しいプラグインプロジェクトを作成します。変更します。
```
mkdir response-override && cd response-override
```
新しい Node.js プロジェクトを作成します。
```
npm init
```
Return キーを何度か押して、デフォルト値を受け入れます。
テキストエディタを使用して、index.js という名前の新しいファイルを作成します。
次のコードを index.js にコピーし、ファイルを保存します。
```
'use strict';
var debug = require('debug')

module.exports.init = function(config, logger, stats) {

  return {
   
    ondata_response: function(req, res, data, next) {
      debug('***** plugin ondata_response');
      next(null, null);
    },
    
    onend_response: function(req, res, data, next) {
      debug('***** plugin onend_response');
      next(null, "Hello, World!\n\n");
    }
  };
}
```
注: プラグイン関数（*_response）は、 イベントハンドラ。ondata_response 関数この API 呼び出しは、データのチャンクが Edge Dataproc によって受信されるたびに呼び出されます。「 onend_response 関数は、Cloud Storage バケットの最後のバイトがレスポンスデータが受信されます。

注: 重要: next() 関数はすべてのプラグイン関数で必要です。この関数は、error（最初の引数）と data（2 番目の引数）を渡します。次に呼び出されるプラグイン関数に渡されます。この例では、 ondata_response の data 引数は null。この引数を null に設定すると、 onend_response のレスポンスデータ。この変数を null に設定すると、データはデフォルトでオーバーライドするかどうかに関係なく、 onend_response。
プラグインを作成したので、次は Edge Appliance の構成にプラグインを追加する必要があります。 $HOME/.edgemicro/[org]-[env]-config.yaml ファイルを開きます。org と env は、Edge の組織名と環境名です。
response-override プラグインを plugins:sequence 要素に追加する下に示します。
```
      ...
      
      plugins:
        dir: ../plugins
        sequence:
          - oauth
          - response-override
          
      ...
```
注: 注: プラグインは、 plugins:sequence リストに表示されます。
Edge Appliance を再起動します。
Edge Appliance を介して API を呼び出します。（この API 呼び出しでは、同じ API 呼び出しが API キーのセキュリティに関するチュートリアルと同じ構成を使用します。詳しくは、 Edge Dataproc の構成:
```
curl -H 'x-api-key: uAM4gBSb6YoMvTHfx5lXJizYIpr5Jd' http://localhost:8000/hello/echo
Hello, World!
```

プラグインの構造

次の Edge AppSheet サンプルプラグインは、次の場合に従うパターンを示しています。独自のプラグインを開発できます。このセクションで説明するサンプルプラグインのソースコードは、 plugins/header-uppercase/index.js.内

プラグインは、package.json と index.js を備えた標準の NPM モジュールです。ルートフォルダにあります。
プラグインは init() 関数をエクスポートする必要があります。
init() 関数は、config、 logger、stats です。これらの引数については、プラグインの init() 関数の引数。
init() は、呼び出されたときに呼び出される名前付き関数ハンドラを含むオブジェクトを返します特定のイベントがリクエストの全期間で発生します。

イベントハンドラ関数

プラグインでは、これらのイベントハンドラ関数の一部またはすべてを実装する必要があります。これらの実装使用するかどうかは任意です。どの関数も省略可能で、一般的なプラグインはサブセットを残さずに済みます

リクエストフローのイベントハンドラ

これらの関数は、Edge API のリクエストイベントで呼び出されます。

onrequest
ondata_request
onend_request
onclose_request
onerror_request

onrequest 関数

クライアントリクエストの開始時に呼び出されます。この関数は、呼び出しのバイト数の最初のバイトが受信します。この関数を使用すると、リクエストヘッダー、 URL、クエリパラメータ、HTTP メソッド。真実の第 1 引数（リクエストがあった場合、リクエスト処理は停止し、ターゲットリクエストは開始されません。

例:

onrequest: function(req, res, next) {
      debug('plugin onrequest');
      req.headers['x-foo-request-start'] = Date.now();
      next();
    }

ondata_request 関数

クライアントからデータのチャンクを受信したときに呼び出されます。リクエストデータを次の使用します。シーケンスの最後のプラグインからの戻り値は、ターゲットです。以下に示す一般的なユースケースでは、リクエストデータを送信前に変換します。必要があります。

例:

ondata_request: function(req, res, data, next) {
      debug('plugin ondata_request ' + data.length);
      var transformed = data.toString().toUpperCase();
      next(null, transformed);
    }

onend_request 関数

クライアントからすべてのリクエストデータを受信したときに呼び出されます。

例:

onend_request: function(req, res, data, next) {
      debug('plugin onend_request');
      next(null, data);
    }

onclose_request 関数

クライアント接続が閉じたことを示します。この関数はクライアント接続が不安定です。クライアントへのソケット接続が確立されたときに閉じています。

例:

onclose_request: function(req, res, next) {
      debug('plugin onclose_request');
      next();
    }

onerror_request 関数

クライアントリクエストの受信中にエラーが発生した場合に呼び出されます。

例:

onerror_request: function(req, res, err, next) {
      debug('plugin onerror_request ' + err);
      next();
    }

レスポンスフローのイベントハンドラ

これらの関数は、Edge Appliance のレスポンスイベントで呼び出されます。

onresponse
ondata_response
onend_response
onclose_response
onerror_response

onresponse 関数

ターゲットレスポンスの開始時に呼び出されます。この関数は、呼び出しのバイト数の最初のバイトがレスポンスが返されます。この関数を使用すると、レスポンスヘッダーにステータスコードが含まれます。

例:

onresponse: function(req, res, next) {      
    debug('plugin onresponse');     
    res.setHeader('x-foo-response-time', Date.now() - req.headers['x-foo-request-start'])    
    next();    
}

ondata_response 関数

ターゲットからデータのチャンクを受信したときに呼び出されます。

例:

ondata_response: function(req, res, data, next) {
      debug('plugin ondata_response ' + data.length);
      var transformed = data.toString().toUpperCase();
      next(null, transformed);
    }

onend_response 関数

ターゲットからすべてのレスポンスデータを受信したときに呼び出されます。

例:

onend_response: function(req, res, data, next) {
      debug('plugin onend_response');
      next(null, data);
    }

onclose_response 関数

ターゲット接続が終了したことを示します。この関数はターゲット接続が不安定です。ターゲットへのソケット接続が確立されたときに閉じています。

例:

onclose_response: function(req, res, next) {
      debug('plugin onclose_response');
      next();
    }

onerror_response 関数

ターゲットレスポンスの受信中にエラーが発生した場合に呼び出されます。

例:

onerror_response: function(req, res, err, next) {
      debug('plugin onerror_response ' + err);
      next();
    }

Google Cloud コンソールについて知っておくべきことプラグインのイベントハンドラ関数

プラグインイベントハンドラ関数は、プラグインの実行時に発生する特定のイベントに応答して呼び出されます。 Edge Appliance は、指定された API リクエストを処理します。

各 init() 関数ハンドラ（ondata_request、 ondata_response など）では、完了したら next() コールバックを呼び出す必要があるあります。next() を呼び出さないと処理が停止し、リクエストはがハングします。
next() の最初の引数は、リクエストを引き起こすエラーである場合があります。処理が終了します
ondata_ ハンドラと onend_ ハンドラは、 next() は、ターゲットに渡すデータを含む 2 番目の引数で置き換えますできます。プラグインがバッファリングしていて、十分なデータがない場合、この引数を null にできます。考えています
すべてのリクエストとレスポンスに対応するために、プラグインのインスタンスを 1 つ使用します。呼び出し間でリクエストごとの状態を保持したい場合は、プラグインでその状態を指定された request オブジェクト（req）に追加されるプロパティ。 Life は API 呼び出しの所要時間です。
すべてのエラーを注意深くキャッチし、エラーを指定して next() を呼び出すようにしてください。失敗 next() を呼び出すと API 呼び出しがハングします。
メモリリークが発生しないように注意してください。Edge の全体的なパフォーマンスに影響する可能性があります。メモリ不足になるとクラッシュします
メインノードではコンピューティング負荷の高いタスクを行わず、Node.js モデルに従うようにしてください。使用する必要があります。

プラグインの init() 関数について

このセクションでは、init() 関数に渡される引数について説明します。 config、logger、stats。

config

Edge Appliance の構成ファイルを Apigee Edge からダウンロードされたデータは、config という名前のオブジェクトに配置されます。

値が foo の param という構成パラメータを追加するには: response-override というプラグインに追加する場合は、これを default.yaml に配置します。ファイル:

response-override:
    param: foo

すると、次のようにプラグインコードでパラメータにアクセスできるようになります。

// Called when response data is received
    ondata_response: function(req, res, data, next) {
      debug('***** plugin ondata_response');
      debug('***** plugin ondata_response: config.param: ' + config.param);
      next(null, data);
    },

この場合、プラグインのデバッグ出力に foo が出力されます。

Sun, 13 Dec 2015 21:25:08 GMT plugin:response-override ***** plugin ondata_response: config.param: foo

マイページ統合したマイクロゲートウェイ構成にアクセスして、ダウンロードした Apigee Edge データを子オブジェクト config.emgConfigs。たとえば init 関数でこの構成データにアクセスできます。次のとおりです。

module.exports.init = function(config, logger, stats) {
   let emgconfigs = config.emgConfigs;

注: emgConfigs オブジェクトは追加済みです。。キー名 emgConfigs は予約済みのため、使用できません YAML 構成ファイル内のプラグインの構成で、他の構成を定義するために使用されます。表示されます。条件値がランタイム時に上書きされます。

emgConfigs に含まれるデータの例を次に示します。

{
    edgemicro:
    {
        port: 8000,
        max_connections: 1000,
        config_change_poll_interval: 600,
        logging:
        {
            level: 'error',
            dir: '/var/tmp',
            stats_log_interval: 60,
            rotate_interval: 24,
            stack_trace: false
        },
        plugins: { sequence: [Array] },
        global: { org: 'Your Org', env: 'test' }
    },
    headers:
    {
        'x-forwarded-for': true,
        'x-forwarded-host': true,
        'x-request-id': true,
        'x-response-time': true,
        via: true
    },
    proxies:
    [    {
                max_connections: 1000,
                name: 'edgemicro_delayed',
                revision: '1',
                proxy_name: 'default',
                base_path: '/edgemicro_delayed',
                target_name: 'default',
                url: 'https://httpbin.org/delay/10',
                timeout: 0
            }
    ],
    product_to_proxy: { EdgeMicroTestProduct: [ 'edgemicro-auth','edgemicro_delayed',] },
    product_to_scopes: {prod4: [ 'Admin', 'Guest', 'Student' ] },
    product_to_api_resource: { EdgeMicroTestProduct: [ '/*' ] },
    _hash: 0,
    keys: { key: 'Your key', secret: 'Your key ' },
    uid: 'Internally generated uuid',
    targets: []
  }

logger

システムロガー。現在使用されているロガーは、これらの関数をエクスポートします。ここでは、文字列、HTTP リクエスト、HTTP レスポンス、Error インスタンスです。

info(object, message)
warn(object, message)
error(object, message)
trace(object, message)
debug(object, message)

stats

リクエスト、レスポンス、エラーの数、その他の集計された統計情報を保持するオブジェクト関連するリクエストとレスポンスに関するログエントリが含まれます

treqErrors - エラーのあるターゲットリクエストの数。
treqErrors - エラーのあるターゲットレスポンスの数。
statusCodes - レスポンスコード数を含むオブジェクト。

{
  1: number of target responses with 1xx response codes
  2: number of target responses with 2xx response codes
  3: number of target responses with 3xx response codes
  4: number of target responses with 4xx response codes
  5: number of target responses with 5xx response codes
  }

requests - リクエストの合計数。
responses - レスポンスの合計数。
connections - アクティブなターゲット接続の数。

next() 関数について

すべてのプラグインメソッドは、next() を呼び出して（プラグインプロセスがハングします）。リクエストのライフサイクルで最初に呼び出されるメソッドは、 onrequest() を呼び出します。次に呼び出されるメソッドは ondata_request() メソッドです。ただし、 ondata_request は、リクエストにデータが含まれている場合にのみ呼び出されます。次に例を示します。 POST リクエストの場合などです。次に呼び出されるメソッドは、 onend_request(): リクエストの処理が完了すると呼び出されます。「 onerror_* 関数はエラー発生時にのみ呼び出されるため、次のことができます。必要に応じてカスタムコードでエラーを処理できます

リクエストでデータが送信され、ondata_request() が呼び出されたとします。お知らせこの関数は、次の 2 つのパラメータで next() を呼び出します。

next(null, data);

慣例として、最初のパラメータはエラー情報を伝えるために使用されます。これにより、チェーン内の後続の関数で処理します。null に設定すると、偽エラーはなく、リクエスト処理は通常どおり続行されるはずです。条件この引数が true（エラーオブジェクトなど）である場合、リクエスト処理は停止し、リクエストはターゲットに送信されます

2 番目のパラメータは、チェーンの次の関数にリクエストデータを渡します。「いいえ」の場合: 追加の処理が行われると、リクエストデータは変更されることなく API のターゲットに渡されます。ただし、このメソッド内のリクエストデータを変更して、変更された構成されます。たとえば、リクエストデータが XML で、ターゲットが JSON を想定している場合、次に、ondata_request() メソッドにコードを追加します。これにより、（a）リクエストヘッダーの Content-Type を application/json に変換し、リクエストデータを変換します。任意の方法を使用して JSON に変換します（たとえば、Node.js NPM から取得した xml2json コンバータ）。

どのように表示されるかを確認してみましょう。

ondata_request: function(req, res, data, next) {
  debug('****** plugin ondata_request');
  var translated_data = parser.toJson(data);
  next(null, translated_data);
},

この場合、リクエストデータ（XML と想定されています）は JSON に変換され、変換されたデータが next() を介してリクエストチェーンの次の関数に渡されます。渡されます。

別のデバッグステートメントを追加して、デバッグ用に変換されたデータを出力することもできます。あります。例:

ondata_request: function(req, res, data, next) {
  debug('****** plugin ondata_request');
  var translated_data = parser.toJson(data);
  debug('****** plugin ondata_response: translated_json: ' + translated_json);
  next(null, translated_data);
},

概要プラグインハンドラの実行順序

Edge AppSheet 用のプラグインを作成する場合は、どの順序でプラグインが記述されるかを理解する必要があります。イベントハンドラが実行されます。

覚えておくべき重要な点は、Edge でプラグインシーケンスを指定する際、リクエストハンドラは昇順で実行されます。レスポンスハンドラは降順で実行されます。

次の例は、この実行順序を理解するのに役立ちます。

1. 3 つのシンプルなプラグイン

次のプラグインについて考えてみましょう。イベントハンドラが呼び出されたときにコンソール出力を出力するだけです。呼び出し:

plugins/plugin-1/index.js

module.exports.init = function(config, logger, stats) {

  return {

    onrequest: function(req, res, next) {
      console.log('plugin-1: onrequest');
      next();
    },

    onend_request: function(req, res, data, next) {
      console.log('plugin-1: onend_request');
      next(null, data);
    },

    ondata_response: function(req, res, data, next) {
      console.log('plugin-1: ondata_response ' + data.length);
      next(null, data);
    },

    onend_response: function(req, res, data, next) {
      console.log('plugin-1: onend_response');
      next(null, data);
    }
  };
}

ここで、plugin-2 と plugin-3 という 2 つのプラグインを追加で作成し、同じコード（ただし、console.log() ステートメントを plugin-2 に変更します。（それぞれ plugin-3）です。

2. プラグインコードを確認する

エクスポートされたプラグイン関数は、 <microgateway-root-dir>/plugins/plugin-1/index.js は、イベントハンドラでリクエストとレスポンスの処理中に、特定の時間に実行されるように設定できます。たとえば onrequest は、受信したリクエストヘッダーの最初のバイトを実行します。しかし、 onend_response は、レスポンスデータの最後のバイトが受信された後に実行されます。

ハンドラの ondata_response をご覧ください。このハンドラは、レスポンスデータのチャンクが応答するたびに受信します。知っておくべき重要な点は、レスポンスデータは必ずしもすべての時点で受信されるわけではない 1 回だけです。データは任意の長さのチャンクで受信される可能性があります。

3. プラグインをプラグインのシーケンス

この例では、Edge のプラグインシーケンスにプラグインを追加します。次のとおりに更新します。~./edgemicro/config.yamlシーケンスは次のとおりです。重要ですプラグインハンドラの実行順序を定義します。

  plugins:
    dir: ../plugins
    sequence:
      - plugin-1
      - plugin-2
      - plugin-3

4. デバッグ出力を調べる

では、これらのプラグインが呼び出されたときに生成される出力を見てみましょう。他にも次の点に注意してください。

Edge AppSheet 構成ファイルのプラグイン順序（~./edgemicro/config.yaml）は、イベントハンドラを呼び出すことができます。
リクエストハンドラは、昇順（リクエストハンドラががプラグインの順番に表示されます（1、2、3）。
レスポンスハンドラは、3、2、1 という降順で呼び出されます。
ondata_response ハンドラは、データチャンクごとに 1 回呼び出されます。表示されます。この例（出力は下記）では、2 つのチャンクを受信します。

以下は、この 3 つのプラグインが使用されていて、リクエストが送信された場合に生成されるデバッグ出力のサンプルです。接続しますハンドラが呼び出される順序に注目してください。

  plugin-1: onrequest
  plugin-2: onrequest
  plugin-3: onrequest

  plugin-1: onend_request
  plugin-2: onend_request
  plugin-3: onend_request

  plugin-3: ondata_response 931
  plugin-2: ondata_response 931
  plugin-1: ondata_response 931

  plugin-3: ondata_response 1808
  plugin-3: onend_response

  plugin-2: ondata_response 1808
  plugin-2: onend_response

  plugin-1: ondata_response 1808
  plugin-1: onend_response

概要

プラグインハンドラが呼び出される順序を理解することは、リクエストやレスポンスの蓄積と変換など、カスタムプラグイン機能を実装する分析できます

リクエストハンドラはプラグインの実行順序で実行されることに留意してください。指定され、レスポンスハンドラはインスタンスレベルで実行されます。逆の順序になります。

プラグインでのグローバル変数の使用について

Edge Appliance へのすべてのリクエストは、プラグインの同じインスタンスに送信されます。したがって、別のクライアントからの 2 番目のリクエストの状態によって、最初のリクエストが上書きされます。安全に操作できる唯一のプラグインの状態を保存するには、リクエストオブジェクトまたはレスポンスオブジェクトのプロパティ（リクエストのライフタイムに限定されます）。

プラグインのターゲット URL の書き換え

v2.3.3 で追加

これらの変数を変更することで、プラグインのデフォルトのターゲット URL を動的にオーバーライドできます。プラグインコード内の req.targetHostname と req.targetPath。

v2.4.x で追加

ターゲットエンドポイントポートをオーバーライドして、HTTP と HTTPS のいずれかを選択することもできます。これらをプラグインコード内の変数（req.targetPort、および req.targetSecure.HTTPS を選択するには、req.targetSecure を次のように設定します。 true;false に設定します。req.targetSecure を true の場合は、こちらのディスカッションスレッドをご覧ください。

eurekaclient というサンプルプラグインが Edge Appliance に追加されました。このプラグインは、req.targetPort 変数と req.targetSecure 変数を使用する方法と、 Edge Appliance が Eureka をサービスとして使用して動的エンドポイント検索を実行する方法を示しています。エンドポイント・カタログ

サンプルプラグイン

これらのプラグインは、Edge Apigee のインストールに付属しています。確認するには、 Edge Appliance のインストール先:

[prefix]/lib/node_modules/edgemicro/plugins

ここで、[prefix] は npm 接頭辞ディレクトリです。詳細は、このモジュールのコースリソースに記載のEdge のインストールに関するページできます。

accumulate-request

このプラグインは、クライアントからのデータチャンクを、リクエストオブジェクト。すべてのリクエストデータを受信すると、配列がバッファに連結されるシーケンスの次のプラグインに渡されます。このプラグインは、Google Cloud の累積されたリクエストデータを後続のプラグインが受信できるようにします。

module.exports.init = function(config, logger, stats) {

  function accumulate(req, data) {

    if (!req._chunks) req._chunks = [];
    req._chunks.push(data);

  }

  return {

    ondata_request: function(req, res, data, next) {

      if (data && data.length > 0) accumulate(req, data);

      next(null, null);

    },


    onend_request: function(req, res, data, next) {

      if (data && data.length > 0) accumulate(req, data);

      var content = null;

      if (req._chunks && req._chunks.length) {

        content = Buffer.concat(req._chunks);

      }

      delete req._chunks;

      next(null, content);

    }

  };

}

accumulate-response

このプラグインは、ターゲットからのデータチャンクを、レスポンスオブジェクト。すべてのレスポンスデータを受信すると、配列はバッファに連結されます。シーケンスの次のプラグインに渡されます。このプラグインは Google Cloud 上で逆の順序で処理するため、最後のプラグインとして配置する必要があります。必要があります。

module.exports.init = function(config, logger, stats) {

  function accumulate(res, data) {
    if (!res._chunks) res._chunks = [];
    res._chunks.push(data);
  }

  return {

    ondata_response: function(req, res, data, next) {
      if (data && data.length > 0) accumulate(res, data);
      next(null, null);
    },

    onend_response: function(req, res, data, next) {
      if (data && data.length > 0) accumulate(res, data);
      var content = Buffer.concat(res._chunks);
      delete res._chunks;
      next(null, content);
    }

  };

}

header-uppercase プラグイン

Edge Appliance のディストリビューションには、次のサンプルプラグインが含まれています。 <microgateway-root-dir>/plugins/header-uppercase。このサンプルにはコメントが含まれています。各関数ハンドラを記述します。このサンプルでは、単純なデータ変換にクライアントリクエストとターゲットレスポンスにカスタムヘッダーを追加します。

このソースコードは、 <microgateway-root-dir>/plugins/header-uppercase/index.js:

'use strict';

var debug = require('debug')('plugin:header-uppercase');

// required
module.exports.init = function(config, logger, stats) {

  var counter = 0;

  return {

    // indicates start of client request
    // request headers, url, query params, method should be available at this time
    // request processing stops (and a target request is not initiated) if
    // next is called with a truthy first argument (an instance of Error, for example)
    onrequest: function(req, res, next) {
      debug('plugin onrequest');
      req.headers['x-foo-request-id'] = counter++;
      req.headers['x-foo-request-start'] = Date.now();
      next();
    },

    // indicates start of target response
    // response headers and status code should be available at this time
    onresponse: function(req, res, next) {
      debug('plugin onresponse');
      res.setHeader('x-foo-response-id', req.headers['x-foo-request-id']);
      res.setHeader('x-foo-response-time', Date.now() - req.headers['x-foo-request-start']);
      next();
    },

    // chunk of request body data received from client
    // should return (potentially) transformed data for next plugin in chain
    // the returned value from the last plugin in the chain is written to the target
    ondata_request: function(req, res, data, next) {
      debug('plugin ondata_request ' + data.length);
      var transformed = data.toString().toUpperCase();
      next(null, transformed);
    },

    // chunk of response body data received from target
    // should return (potentially) transformed data for next plugin in chain
    // the returned value from the last plugin in the chain is written to the client
    ondata_response: function(req, res, data, next) {
      debug('plugin ondata_response ' + data.length);
      var transformed = data.toString().toUpperCase();
      next(null, transformed);
    },

    // indicates end of client request
    onend_request: function(req, res, data, next) {
      debug('plugin onend_request');
      next(null, data);
    },

    // indicates end of target response
    onend_response: function(req, res, data, next) {
      debug('plugin onend_response');
      next(null, data);
    },

    // error receiving client request
    onerror_request: function(req, res, err, next) {
      debug('plugin onerror_request ' + err);
      next();
    },

    // error receiving target response
    onerror_response: function(req, res, err, next) {
      debug('plugin onerror_response ' + err);
      next();
    },

    // indicates client connection closed
    onclose_request: function(req, res, next) {
      debug('plugin onclose_request');
      next();
    },

    // indicates target connection closed
    onclose_response: function(req, res, next) {
      debug('plugin onclose_response');
      next();
    }

  };

}

変換（大文字）

これは汎用的な変換プラグインで、どのような種類の処理にもできます。この例では、レスポンスとリクエストデータを単純に使用します。

 */
module.exports.init = function(config, logger, stats) {

  // perform content transformation here
  // the result of the transformation must be another Buffer
  function transform(data) {
    return new Buffer(data.toString().toUpperCase());
  }

  return {

    ondata_response: function(req, res, data, next) {
      // transform each chunk as it is received
      next(null, data ? transform(data) : null);
    },

    onend_response: function(req, res, data, next) {
      // transform accumulated data, if any
      next(null, data ? transform(data) : null);
    },

    ondata_request: function(req, res, data, next) {
      // transform each chunk as it is received
      next(null, data ? transform(data) : null);
    },

    onend_request: function(req, res, data, next) {
      // transform accumulated data, if any
      next(null, data ? transform(data) : null);
    }

  };

}