Activity Log (activity-log)
Activity Log ポリシーを使用して、分析に保管されている API アクティビティー用にロギングの設定を構成します。ユーザーが指定する設定は、API アクティビティーの詳細の収集および保管に関するデフォルトの設定値をオーバーライドします。
制約事項: Activity
Log ポリシーは、DataPower® Gateway にのみ使用できます。
注: Micro Gateway は Activity
Log ポリシーをサポートしません。ただし、Micro Gateway は基本的な分析統計を収集します。Micro Gateway が収集する統計は、以下の一部の例外を除いて、Content:activity が設定された DataPower Gateway の Activity
Log ポリシーが収集するものに相当します。
- requestHttpHeaders、responseHttpHeaders、および debug の各フィールドについては、Micro Gateway は情報を収集せずに空のペイロードを送信します。
- 有効な管理サーバーを指定する APIMANAGER 環境変数を使用して Micro Gateway を開始すると、Micro Gateway は基本分析統計を自動的に収集します。実行時に収集機能をオンまたはオフにするメカニズムはありません。
概要
ゲートウェイ・サーバーでの API 実行イベントごとに 1 つの API イベント・レコードが存在します。デフォルトの場合に収集されて API イベント・レコードに格納されるコンテンツ・タイプは、API の実行が正常に完了した場合は activity、API の実行が完了したがエラー・コードが返された場合は payload です。コンテンツのタイプを変更してこれらの API イベント・レコードに記録させるには、Activity Log ポリシーをアセンブリーに適用します。API イベント・レコードについて詳しくは、『API イベント・レコードのフィールド』を参照してください。
このポリシーを以下の API フローに付加できます。
- REST
- SOAP
プロパティー
以下の表に、このポリシーのプロパティーをリストします。表には、プロパティーが必須かどうか、入力用の有効な値とデフォルト値、および値のデータ型が示されています。
プロパティー・ラベル | 必須 | 説明 | データ型 |
---|---|---|---|
タイトル | はい | ポリシーのタイトルは必須ですが、デフォルト値 activity-log が用意されています。 | ストリング |
説明 | いいえ | ポリシーの説明。 | ストリング |
内容 | はい | 操作が成功したときにログに記録される内容のタイプを定義します。 有効は値は以下のとおりです。
制約事項: フランクフルト・リージョンでホストされる Bluemix インスタンスのペイロードのロギング機能は無効化されています。このリージョンでは、Sensitive Personal Information (SPI) の保管に対する要件がさらに厳しいため、ペイロード情報は保存できません。
デフォルト値は、activity です。 |
ストリング |
エラー内容 (Error content) | いいえ | エラーが発生した場合にログに記録する内容を示します。 有効は値は以下のとおりです。
制約事項: フランクフルト・リージョンでホストされる Bluemix インスタンスのペイロードのロギング機能は無効化されています。このリージョンでは、SPI の保管に対する要件がさらに厳しいため、ペイロード情報は保存できません。
デフォルト値は、payload です。 |
ストリング |