Elastic Agent 输入插件

Elastic Agent 输入插件

input-elastic_agent 插件是 input-beats 插件的下一代。它们目前共享代码和一个 通用代码库

  • 插件版本:v6.8.3
  • 发布日期:2024-04-23
  • 变更日志

对于其他版本,请参阅 版本化插件文档

获取帮助

如果您对插件有任何疑问,请在 Discuss 论坛中发帖。对于错误或功能请求,请在 Github 中提交问题。有关 Elastic 支持的插件列表,请参阅 Elastic 支持矩阵

描述

此输入插件允许 Logstash 从 Elastic Agent 框架接收事件。

以下示例展示了如何配置 Logstash 在端口 5044 上监听传入的 Elastic Agent 连接并将其索引到 Elasticsearch 中。

input {
  elastic_agent {
    port => 5044
  }
}

output {
  elasticsearch {
    hosts => ["https://127.0.0.1:9200"]
    data_stream => "true"
  }
}

使用此处显示的 Logstash 配置索引到 Elasticsearch 的事件将类似于 Elastic Agent 直接索引到 Elasticsearch 的事件。

内存使用

此插件除了堆内存外还使用“堆外”直接内存。默认情况下,JVM 的堆外直接内存限制与堆大小相同。例如,设置 -Xmx10G 而不设置直接内存限制将为堆分配 10GB,并为直接内存分配另外 10GB,总共分配 20GB。您可以在 Logstash JVM 设置 中使用 -XX:MaxDirectMemorySize 设置直接内存量。考虑将直接内存设置为堆大小的一半。将直接内存设置得太低会降低摄取性能。

确保堆和直接内存的总和不超过服务器上可用的总内存,以避免出现 OutOfDirectMemoryError。

事件丰富和 Elastic Common Schema (ECS)

在解码 Elastic Agent 事件时,此插件会使用有关事件源的元数据丰富每个事件,使此信息在进一步处理期间可用。您可以使用 enrich 选项激活或停用各个丰富类别。

这些丰富字段的位置取决于是否启用了 ECS 兼容模式

  • 当 ECS 兼容性启用时,丰富字段将以 ECS 兼容的结构添加。
  • 当 ECS 兼容性禁用时,丰富字段将以与该插件向后兼容的方式添加,但已知会与 Elastic Common Schema 冲突。

丰富类别:source_metadata

ECS `v1`、`v8` ECS `disabled` 描述

[@metadata][input][beats][host][name]

[host]

Elastic Agent 主机的名称或地址

[@metadata][input][beats][host][ip]

[@metadata][ip_address]

连接到此输入的 Elastic Agent 客户端的 IP 地址

丰富类别:ssl_peer_metadata

ECS `v1`、`v8` ECS `disabled` 描述

[@metadata][tls_peer][status]

[@metadata][tls_peer][status]

包含“已验证”或“未验证”标签;在启用 SSL 时可用。

[@metadata][input][beats][tls][version_protocol]

[@metadata][tls_peer][protocol]

包含使用的 TLS 版本(例如 TLSv1.2);在 SSL 状态为“已验证”时可用

[@metadata][input][beats][tls][client][subject]

[@metadata][tls_peer][subject]

包含远程端的身份名称(例如 CN=artifacts-no-kpi.elastic.co);在 SSL 状态为“已验证”时可用

[@metadata][input][beats][tls][cipher]

[@metadata][tls_peer][cipher_suite]

包含使用的密码套件的名称(例如 TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256);在 SSL 状态为“已验证”时可用

丰富类别:codec_metadata

ECS `v1`、`v8` ECS `disabled` 描述

[tag]

[tag]

包含 beats_input_codec_XXX_applied,其中 XXX 是编解码器的名称

[event][original]

N/A

当 ECS 启用时,即使 [event][original] 字段在正在处理的事件中不存在,此插件的 默认编解码器 也确保使用处理后的字节填充该字段。

Elastic Agent 输入配置选项

此插件支持以下配置选项,以及后面描述的 通用选项

设置 输入类型 必需

add_hostname

布尔值

已弃用

cipher_suites

数组

已弃用

client_inactivity_timeout

数字

ecs_compatibility

字符串

enrich

字符串

