Edge Microgateway の操作と構成のリファレンス

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントに移動します。
info

Edge Microgateway v. 2.3.x

概要

このトピックでは、モニタリング、ロギング、デバッグなど、Edge Microgateway の管理と構成の方法について説明します。

構成の変更

知っておくべき構成ファイルには、次のものがあります。

  • デフォルトのシステム構成ファイル
  • 新しく初期化された Edge Microgateway インスタンスのデフォルトの構成ファイル
  • 実行中のインスタンスの動的構成ファイル

このセクションでは、これらのファイルと、それらの変更について知っておくべきことについて説明します。構成ファイルの設定の詳細については、Edge Microgateway 構成リファレンスをご覧ください。

デフォルトのシステム構成ファイル

Edge Microgateway をインストールすると、デフォルトのシステム構成ファイルが次の場所に配置されます。

[prefix]/lib/node_modules/edgemicro/config/default.yaml

ここで、[prefix] は npm 接頭辞ディレクトリです。Edge Microgateway のインストール場所をご覧ください。

システム構成ファイルを変更した場合は、Edge Microgateway を再初期化、再構成、再起動する必要があります。

  1. edgemicro init に電話
  2. edgemicro configure [params] に電話
  3. edgemicro start [params] に電話

新しく初期化された Edge Microgateway インスタンスのデフォルトの構成ファイル

edgemicro init を実行すると、システム構成ファイル(前述) default.yaml が ~/.edgemicro ディレクトリに配置されます。

~/.edgemicro の構成ファイルを変更した場合は、Edge Microgateway を再構成して再起動する必要があります。

  1. edgemicro stop
  2. edgemicro configure [params]
  3. edgemicro start [params]

実行中のインスタンスの動的構成ファイル

edgemicro configure [params] を実行すると、~/.edgemicro に動的構成ファイルが作成されます。このファイルの名前は、[org]-[env]-config.yaml というパターンに従って付けられます。ここで、org と env は Apigee Edge の組織名と環境名です。このファイルを使用して構成を変更し、ダウンタイムなしで再読み込みできます。たとえば、プラグインを追加して構成する場合、以下で説明するように、ダウンタイムを発生させることなく構成を再読み込みできます。

Edge Microgateway が実行されている場合(ゼロ ダウンタイム オプション):

  1. Edge Microgateway 構成を再読み込みします。
    edgemicro reload -o [org] -e [env] -k [key] -s [secret]

    ここで

    • org は Edge 組織名です(組織管理者である必要があります)。
    • env は、組織内の環境(test や prod など)です。
    • key は、以前に configure コマンドによって返されたキーです。
    • secret は、configure コマンドによって以前に返されたキーです。

    例

    edgemicro reload -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d000723 -s 05c14356e42ed136b8dd35cf8a18531ff52d7299134677e30ef4e34ab0cc824

Edge Microgateway が停止している場合:

  1. Edge Microgateway を再起動します。
    edgemicro start -o [org] -e [env] -k [key] -s [secret]

    ここで

    • org は Edge 組織名です(組織管理者である必要があります)。
    • env は、組織内の環境(test や prod など)です。
    • key は、以前に configure コマンドによって返されたキーです。
    • secret は、configure コマンドによって以前に返されたキーです。

    例

    edgemicro start -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d000723 -s 05c14356e42ed136b8dd35cf8a18531ff52d7299134677e30ef4e34ab0cc824

以下に、構成ファイルの例を示します。構成ファイルの設定の詳細については、Edge Microgateway 構成リファレンスをご覧ください。

edge_config:
  bootstrap: >-
    https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/docs/environment/test
  jwt_public_key: 'https://docs-test.apigee.net/edgemicro-auth/publicKey'
  managementUri: 'https://api.enterprise.apigee.com'
  vaultName: microgateway
  authUri: 'https://%s-%s.apigee.net/edgemicro-auth'
  baseUri: >-
    https://edgemicroservices.apigee.net/edgemicro/%s/organization/%s/environment/%s
  bootstrapMessage: Please copy the following property to the edge micro agent config
  keySecretMessage: The following credentials are required to start edge micro
  products: 'https://docs-test.apigee.net/edgemicro-auth/products'
edgemicro:
  port: 8000
  max_connections: 1000
  max_connections_hard: 5000
  config_change_poll_interval: 600
  logging:
    level: error
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24
  plugins:
    sequence:
      - oauth
