配置 Redis 输出

注意

supported deployment methods

Fleet 管理的 APM Server 尚不支持 Redis 输出。

Redis 输出将事件插入到 Redis 列表或 Redis 频道中。此输出插件与 Logstash 的 Redis 输入插件兼容。

要使用此输出，请编辑 APM Server 配置文件，注释掉 Elasticsearch 输出以将其禁用，并添加 output.redis 以启用 Redis 输出。

配置示例

		output.redis:
  hosts: ["localhost"]
  password: "my_password"
  key: "apm-server"
  db: 0
  timeout: 5
		
	

兼容性

此输出预计适用于 3.2.4 到 5.0.8 之间的所有 Redis 版本。其他版本可能也能正常工作，但不受官方支持。

配置选项

您可以在 apm-server.yml 配置文件中指定以下 output.redis 选项

`enabled`

enabled 配置是一个布尔设置，用于启用或禁用输出。如果设置为 false，则禁用输出。

默认值为 true。

要连接的 Redis 服务器列表。如果启用了负载均衡，事件将分发到列表中的服务器。如果某台服务器无法访问，事件将仅分发到可访问的服务器。您可以通过指定 HOST 或 HOST:PORT 来定义每个 Redis 服务器。例如："192.15.3.2" 或 "test.redis.io:12345"。如果您未指定端口号，则使用由 port 配置的值。可以使用 IP:PORT 对或 URL 配置每个 Redis 服务器。例如：redis://:6379 或 rediss://:6379。URL 可以包含服务器特定的密码。例如：redis://:password@localhost:6379。redis 方案将禁用该主机的 ssl 设置，而 rediss 将强制使用 TLS。如果指定了 rediss 且未配置任何 ssl 设置，则输出将使用系统的证书存储。

`index`

添加到事件元数据中供 Logstash 使用的索引名称。默认值为 "apm-server"。

`key`

发布事件的 Redis 列表或频道的名称。如果未配置，则使用 index 设置的值。

您可以使用格式字符串访问任何事件字段来动态设置键。例如，此配置使用自定义字段 fields.list 来设置 Redis 列表键。如果缺少 fields.list，则使用 fallback

		output.redis:
  hosts: ["localhost"]
  key: "%{[fields.list]:fallback}"
		
	

有关动态设置键的其他方法，请参阅 keys 设置。

`keys`

键选择器规则数组。每条规则指定用于匹配该规则的事件的 key。在发布期间，APM Server 会使用数组中的第一条匹配规则。规则可以包含条件、基于格式字符串的字段和名称映射。如果缺少 keys 设置或者没有规则匹配，则会使用 key 设置。

规则设置

index: 要使用的键格式字符串。如果此字符串包含字段引用（例如 %{[fields.name]}），则该字段必须存在，否则规则会失败。
mappings: 一个字典，获取由 key 返回的值并将其映射到新名称。
default: 如果 mappings 未找到匹配项而要使用的默认字符串值。
when: 为执行当前规则必须满足的条件。

示例 keys 设置

		output.redis:
  hosts: ["localhost"]
  key: "default_list"
  keys:
    - key: "info_list"
      when.contains:
        message: "INFO"
    - key: "debug_list"
      when.contains:
        message: "DEBUG"
    - key: "%{[fields.list]}"
      mappings:
        http: "frontend_list"
        nginx: "frontend_list"
        mysql: "backend_list"
		
	

如果 message 字段包含 INFO，则发送到 info_list
如果 message 字段包含 DEBUG，则发送到 debug_list

`password`

用于身份验证的密码。默认不进行身份验证。

`db`

发布事件的 Redis 数据库编号。默认值为 0。

`datatype`

用于发布事件的 Redis 数据类型。如果数据类型为 list，则使用 Redis RPUSH 命令，并且所有事件都将添加到键定义在 key 下的列表中。如果使用数据类型 channel，则使用 Redis PUBLISH 命令，这意味着所有事件都被推送到 Redis 的发布/订阅（pub/sub）机制中。频道的名称是在 key 下定义的名称。默认值为 list。