event_loop_threads

数字

executor_threads

数字

host

字符串

include_codec_tag

布尔值

已弃用

port

数字

ssl

布尔值

已弃用

ssl_certificate

有效的系统文件路径

ssl_certificate_authorities

数组

ssl_cipher_suites

数组

ssl_client_authentication

字符串,其中之一为 ["none", "optional", "required"]

ssl_enabled

布尔值

ssl_handshake_timeout

数字

ssl_key

有效的系统文件路径

ssl_key_passphrase

密码

ssl_peer_metadata

布尔值

已弃用

ssl_supported_protocols

数组

ssl_verify_mode

字符串,其中之一为 ["none", "peer", "force_peer"]

已弃用

tls_max_version

数字

已弃用

tls_min_version

数字

已弃用

另请参阅 通用选项,了解所有输入插件支持的选项列表。

 

add_hostname

在 6.0.0 中已弃用。

默认值已更改为 false。在 7.0.0 中,此设置将被删除

标志,用于确定是否使用 Elastic Agent 在 hostname 字段中提供的 value 将 host 字段添加到事件中。

cipher_suites

在 6.4.0 中已弃用。

已替换为 ssl_cipher_suites

要使用的密码套件列表,按优先级列出。

client_inactivity_timeout

  • 值类型为 数字
  • 默认值为 60

在 X 秒的空闲时间后关闭空闲客户端。

ecs_compatibility

  • 值类型为 字符串
  • 支持的值为

    • disabled:在根级别添加非结构化连接元数据
    • v1:在 ECS v1 兼容命名空间下添加结构化连接元数据
    • v8:在 ECS v8 兼容命名空间下添加结构化连接元数据
  • 默认值取决于运行的 Logstash 版本

    • 当 Logstash 提供 pipeline.ecs_compatibility 设置时,将使用其值作为默认值
    • 否则,默认值为 disabled

有关详细信息,请参阅 ECS 映射

enrich

  • 值类型为 字符串

    • 也可以提供 数组
    • 配置对每个事件应用的丰富内容
    • 默认值为 [codec_metadata, source_metadata],它可能会在该插件的未来版本中扩展以包括其他丰富内容。
    • 支持的值为

      丰富内容 描述

      codec_metadata

      有关编解码器如何将字节序列转换为此事件的信息,例如使用哪个编解码器。此外,如果未明确指定编解码器,则 enrich排除 codec_metadata 将为该插件禁用 ecs_compatibility

      source_metadata

      有关事件的信息,例如此输入接收事件的入站连接的 IP 地址

      ssl_peer_metadata

      有关我们接收事件的SSL 对等方的详细信息,例如在建立与该输入的连接时提供的 SSL 客户端证书中的身份信息

      all

      别名,用于包含所有可用的丰富内容(包括在该插件的未来版本中引入的其他丰富内容)

      none

      别名,用于排除所有可用的丰富内容。请注意,明确定义具有此选项的编解码器不会禁用 ecs_compatibility,而是依赖于管道或编解码器 ecs_compatibility 配置。

示例

此配置禁用所有丰富内容

input {
  beats {
    port => 5044
    enrich => none
  }
}

或者,要明确地启用 source_metadatassl_peer_metadata(禁用所有其他内容)

input {
  beats {
    port => 5044
    enrich => [source_metadata, ssl_peer_metadata]
  }
}

event_loop_threads

  • 值类型为 数字
  • 默认为 0。

当设置为 0 时,实际默认值为 available_processors * 2

这是一个专家级设置,通常不需要设置 Elastic Agent 插件是基于非阻塞机制实现的,需要一定数量的事件循环和执行器线程。事件循环线程负责与客户端通信(接受传入连接、入队/出队任务并响应),而执行器线程处理任务。此配置旨在限制或增加要为事件循环创建的线程数量。如果您需要设置执行器线程计数,请参阅 executor_threads 配置。

executor_threads

  • 值类型为 数字
  • 默认值为 CPU 核心数(每个 CPU 核心 1 个执行器线程)。

要用于处理传入的 Elastic Agent 请求的线程数。默认情况下,Elastic Agent 输入会创建数量等于 CPU 核心数的线程。这些线程处理传入连接、从已建立的套接字读取以及执行与网络连接管理相关的多数任务。Lumberjack 协议的解析被卸载到一个专用的线程池中。