headers:
  x-forwarded-for: true
  x-forwarded-host: true
  x-request-id: true
  x-response-time: true
  via: true
oauth:
  allowNoAuthorization: false
  allowInvalidAuthorization: false
  verify_api_key_url: 'https://docs-test.apigee.net/edgemicro-auth/verifyApiKey'
analytics:
  uri: >-
    https://edgemicroservices-us-east-1.apigee.net/edgemicro/axpublisher/organization/docs/environment/test

環境変数の設定

Edge の組織と環境の値、および Edge Microgateway の起動に必要なキーとシークレットを必要とするコマンドライン インターフェース コマンドは、次の環境変数に保存できます。

  • EDGEMICRO_ORG
  • EDGEMICRO_ENV
  • EDGEMICRO_KEY
  • EDGEMICRO_SECRET

これらの変数の設定は任意です。これらの変数を設定すると、コマンドライン インターフェース(CLI)を使用して Edge Microgateway を構成して起動するときに、これらの値を指定する必要がなくなります。

Edge Microgateway サーバーでの SSL の構成

SSL を使用するように Microgateway サーバーを構成できます。たとえば、SSL を構成すると、次のように「https」プロトコルを使用して Edge Microgateway 経由で API を呼び出すことができます。

https://localhost:8000/myapi

Microgateway サーバーで SSL を構成する手順は次のとおりです。

  1. openssl ユーティリティまたは任意の方法を使用して、SSL 証明書と鍵を生成または取得します。
  2. Edge Microgateway 構成ファイルに edgemicro:ssl 属性を追加します。オプションの一覧については、以下の表をご覧ください。Edge Microgateway 構成の変更の詳細については、構成の変更をご覧ください。例:
     edgemicro:
         ssl:
             key: <absolute path to the SSL key file>
             cert: <absolute path to the SSL cert file>
             passphrase: admin123 #option added in v2.2.2
             rejectUnauthorized: true #option added in v2.2.2
  3. Edge Microgateway を再起動します。編集した構成ファイル(デフォルト ファイルまたはランタイム構成ファイル)に応じて、構成の変更に記載されている手順に沿って操作します。

以下に、SSL が構成された構成ファイルの edgemicro セクションの例を示します。

edgemicro:
  port: 8000
  max_connections: 1000
  max_connections_hard: 5000
  logging:
    level: error
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24
  plugins:
    sequence:
      - oauth
  ssl:
    key: /MyHome/SSL/em-ssl-keys/server.key
    cert: /MyHome/SSL/em-ssl-keys/server.crt
    passphrase: admin123 #option added in v2.2.2
    rejectUnauthorized: true #option added in v2.2.2

サポートされているすべてのサーバー オプションの一覧は次のとおりです。

オプション 説明
key ca.key ファイル(PEM 形式)のパス。
cert ca.cert ファイル(PEM 形式)のパス。
pfx クライアントの秘密鍵、証明書、CA 証明書を含む pfx ファイルのパス(PFX 形式)。
passphrase 秘密鍵または PFX のパスフレーズを含む文字列。
ca 信頼できる証明書のリストを含む PEM 形式のファイルへのパス。
ciphers 使用する暗号を「:」で区切って記述した文字列。
rejectUnauthorized true の場合、サーバー証明書は、指定された CA のリストと照合して検証されます。検証で不合格だった場合は、エラーが返されます。
secureProtocol 使用する SSL メソッド。たとえば、SSLv3_method を使用して SSL をバージョン 3 に強制します。
servername SNI(Server Name Indication)TLS 拡張機能のサーバー名。

クライアント SSL / TLS オプションの使用

ターゲット エンドポイントに接続するときに、Edge Microgateway を TLS または SSL クライアントとして構成できます。Microgateway 構成ファイルで、targets 要素を使用して SSL / TLS オプションを設定します。

この例では、すべてのホストに適用される設定を指定しています。

targets:
   ssl:
     client:
       key: /Users/jdoe/nodecellar/twowayssl/ssl/client.key
       cert: /Users/jdoe/nodecellar/twowayssl/ssl/ca.crt
       passphrase: admin123
       rejectUnauthorized: true

この例では、設定は指定されたホストにのみ適用されます。

targets:
   host: 'myserver.example.com'
   ssl:
     client:
       key: /Users/myname/twowayssl/ssl/client.key
       cert: /Users/myname/twowayssl/ssl/ca.crt
       passphrase: admin123
       rejectUnauthorized: true

