仅 DataPower API Gateway

log

使用 log 策略来定制或覆盖 API 的缺省活动日志记录配置。

网关支持

表 1. 显示哪些网关支持此策略以及对应策略版本的表格
网关 策略版本
DataPower® API Gateway 2.0.0

2.1.0 (DataPower API Gateway V 10.0.3.0 或更高版本)

本主题介绍了如何在 OpenAPI 源中配置策略;有关如何在Assembly用户界面中配置策略的详细信息,请参阅 “日志 ”。

关于

log 策略具有以下格式:
- log:
  version: version
  title: title
  description: description
  mode: activity_logging_actions
  log-level: type_of_content_to_log

属性

下表描述 log 策略的属性:
表 2. 日志策略属性
属性 必需 描述 数据类型
version 策略版本号 字符串
title False 策略的标题。 字符串
description False 策略的描述。 字符串
mode 请指定下列其中一个值:
  • gather-only:收集所有分析数据并将其写入 log 上下文变量,这会在 API 执行完成时填充 API 事件记录。 有关 log 上下文变量中的字段以及相应的 API 事件记录的更多信息,请参阅 API 事件记录字段参考
  • send-only:执行以下操作:
    • log 上下文变量读取数据。
    • 截断所有消息有效内容并转换为文本表示。
    • 将数据发送到分析服务器。
  • gather-and-send:执行 gather-only 操作,后跟 send-only 操作。

如果使用 仅发送收集并发送 选项,那么将根据为 DataPower API Gateway上的分析端点配置的时间间隔来缓冲数据并将其批量发送到分析服务器。 如需了解更多信息,请参阅 DataPower 知识中心中的 “配置分析端点 ”。

注: 如果要卸载到第三方分析服务器,那么可以编辑事件数据的任何方面。 如果您正在使用 API Connect 分析工具,则只能对请求和响应的有效载荷进行屏蔽处理。
字符串
log-level False 要记录的内容类型。 请指定下列其中一个值:
  • none: 指示无日志记录。
  • activity; 仅记录调用 (仅为资源 URI)。
  • header:记录活动和标题。
  • payload: 记录活动,标题和有效内容。
  • default; 使用 API 定义中指定的日志级别;有关详细信息,请参阅 activity-log。 这是缺省值。
  • $(value): 格式为 $(value) 的内联参数,用于从 API 上下文中检索值。
字符串

示例

- log:
  version: 2.0.0
  title: Gather activity log data for processing
  mode: gather-only