通常您不需要更改此设置。如果您正在发送非常大的事件并观察到“OutOfDirectMemory”异常,您可能需要将此数字减少到 CPU 核心数的一半或四分之一。此更改会减少将数据批次解压缩到直接内存中的线程数量。但是,这只是一个缓解调整,因为正确的解决方案可能需要调整您的 Logstash 部署,方法是增加 Logstash 节点的数量或增加 JVM 的直接内存。

host

  • 值类型为 字符串
  • 默认值为 "0.0.0.0"

要监听的 IP 地址。

include_codec_tag

在 6.5.0 中已弃用。

已替换为 enrich

port

  • 这是必需的设置。
  • 值类型为 数字
  • 此设置没有默认值。

要监听的端口。

ssl

在 6.6.0 中已弃用。

ssl_enabled 替换

默认情况下,事件以纯文本形式发送。您可以通过将 ssl 设置为 true 并配置 ssl_certificatessl_key 选项来启用加密。

ssl_certificate

  • 值类型为 path
  • 此设置没有默认值。

要使用的 SSL 证书。

ssl_certificate_authorities

  • 值类型为 数组
  • 默认值为 []

根据这些颁发机构验证客户端证书。您可以定义多个文件或路径。所有证书都将被读取并添加到信任库中。您需要将 ssl_client_authentication 配置为 optionalrequired 以启用验证。