TLS の例を次に示します。

targets:
   host: 'myserver.example.com'
   tls:
     client:
       pfx: /Users/myname/twowayssl/ssl/client.pfx
       passphrase: admin123
       rejectUnauthorized: true

サポートされているすべてのクライアント オプションの一覧は次のとおりです。

オプション 説明
pfx クライアントの秘密鍵、証明書、CA 証明書を含む pfx ファイルのパス(PFX 形式)。
key ca.key ファイル(PEM 形式)のパス。
passphrase 秘密鍵または PFX のパスフレーズを含む文字列。
cert ca.cert ファイル(PEM 形式)のパス。
ca 信頼できる証明書のリストを含む PEM 形式のファイルへのパス。
ciphers 使用する暗号を「:」で区切って記述した文字列。
rejectUnauthorized true の場合、サーバー証明書は、指定された CA のリストと照合して検証されます。検証で不合格だった場合は、エラーが返されます。
secureProtocol 使用する SSL メソッド。たとえば、SSLv3_method を使用して SSL をバージョン 3 に強制します。
servername SNI(Server Name Indication)TLS 拡張機能のサーバー名。

カスタム認証サービスの使用

デフォルトでは、Edge Microgateway は、OAuth2 認証に Apigee Edge にデプロイされたプロキシを使用します。このプロキシは、最初に edgemicro configure を実行したときにデプロイされます。デフォルトでは、このプロキシの URL は Edge Microgateway 構成ファイルで次のように指定されています。

authUri: https://myorg-myenv.apigee.net/edgemicro-auth

独自のカスタム サービスを使用して認証を処理する場合は、構成ファイルの authUri 値を、サービスを指すように変更します。たとえば、LDAP を使用して ID を検証するサービスを使用できます。

ログファイルの管理

Edge Microgateway は、各リクエストとレスポンスに関する情報をログに記録します。ログファイルは、デバッグとトラブルシューティングに役立つ情報を提供します。

ログファイルの保存場所

デフォルトでは、ログファイルは /var/tmp に保存されます。

デフォルトのログファイル ディレクトリを変更する方法

ログファイルが保存されるディレクトリは、Edge Microgateway 構成ファイルで指定されます。構成の変更について詳しくは、構成の変更をご覧ください。

edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24

dir の値を変更して、別のログファイル ディレクトリを指定します。

コンソールにログを送信する

ログ情報がログファイルではなく標準出力に送信されるようにロギングを構成できます。次のように to_console フラグを true に設定します。

edgemicro:
  logging:
    to_console: true  

この設定により、ログは標準出力に送信されます。現在、ログを stdout とログファイルの両方に送信することはできません。

ロギングレベルを設定する方法

設定できるログレベルは、info、warn、error です。情報レベルをおすすめします。すべての API リクエストとレスポンスをログに記録します。これがデフォルトです。

ログの間隔を変更する方法

これらの間隔は、Edge Microgateway 構成ファイルで構成できます。構成の変更について詳しくは、構成の変更をご覧ください。

構成可能な属性は次のとおりです。

  • stats_log_interval:(デフォルト: 60)統計情報レコードが API ログファイルに書き込まれる間隔(秒単位)。
  • rotate_interval:(デフォルト: 24)ログファイルがローテーションされる間隔(時間単位)。次に例を示します。
edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24

注: アーカイブされたログファイルは圧縮されません。間隔が開始されると、新しいタイムスタンプを含む新しいログファイルが作成されます。

ログファイルの適切なメンテナンス方法

ログファイル データは時間の経過とともに蓄積されるため、Apigee では次の方法を採用することをおすすめします。

  • ログファイルは非常に大きくなる可能性があるため、ログファイル ディレクトリに十分な空き容量があることを確認してください。ログファイルの保存場所とデフォルトのログファイル ディレクトリを変更する方法のセクションをご覧ください。
  • 少なくとも週に 1 回、ログファイルを削除するか、別のアーカイブ ディレクトリに移動します。
  • ログを削除するポリシーがある場合は、CLI コマンド edgemicro log -c を使用して古いログを削除(クリーンアップ)できます。

ログファイルの命名規則

