activity-log

オンラインで編集する

「アクティビティログ」ポリシーを使用して、 IBM® API Connect の分析機能に保存されるAPIアクティビティのログ記録設定を構成します。ユーザーが指定する設定は、API アクティビティーの詳細の収集および保管に関するデフォルトの設定値をオーバーライドします。

ゲートウェイのサポート

表 1. このポリシーをサポートするゲートウェイと、対応するポリシーバージョンを示す表
ゲートウェイ	ポリシーのバージョン
DataPower® Gateway (v5 compatible)	1.0.0

このトピックでは、 OpenAPI ソースでポリシーを設定する方法について説明します。アセンブリのユーザーインターフェースでポリシーを設定する方法の詳細については、「アクティビティログ」を参照してください。

注：を使用 DataPower API Gatewayしている場合は、 activity-log 拡張機能を使用してログ設定を行います。

製品情報

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

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

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

API Designer アセンブリー・エディターを使用して activity-log ポリシーを適用し、組み込みポリシーを API に追加することもできます。詳細については、「組み込みポリシー」セクションの「アクティビティログ」を参照してください。

注: payload ロギングが有効になっている場合は、ペイロード・バッファリングをキャプチャーするゲートウェイも有効にする必要があります。

activity-log:
  success-content: activity_to_log_if_call_successful
  error-content: activity_to_log_if_call_unsuccessful
  enabled: is_activity_logging_enabled
buffering: true

プロパティ－

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

表 2. アクティビティログのポリシープロパティ
プロパティー	必須	説明	データ・タイプ
version	はい	ポリシーのバージョン番号	ストリング
title	はい	ポリシーのタイトル。	ストリング
description	いいえ	ポリシーの説明。	ストリング
content	はい	操作が成功したときにログに記録される内容のタイプを定義します。有効値: `none`: ロギングが行われないことを示します。制限事項：このオプションを有効にすると、貴社のコンシューマーカタログを利用するアプリ開発者への通知が無効になります。 `activity`: 呼び出しだけがログに記録されます (リソース URI のみ記録されます)。 `header`: アクティビティーとヘッダーがログに記録されます。 `payload`: アクティビティー、ヘッダー、およびペイロード (元の要求 (存在する場合) と最終応答) がログに記録されます。デフォルト値は `activity`です。	ストリング
error-content	いいえ	エラーが発生した場合にログに記録する内容を示します。有効値: `none`: ロギングが行われないことを示します。制限事項：このオプションを有効にすると、貴社のコンシューマーカタログを利用するアプリ開発者への通知が無効になります。 `activity`: 呼び出しだけがログに記録されます (リソース URI のみ記録されます)。 `header`: アクティビティーとヘッダーがログに記録されます。 `payload`: アクティビティー、ヘッダー、およびペイロード (元の要求 (存在する場合) と最終応答) がログに記録されます。デフォルト値は `payload`です。	ストリング

例 1

# use defaults

- activity-log:
  version: 1.0.0
  title: default activity logging

例 2

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