activity-log

Activity Log ポリシーを使用して、分析に保管されている API アクティビティー用にロギングの設定を構成します。ユーザーが指定する設定は、API アクティビティーの詳細の収集および保管に関するデフォルトの設定値をオーバーライドします。

activity-log ポリシーの形式は次のとおりです。

- activity-log:
  title: title
  description: description
  content: activity_to_log_if_call_successful
  error-content: activity_to_log_if_call_unsuccessful

このポリシーを適用するには、execute フィールドを指定した assembly 拡張を OpenAPI (Swagger 2.0) 定義ファイルに追加します。

API Designer アセンブリー・エディターを使用して、組み込みポリシーを API に追加することで、activity-log ポリシーを適用することもできます。詳しくは、『組み込みポリシー』セクションの Activity Log (activity-log) を参照してください。

この例での activity-log の出力については、../com.ibm.apic.apionprem.doc/rapim_analytics_apieventrecordfields.htmlを参照してください。

以下の表に、このポリシーのプロパティーを示します。

表 1. Activity Log ポリシーのプロパティー
プロパティー・ラベル	必須	説明	データ型
タイトル	はい	ポリシーのタイトルは必須ですが、デフォルト値 `activity-log` が用意されています。	ストリング
説明	いいえ	ポリシーの説明。	ストリング
内容	はい	操作が成功したときにログに記録される内容のタイプを定義します。有効は値は以下のとおりです。 `none`: ロギングが行われないことを示します。制約事項: このオプションにより、開発者ポータルを使用するアプリケーション開発者に対する通知が無効になります。 `activity`: 呼び出しだけがログに記録されます (リソース URI のみ記録されます)。 `header`: アクティビティーとヘッダーがログに記録されます。 `payload`: アクティビティー、ヘッダー、ペイロード (メッセージ本体) がログに記録されます。制約事項: フランクフルト・リージョンでホストされる Bluemix インスタンスのペイロードのロギング機能は無効化されています。このリージョンでは、Sensitive Personal Information (SPI) の保管に対する要件がさらに厳しいため、ペイロード情報は保存できません。デフォルト値は、`activity` です。	ストリング
エラー内容 (Error content)	いいえ	エラーが発生した場合にログに記録する内容を示します。有効は値は以下のとおりです。 `none`: ロギングが行われないことを示します。制約事項: このオプションにより、開発者ポータルを使用するアプリケーション開発者に対する通知が無効になります。 `activity`: 呼び出しだけがログに記録されます (リソース URI のみ記録されます)。 `header`: アクティビティーとヘッダーがログに記録されます。 `payload`: アクティビティー、ヘッダー、ペイロード (メッセージ本体) がログに記録されます。制約事項: フランクフルト・リージョンでホストされる Bluemix インスタンスのペイロードのロギング機能は無効化されています。このリージョンでは、SPI の保管に対する要件がさらに厳しいため、ペイロード情報は保存できません。デフォルト値は、`payload` です。	ストリング

例 1

# use defaults

- activity-log:
  title: default activity logging

例 2

- activity-log:
  title: no logging for successful calls
  content: none
  error-content: activity

最終更新: 2017 年 10 月 31 日