各 Edge Microgateway インスタンスは、次の 3 種類のログファイルを生成します。

  • api - Edge Microgateway を介して送受信されるすべてのリクエストとレスポンスをロギングします。API カウンタ(統計情報)とエラーもこのファイルに記録されます。
  • err - stderr に送信されたすべてのものをログに記録します。
  • out - stdout に送信されたすべてのものをログに記録します。

命名規則は次のとおりです。

edgemicro-<Host Name>-<Instance ID>-<Log Type>.log

次に例を示します。

edgemicro-mymachine-local-MTQzNTgNDMxODAyMQ-api.log
edgemicro-mymachine-local-MTQzNTg1NDMODAyMQ-err.log
edgemicro-mymachine-local-mtqzntgndmxodaymq-out.log

ログファイルの内容について

追加: v2.3.3

デフォルトでは、ロギング サービスはダウンロードされたプロキシ、プロダクト、JSON Web Token(JWT)の JSON を省略します。これらのオブジェクトをログファイルに出力する場合は、Edge Microgateway の起動時に DEBUG=* を設定します。次に例を示します。

DEBUG=* edgemicro start -o docs -e test -k abc123 -s xyz456

「api」ログファイルの内容

「api」ログファイルには、Edge Microgateway を通過するリクエストとレスポンスのフローに関する詳細情報が含まれています。「api」ログファイルの名前は次のようになります。

edgemicro-mymachine-local-MTQzNjIxOTk0NzY0Nw-api.log

Edge Microgateway に対して行われたリクエストごとに、4 つのイベントが「api」ログファイルにキャプチャされます。

  • クライアントからの受信リクエスト
  • ターゲットに対して行われた送信リクエスト
  • ターゲットからの受信レスポンス
  • クライアントへの送信レスポンス

これらの各エントリは、ログファイルをよりコンパクトにするために、短縮表記で表されます。以下に、4 つのイベントをそれぞれ表す 4 つのエントリの例を示します。ログファイルでは、次のように表示されます(行番号はドキュメント内での参照用であり、ログファイルには表示されません)。

(1) 1436403888651 info req m=GET, u=/, h=localhost:8000, r=::1:59715, i=0
(2) 1436403888665 info treq m=GET, u=/, h=127.0.0.18080, i=0
(3) 1436403888672 info tres s=200, d=7, i=0
(4) 1436403888676 info res s=200, d=11, i=0

1 つずつ見ていきましょう。

1. クライアントからの受信リクエストの例:

1436403888651 info req m=GET, u=/, h=localhost:8000, r=::1:59715, i=0
  • 1436403888651 - Unix タイムスタンプ
  • info - コンテキストによって異なります。ログレベルに応じて、info、warn、error のいずれかになります。統計情報レコードの場合は stats、警告の場合は warn、エラーの場合は error を指定できます。
  • req - イベントを識別します。この場合は、クライアントからリクエストします。
  • m - リクエストで使用される HTTP 動詞。
  • u - ベースパスに続く URL の部分。
  • h - Edge Microgateway がリッスンしているホストとポート番号。
  • r - クライアント リクエストの送信元のリモートホストとポート。
  • i - リクエスト ID。4 つのイベント エントリすべてでこの ID が共有されます。各リクエストには一意のリクエスト ID が割り当てられます。リクエスト ID でログレコードを関連付けることで、ターゲットのレイテンシに関する貴重な分析情報を得ることができます。
  • d - Edge Microgateway がリクエストを受信してからの経過時間(ミリ秒)。上記の例では、リクエスト 0 に対するターゲットのレスポンスが 7 ミリ秒後に受信され(3 行目)、さらに 4 ミリ秒後にレスポンスがクライアントに送信されています(4 行目)。つまり、リクエストの合計レイテンシは 11 ミリ秒で、そのうち 7 ミリ秒がターゲット、4 ミリ秒が Edge Microgateway 自体によって消費されています。

2. ターゲットに対して行われた送信リクエストの例:

1436403888665 info treq m=GET, u=/, h=127.0.0.1:8080, i=0
  • 1436403888651 - Unix タイムスタンプ
  • info - コンテキストによって異なります。ログレベルに応じて、info、warn、error のいずれかになります。統計情報レコードの場合は stats、警告の場合は warn、エラーの場合は error を指定できます。
  • treq - イベントを識別します。この場合は、ターゲット リクエストです。
  • m - ターゲット リクエストで使用される HTTP 動詞。
  • u - ベースパスに続く URL の部分。
  • h - バックエンド ターゲットのホストとポート番号。
  • i - ログエントリの ID。4 つのイベント エントリすべてがこの ID を共有します。