ssl_cipher_suites

  • 值类型为 数组
  • 默认值为 ['TLS_AES_256_GCM_SHA384', 'TLS_AES_128_GCM_SHA256', 'TLS_CHACHA20_POLY1305_SHA256', 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384', 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384', 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256', 'TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256', 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256', 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256', 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384', 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384', 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256', 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256']

要使用的密码套件列表,按优先级排列。此默认列表适用于 OpenJDK 11.0.14 及更高版本。对于较旧的 JDK 版本,默认列表仅包含该版本支持的套件。例如,ChaCha20 密码套件系列在较旧的版本中不受支持。

ssl_client_authentication

  • 值可以是以下任何一个:noneoptionalrequired
  • 默认值为 "none"

控制服务器在请求来自客户端连接的证书方面的行为:required 强制客户端提供证书,而 optional 请求客户端证书,但客户端不需要提供证书。默认为 none,这将禁用客户端身份验证。

启用双向 TLS 时(requiredoptional),客户端提供的证书必须由受信任的 ssl_certificate_authorities(CA)签名。请注意,服务器不会验证客户端证书 CN(通用名称)或 SAN(主题备用名称)。

仅当 ssl_certificate_authorities 设置时,才能使用此设置。

ssl_enabled

默认情况下,事件以纯文本形式发送。您可以通过将 ssl_enabled 设置为 true 并配置 ssl_certificatessl_key 选项来启用加密。

ssl_handshake_timeout

  • 值类型为 数字
  • 默认值为 10000

不完整的 ssl 握手超时的时间(以毫秒为单位)。

ssl_key

  • 值类型为 path
  • 此设置没有默认值。

要使用的 SSL 密钥。此密钥必须采用 PKCS8 格式并进行 PEM 编码。您可以使用 openssl pkcs8 命令完成转换。例如,将 PEM 编码的 PKCS1 私钥转换为 PEM 编码的、未加密的 PKCS8 密钥的命令是

openssl pkcs8 -inform PEM -in path/to/logstash.key -topk8 -nocrypt -outform PEM -out path/to/logstash.pkcs8.key

ssl_key_passphrase

  • 值类型为 password
  • 此设置没有默认值。

要使用的 SSL 密钥密码。

ssl_peer_metadata

在 6.5.0 中已弃用。

已替换为 enrich

启用将客户端证书信息存储在事件的元数据中。

此选项仅在 ssl_client_authentication 设置为 optionalrequired 时有效。

ssl_supported_protocols

  • 值类型为 数组
  • 允许的值为:'TLSv1.1''TLSv1.2''TLSv1.3'
  • 默认值取决于所使用的 JDK。使用最新版本的 Logstash 时,默认值为 ['TLSv1.2', 'TLSv1.3']'TLSv1.1' 不被认为是安全的,仅为遗留应用程序提供。

建立与 HTTP 端点连接时要使用的允许的 SSL/TLS 版本列表。

对于 Java 8,'TLSv1.3' 仅从 8u262(AdoptOpenJDK)开始受支持,但要求您在 Logstash 中设置 LS_JAVA_OPTS="-Djdk.tls.client.protocols=TLSv1.3" 系统属性。

如果您将插件配置为在任何最新的 JVM(例如 Logstash 附带的 JVM)上使用 'TLSv1.1',则该协议默认情况下处于禁用状态,需要通过更改 $JDK_HOME/conf/security/java.security 配置文件中的 jdk.tls.disabledAlgorithms 来手动启用。也就是说,需要从列表中删除 TLSv1.1

ssl_verify_mode

在 6.6.0 中已弃用。

ssl_client_authentication 替换

  • 值可以是以下任何一个:nonepeerforce_peer
  • 默认值为 "none"

默认情况下,服务器不会执行任何客户端验证。如果配置了 ssl_certificate_authorities,并且没有为该选项提供任何值或 none,则它将默认为 force_peer 而不是 none

peer 将使服务器要求客户端提供证书。如果客户端提供证书,则将对其进行验证。

force_peer 将使服务器要求客户端提供证书。如果客户端不提供证书,则连接将关闭。

启用双向 TLS 时(peerforce_peer),客户端提供的证书必须由受信任的 ssl_certificate_authorities(CA)签名。请注意,服务器不会验证客户端证书 CN(通用名称)或 SAN(主题备用名称)。

仅当 ssl_certificate_authorities 设置时,才能使用此设置。

tls_max_version

在 6.4.0 中已弃用。

ssl_supported_protocols 替换

允许用于加密连接的最高 TLS 版本。该值必须是以下值之一:1.1 表示 TLS 1.1,1.2 表示 TLS 1.2,1.3 表示 TLSv1.3。

tls_min_version

在 6.4.0 中已弃用。

ssl_supported_protocols 替换

允许用于加密连接的最低 TLS 版本。该值必须是以下值之一:1.1 表示 TLS 1.1,1.2 表示 TLS 1.2,1.3 表示 TLS 1.3。

常用选项

以下配置选项受所有输入插件支持

设置 输入类型 必需

add_field

hash

codec

codec

enable_metric

布尔值

id

字符串

tags

数组

type

字符串

详情

 

add_field

  • 值类型为 hash
  • 默认值为 {}

向事件添加字段

codec

  • 值类型为 codec
  • 默认值为 "plain"

用于输入数据的编解码器。输入编解码器是在输入数据进入输入之前对其进行解码的便捷方法,无需在 Logstash 管道中使用单独的过滤器。

enable_metric

  • 值类型为 boolean
  • 默认值为 true

禁用或启用此特定插件实例的指标日志记录,默认情况下,我们会记录所有可以记录的指标,但您可以禁用特定插件的指标收集。

id

  • 值类型为 string
  • 此设置没有默认值。

向插件配置添加唯一的 ID。如果未指定 ID,Logstash 将生成一个 ID。强烈建议您在配置中设置此 ID。当您有两个或多个相同类型的插件时,这尤其有用,例如,如果您有两个 elastic_agent 输入。在这种情况下,添加一个命名 ID 将有助于在使用监控 API 时监控 Logstash。

input {
  elastic_agent {
    id => "my_plugin_id"
  }
}

id 字段中的变量替换仅支持环境变量,不支持使用来自密钥存储的值。

tags

  • 值类型为 array
  • 此设置没有默认值。

向您的事件添加任意数量的任意标签。

这可以帮助以后进行处理。

type

  • 值类型为 string
  • 此设置没有默认值。

向此输入处理的所有事件添加 type 字段。

类型主要用于过滤器激活。

类型存储为事件本身的一部分,因此您也可以使用类型在 Kibana 中搜索它。

如果您尝试在已经具有类型的事件上设置类型(例如,当您从发送器发送事件到索引器时),则新的输入不会覆盖现有类型。在发送器处设置的类型会一直保留在该事件中,即使它被发送到另一个 Logstash 服务器也是如此。