活动日志政策

在线编辑

配置活动日志策略以管理 API 事件中存储的数据的详细级别。

在 API Manager UI 中配置 API 时，您可以选择将哪些数据存储在 API 事件记录中，以便使用 activity log 属性调用该 API。 对于成功的 API 调用和失败的 API 调用， activity log 属性具有单独的设置。 活动日志选项包括:
  • 无 – 不记录 API 事件。
  • activity - 记录 API 资源 URI。 activity 是成功 API 调用的缺省日志设置。
  • header - 记录 API 资源 URI 和 HTTP 标头。
  • 有效负载 - 记录 API 资源 URI、 HTTP 标头以及请求和响应有效负载。 payload 是失败的 API 调用的缺省日志设置，因为响应有效内容可能具有有关失败原因的有用信息。
注：

如果您的网关配置为使用 OAuth 提供程序对所有API调用进行身份验证，则与 OAuth 调用相关的数据仅在 OAuth 调用失败时才会包含在API事件数据中。 OAuth 的成功认证不会记录在API事件数据中。

重要： API 事件记录的最大大小为 19 Mb。 分析子系统拒绝任何大于 19 Mb 的 API 事件记录。

在 API Manager UI 中定义日志设置

  1. 在 API Manager UI 开发 视图中，选择要使用的 API。 如果您不熟悉 API Manager 的 “开发”视图，请参阅《 使用 API 定义 》。
  2. 选择 网关 选项卡，展开 网关和门户网站设置，然后选择 活动日志。
  3. 选择 已启用，然后选择 成功内容 和 错误内容的首选日志设置:
    • 无 – 不记录 API 事件。
    • activity - 记录 API 资源 URI。 activity 是成功 API 调用的缺省日志设置。
    • header - 记录 API 资源 URI 和 HTTP 标头。
    • 有效负载 - 记录 API 资源 URI、 HTTP 标头以及请求和响应有效负载。 payload 是失败的 API 调用的缺省日志设置，因为响应有效内容可能具有有关失败原因的有用信息。
  4. 单击 " 保存 " 保存更改。

在 DataPower® API Gateway 的源中定义日志设置

使用 activity-log 扩展来配置日志记录首选项。

activity-log:
  success-content: <success log setting: none, activity, header, payload>
  error-content: <failure log setting: none, activity, header, payload>
  enabled: <if activity logging is enabled: true or false>
注: 如果启用了 有效内容 日志记录，那么还必须启用网关以捕获有效内容缓冲。
activity-log:
  success-content: <success log setting: none, activity, header, payload>
  error-content: <failure log setting: none, activity, header, payload>
  enabled: <if activity logging is enabled: true or false>
buffering: true
示例
没有成功调用的日志记录，失败调用的头日志记录
activity-log:
    success-content: none
    error-content: header
    enabled: true
禁用活动日志记录
activity-log:
    enabled: false