3. ターゲットからの受信レスポンスのサンプル

1436403888672 info tres s=200, d=7, i=0

1436403888651 - Unix タイムスタンプ

  • info - コンテキストによって異なります。ログレベルに応じて、info、warn、error のいずれかになります。統計情報レコードの場合は stats、警告の場合は warn、エラーの場合は error を指定できます。
  • tres - イベントを識別します。この場合は、ターゲット レスポンスです。
  • s - HTTP レスポンス ステータス。
  • d - 再生時間(ミリ秒)。ターゲットによる API 呼び出しに要した時間。
  • i - ログエントリの ID。4 つのイベント エントリすべてがこの ID を共有します。

4. クライアントへの送信レスポンスの例

1436403888676 info res s=200, d=11, i=0

1436403888651 - Unix タイムスタンプ

  • info - コンテキストによって異なります。ログレベルに応じて、info、warn、error のいずれかになります。統計情報レコードの場合は stats、警告の場合は warn、エラーの場合は error を指定できます。
  • res - イベントを識別します。この場合は、クライアントにレスポンスを返します。
  • s - HTTP レスポンス ステータス。
  • d - 期間(ミリ秒)。これは、ターゲット API の所要時間と Edge Microgateway 自体の所要時間を含む、API 呼び出しの合計所要時間です。
  • i - ログエントリの ID。4 つのイベント エントリすべてがこの ID を共有します。

ログファイルのスケジュール

ログファイルは、rotate_interval 構成属性で指定された間隔でローテーションされます。ローテーション間隔が終了するまで、エントリは同じログファイルに追加され続けます。ただし、Edge Microgateway が再起動されるたびに新しい UID が割り当てられ、この UID を持つ新しいログファイルが作成されます。ログファイルの適切なメンテナンス方法もご覧ください。

Edge Microgateway 構成リファレンス

構成ファイルの場所

このセクションで説明する構成属性は、Edge Microgateway 構成ファイルにあります。構成の変更について詳しくは、構成の変更をご覧ください。

edge_config 属性

これらの設定は、Edge Microgateway インスタンスと Apigee Edge 間のやり取りを構成するために使用されます。

  • bootstrap:(デフォルト: なし)Apigee Edge で実行されている Edge Microgateway 固有のサービスを指す URL。Edge Microgateway は、このサービスを使用して Apigee Edge と通信します。この URL は、公開鍵 / 秘密鍵のペアを生成するコマンド edgemicro genkeys を実行すると返されます。詳細については、Edge Microgateway の設定と構成をご覧ください。
  • jwt_public_key:(デフォルト: なし)Apigee Edge にデプロイされている Edge Microgateway プロキシを指す URL。このプロキシは、署名付きアクセス トークンをクライアントに発行するための認証エンドポイントとして機能します。この URL は、プロキシをデプロイするコマンド edgemicro configure を実行すると返されます。詳細については、Edge Microgateway の設定と構成をご覧ください。

edgemicro 属性

これらの設定は、Edge Microgateway プロセスを構成します。

  • port:(デフォルト: 8000)Edge Microgateway プロセスがリッスンするポート番号。
  • max_connections:(デフォルト: -1)Edge Microgateway が受信できる同時受信接続の最大数を指定します。この数を超えると、次のステータスが返されます。

    res.statusCode = 429; // Too many requests
  • max_connections_hard: (デフォルト: -1)Edge Microgateway が接続をシャットダウンする前に受信できる同時リクエストの最大数。この設定は、サービス拒否攻撃を阻止することを目的としています。通常は、max_connections よりも大きい数値を設定します。
  • logging:
    • level:(デフォルト: error)
      • info - Edge Microgateway インスタンスを通過するすべてのリクエストとレスポンスをログに記録します。
      • warn - 警告メッセージのみをログに記録します。
      • error - エラー メッセージのみをログに記録します。
    • dir:(デフォルト: /var/tmp)ログファイルが保存されるディレクトリ。
    • stats_log_interval:(デフォルト: 60)統計レコードが API ログファイルに書き込まれる間隔(秒単位)。
    • rotate_interval:(デフォルト: 24)ログファイルがローテーションされる間隔(時間単位)。
  • dir: ./gateway ディレクトリから ./plugins ディレクトリへの相対パス、または絶対パス。
  • sequence: Edge Microgateway インスタンスに追加するプラグイン モジュールのリスト。モジュールは、ここで指定された順序で実行されます。
  • debug: Edge Microgateway プロセスにリモート デバッグを追加します。
    • port: リッスンするポート番号。たとえば、このポートでリッスンするように IDE デバッガを設定します。
    • args: デバッグ プロセスの引数。例: args --nolazy
  • config_change_poll_interval:(デフォルト: 600 秒)Edge Microgateway は、定期的に新しい構成を読み込み、変更があった場合は再読み込みを実行します。ポーリングでは、Edge で行われた変更(プロダクト、Microgateway 対応プロキシなどへの変更)と、ローカル構成ファイルに加えられた変更が取得されます。
  • disable_config_poll_interval:(デフォルト: false)自動変更ポーリングをオフにするには、true に設定します。

