input-elastic_agent
插件是 input-beats
插件的下一代。它们目前共享代码和一个通用代码库。
- 插件版本:v6.9.1
- 发布日期:2024-11-18
- 变更日志
有关其他版本,请参阅版本化插件文档。
如有任何有关插件的问题,请在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 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 版本(例如 |
[@metadata][input][beats][tls][client][subject] |
[@metadata][tls_peer][subject] |
包含远程端的身份名称(例如 |
[@metadata][input][beats][tls][cipher] |
[@metadata][tls_peer][cipher_suite] |
包含使用的密码套件的名称(例如 |
增强类别:codec_metadata
ECS `v1`,`v8` | ECS `disabled` | 描述 |
---|---|---|
[tag] |
[tag] |
包含 |
[event][original] |
N/A |
启用 ECS 时,即使事件正在处理的事件上不存在 |
此插件支持以下配置选项以及稍后描述的通用选项。
设置 | 输入类型 | 必需 |
---|---|---|
已弃用 |
||
已弃用 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
已弃用 |
||
是 |
||
已弃用 |
||
有效的系统文件路径 |
否 |
|
否 |
||
否 |
||
字符串,其中之一为 |
否 |
|
否 |
||
否 |
||
有效的系统文件路径 |
否 |
|
否 |
||
已弃用 |
||
否 |
||
字符串,其中之一为 |
已弃用 |
|
已弃用 |
||
已弃用 |
另请参阅通用选项,以获取所有输入插件支持的选项列表。
在 6.0.0 中弃用。
默认值已更改为 false
。在 7.0.0 中,此设置将被删除
- 值类型为布尔值
- 默认值为
false
标志,用于确定是否使用 Elastic Agent 在 hostname
字段中提供的值将 host
字段添加到事件中。
- 值类型为字符串
-
支持的值为
-
disabled
:在根级别添加非结构化连接元数据 -
v1
:在符合 ECS v1 的命名空间下添加结构化连接元数据 -
v8
:在符合 ECS v8 的命名空间下添加结构化连接元数据
-
-
默认值取决于正在运行的 Logstash 版本
- 当 Logstash 提供
pipeline.ecs_compatibility
设置时,其值用作默认值 - 否则,默认值为
disabled
。
- 当 Logstash 提供
有关详细信息,请参阅ECS 映射。
-
值类型为字符串
- 还可以提供数组
- 配置应用于每个事件的增强功能
- 默认值为
[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_metadata
和 ssl_peer_metadata
(禁用所有其他增强功能)
input { beats { port => 5044 enrich => [source_metadata, ssl_peer_metadata] } }
- 值类型为数字
- 默认为 0。
当设置为 0
时,实际默认值为 available_processors * 2
这是一个专家级设置,通常不需要设置。Elastic Agent 插件基于非阻塞机制实现,需要一定数量的事件循环和执行器线程。事件循环线程负责与客户端通信(接受传入连接、入队/出队任务和响应),而执行器线程处理任务。此配置旨在限制或增加要为事件循环创建的线程数。如果您需要设置执行器线程计数,请参阅 executor_threads
配置。
- 值类型为数字
- 默认值等于 CPU 内核数(每个 CPU 内核 1 个执行器线程)。
用于处理传入 Elastic Agent 请求的线程数。默认情况下,Elastic Agent 输入创建的线程数等于 CPU 内核数。这些线程处理传入连接、从已建立的套接字读取以及执行与网络连接管理相关的多数任务。Lumberjack 协议的解析被卸载到一个专用的线程池。
通常您不需要更改此设置。如果您正在发送非常大的事件并观察到“OutOfDirectMemory”异常,则可能需要将此数字减少到 CPU 内核数的一半或 1/4。此更改减少了将数据批处理解压缩到直接内存中的线程数。但是,这只是一个缓解调整,因为正确的解决方案可能需要调整您的 Logstash 部署,方法是增加 Logstash 节点数或增加 JVM 的直接内存。
在 6.6.0 版中已弃用。
由 ssl_enabled
替换。
- 值类型为布尔值
- 默认值为
false
事件默认以纯文本发送。您可以通过将 ssl
设置为 true 并配置 ssl_certificate
和 ssl_key
选项来启用加密。
- 值类型为数组
- 默认值为
[]
针对这些证书颁发机构验证客户端证书。您可以定义多个文件或路径。所有证书都将被读取并添加到信任存储区。您需要将 ssl_client_authentication
配置为 optional
或 required
以启用验证。
- 值类型为数组
- 默认值为
['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 系列密码在旧版本中不受支持。
- 值可以是以下任何一个:
none
、optional
、required
- 默认值为
"none"
控制服务器在请求客户端连接证书方面的行为:required
强制客户端提供证书,而 optional
请求客户端证书但不要求客户端提供。默认为 none
,这将禁用客户端身份验证。
当启用双向 TLS(required
或 optional
)时,客户端提供的证书必须由受信任的 ssl_certificate_authorities
(CA)签名。请注意,服务器不会验证客户端证书 CN(通用名称)或 SAN(主题备用名称)。
仅当设置了 ssl_certificate_authorities
时,才能使用此设置。
- 值类型为布尔值
- 默认值为
false
事件默认以纯文本发送。您可以通过将 ssl_enabled
设置为 true 并配置 ssl_certificate
和 ssl_key
选项来启用加密。
- 值类型为 路径
- 此设置没有默认值。
要使用的 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
在 6.5.0 版中已弃用。
由 enrich
替换。
- 值类型为布尔值
- 默认值为
false
启用将客户端证书信息存储在事件的元数据中。
此选项仅在将 ssl_client_authentication
设置为 optional
或 required
时有效。
- 值类型为数组
- 允许的值为:
'TLSv1.1'
、'TLSv1.2'
、'TLSv1.3'
- 默认值取决于使用的 JDK。使用最新的 Logstash,默认值为
['TLSv1.2', 'TLSv1.3']
。'TLSv1.1'
不被认为是安全的,仅为旧版应用程序提供。8u262 (AdoptOpenJDK) 之后才支持'TLSv1.3'
,但要求您在 Logstash 中设置LS_JAVA_OPTS="-Djdk.tls.client.protocols=TLSv1.3"
系统属性。
建立与 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
。
在 6.6.0 版中已弃用。
- 值可以是以下任何一个:
none
、peer
、force_peer
- 默认值为
"none"
默认情况下,服务器不会执行任何客户端验证。如果配置了 ssl_certificate_authorities
,并且未为此选项提供值或提供了 none
,则默认为 force_peer
而不是 none
。
peer
将使服务器要求客户端提供证书。如果客户端提供证书,则将对其进行验证。
force_peer
将使服务器要求客户端提供证书。如果客户端不提供证书,则连接将被关闭。
当启用双向 TLS(peer
或 force_peer
)时,客户端提供的证书必须由受信任的 ssl_certificate_authorities
(CA)签名。请注意,服务器不会验证客户端证书 CN(通用名称)或 SAN(主题备用名称)。
仅当设置了 ssl_certificate_authorities
时,才能使用此设置。
在 6.4.0 中弃用。
由 ssl_supported_protocols
替换。
- 值类型为数字
加密连接允许的最大 TLS 版本。该值必须是以下值之一:1.1 表示 TLS 1.1,1.2 表示 TLS 1.2,1.3 表示 TLSv1.3。
在 6.4.0 中弃用。
由 ssl_supported_protocols
替换。
- 值类型为数字
加密连接允许的最小 TLS 版本。该值必须是以下值之一:1.1 表示 TLS 1.1,1.2 表示 TLS 1.2,1.3 表示 TLS 1.3。
所有输入插件都支持这些配置选项。
- 值类型为 string
- 此设置没有默认值。
向插件配置添加唯一的 ID
。如果未指定 ID,Logstash 将生成一个。强烈建议在配置中设置此 ID。当您有两个或更多相同类型的插件时,这尤其有用,例如,如果您有两个 elastic_agent 输入。在这种情况下添加命名 ID 将有助于在使用监控 API 时监控 Logstash。
input { elastic_agent { id => "my_plugin_id" } }
id
字段中的变量替换仅支持环境变量,不支持使用密钥存储中的值。
- 值类型为 string
- 此设置没有默认值。
向此输入处理的所有事件添加 type
字段。
类型主要用于过滤器激活。
类型作为事件本身的一部分存储,因此您也可以使用类型在 Kibana 中搜索它。
如果您尝试在已经具有类型的事件上设置类型(例如,当您从发货器发送事件到索引器时),则新的输入不会覆盖现有类型。即使发送到另一个 Logstash 服务器,在发货器处设置的类型也会在事件的整个生命周期中保留。