headers 属性

これらの設定は、特定の HTTP ヘッダーの処理方法を構成します。

  • x-forwarded-for:(デフォルト: true)x-forwarded-for ヘッダーがターゲットに渡されないようにするには、false に設定します。
  • x-forwarded-host:(デフォルト: true)x-forwarded-host ヘッダーがターゲットに渡されないようにするには、false に設定します。
  • x-request-id:(デフォルト: true)x-request-id ヘッダーがターゲットに渡されないようにするには、false に設定します。
  • x-response-time:(デフォルト: true)x-response-time ヘッダーがターゲットに渡されないようにするには、false に設定します。
  • via:(デフォルト: true)via ヘッダーがターゲットに渡されないようにするには、false に設定します。

oauth 属性

これらの設定は、Edge Microgateway によるクライアント認証の適用方法を構成します。

  • allowNoAuthorization:(デフォルト: false)true に設定すると、API 呼び出しは Authorization ヘッダーなしで Edge Microgateway を通過できます。Authorization ヘッダーを必須にするには、false に設定します(デフォルト)。
  • allowInvalidAuthorization:(デフォルト: false)true に設定すると、Authorization ヘッダーで渡されたトークンが無効または期限切れの場合に、API 呼び出しが許可されます。有効なトークンを要求するには、false に設定します(デフォルト)。
  • authorization-header:(デフォルト: Authorization: Bearer)アクセス トークンを Edge Microgateway に送信するために使用されるヘッダー。ターゲットが他の目的で Authorization ヘッダーを使用する必要がある場合は、デフォルトを変更することをおすすめします。
  • api-key-header:(デフォルト: x-api-key)API キーを Edge Microgateway に渡すために使用されるヘッダーまたはクエリ パラメータの名前。API キーの使用もご覧ください。
  • keepAuthHeader:(デフォルト: false)true に設定すると、リクエストで送信された Authorization ヘッダーがターゲットに渡されます(保持されます)。

プラグイン固有の属性

各プラグインの構成可能な属性の詳細については、プラグインの使用をご覧ください。

プロキシのフィルタリング

Edge Microgateway インスタンスが処理する Microgateway 対応プロキシをフィルタできます。Edge Microgateway は、起動時に、関連付けられている組織内の Microgateway 対応プロキシをすべてダウンロードします。次の構成を使用して、microgateway が処理するプロキシを制限します。たとえば、次の構成では、Microgateway が処理するプロキシを edgemicro_proxy-1、edgemicro_proxy-2、edgemicro_proxy-3 の 3 つに制限しています。

proxies:
  - edgemicro_proxy-1
  - edgemicro_proxy-2
  - edgemicro_proxy-3

分析データのマスキング

次の構成では、リクエストパス情報が Edge 分析に表示されなくなります。リクエスト URI やリクエストパスをマスクするには、Microgateway 構成に以下を追加します。URI は、リクエストのホスト名とパスの部分で構成されます。

analytics:
  mask_request_uri: 'string_to_mask'
  mask_request_path: 'string_to_mask'

デバッグとトラブルシューティング

デバッガへの接続

Edge Microgateway は、node-inspector などのデバッガで実行できます。これは、カスタム プラグインのトラブルシューティングとデバッグに役立ちます。

  1. デバッグモードで Edge Microgateway を再起動します。これを行うには、start コマンドの先頭に DEBUG=* を追加します。次に例を示します。

    DEBUG=* edgemicro start -o myorg -e test -k db4e9e8a95aa7fabfdeacbb1169d0a8cbe42bec19c6b98129e02 -s 6e56af7c1b26dfe93dae78a735c8afc9796b077d105ae5618ce7ed
  2. デバッガを起動し、デバッグ プロセスのポート番号をリッスンするように設定します。
  3. Edge Microgateway コードのステップ実行、ブレークポイントの設定、式の監視などを行うことができます。

デバッグモードに関連する標準の Node.js フラグを指定できます。たとえば、--nolazy は非同期コードのデバッグに役立ちます。

ログファイルの確認

問題が発生した場合は、ログファイルで実行の詳細とエラー情報を確認してください。詳細については、ログファイルの管理をご覧ください。

API キー セキュリティの使用

API キーは、Edge Microgateway にリクエストを送信するクライアントを認証するためのシンプルなメカニズムを提供します。API キーを取得するには、Edge Microgateway 認証プロキシを含む Apigee Edge プロダクトからコンシューマ キー(クライアント ID とも呼ばれます)の値をコピーします。

鍵のキャッシュ

API キーは署名なしトークンと交換され、キャッシュに保存されます。キャッシュを無効にするには、Edge Microgateway への受信リクエストに Cache-Control: no-cache ヘッダーを設定します。

Apigee Edge プライベート クラウド バージョン 15.07 を使用している場合に必要な回避策

Edge Private Cloud 15.07 で API キー セキュリティを使用するには、ここで説明する回避策を実装する必要があります。この回避策では、edgemicro-auth プロキシの Node.js ファイルの 1 行を変更し、Edge Microgateway を再起動する必要があります。

Edge UI で回避策を実装する

この手順では、完了時に edgemicro start コマンドを再実行する必要があります。

  1. Edge UI で、プロキシ エディタで edgemicro-auth プロキシを開きます。
  2. [Develop] タブを選択します。
  3. [Navigator] の [Scripts] で、verify-api-key.js という JavaScript ファイルを開きます。
  4. 109 行目に移動します。

    api_product_list: apigeeToken.app && apigeeToken.app.apiproducts ? apigeeToken.app.apiproducts : []
  5. 「api_product_list:」の後の部分を、使用する API キーに関連付けられているプロダクト名の「ハードコードされた」配列に置き換えます。たとえば、「Product-1」と「Product-2」を含むデベロッパー アプリのキーを使用する場合は、次のようにコードを記述します。

    api_product_list: ["Product-1", "Product-2"]
  6. [保存] をクリックします。
  7. edgemicro start コマンドを実行します。

ローカルの Edge Microgateway コードベースに実装する

この手順では、edgemicro の configure コマンドを再実行してから、edgemicro start を実行する必要があります。

  1. ファイル <microgateway-root-dir>/edge/auth/api/controllers/verify-api-key.js を開きます。ここで、<microgateway-root-dir> は、npm install コマンドを実行したときに Edge Microgateway がインストールされたディレクトリです。
  2. 109 行目に移動します。

    api_product_list: apigeeToken.app && apigeeToken.app.apiproducts ? apigeeToken.app.apiproducts : []
  3. 「api_product_list:」の後の部分を、使用する API キーに関連付けられているプロダクト名の「ハードコードされた」配列に置き換えます。たとえば、「Product-1」と「Product-2」を含むデベロッパー アプリのキーを使用する場合は、次のようにコードを記述します。

    api_product_list: ["Product-1", "Product-2"]
  4. ファイルを保存します。
  5. edgemicro configure コマンドを実行します。(Edge Private Cloud を使用している場合は edgemicro private configure)。このコマンドは、edgemicro-auth プロキシを再デプロイします。
  6. edgemicro start コマンドを実行します。

OAuth2 トークン セキュリティの使用

プロキシ リクエストで OAuth トークンを使用する方法については、Edge Microgateway を保護するをご覧ください。

API キーの使用

プロキシ リクエストで API キーを使用する方法については、Edge Microgateway を保護するをご覧ください。

API キー名の構成

デフォルトでは、x-api-key は API キーヘッダーまたはクエリ パラメータに使用される名前です。このデフォルトは、構成の変更で説明されているように、構成ファイルで変更できます。 たとえば、名前を apiKey に変更するには、次のようにします。

oauth:
 allowNoAuthorization: false
 allowInvalidAuthorization: false
 api-key-header: apiKey