Elastic Agent 命令参考
编辑Elastic Agent 命令参考编辑
Elastic Agent 提供用于运行 Elastic Agent、管理 Fleet Server 以及执行常见任务的命令。此处列出的命令适用于 Fleet 管理的 和 独立的 Elastic Agent。
限制
请注意运行 Elastic Agent 命令的以下限制
- 您可能需要以 root 用户身份(或 Windows 上的管理员)登录才能运行此处描述的命令。在安装并运行 Elastic Agent 服务后,请确保在运行这些命令时不要在前面加上
./
,以避免调用错误的二进制文件。 - 不支持使用 Windows PowerShell ISE 运行 Elastic Agent 命令。
elastic-agent diagnostics编辑
从 Elastic Agent 及其运行的组件/单元收集诊断信息。此命令会生成一个包含以下内容的存档:
- version.txt - 版本信息
- pre-config.yaml - 变量替换前的预配置
- variables.yaml - 来自提供者的当前变量上下文
- computed-config.yaml - 变量替换后的配置
- components-expected.yaml - 从 computed-config.yaml 中获得的预期计算组件模型
- components-actual.yaml - 运行时管理器报告的实际运行组件模型
- state.yaml - 所有运行组件的当前状态信息
-
Components Directory - 来自每个运行组件的诊断信息
- goroutine.txt - goroutine 转储
- heap.txt - 活跃对象的内存分配
- allocs.txt - 过去内存分配的采样
- threadcreate.txt - 导致创建新的操作系统线程的跟踪
- block.txt - 导致在同步原语上阻塞的堆栈跟踪
- mutex.txt - 争用互斥锁持有者的堆栈跟踪
- Unit Directory - 如果给定单元提供特定诊断,则将其放置在此处。
请注意,存档中 可能不会对凭据进行屏蔽;它们可能以纯文本形式出现在存档中的配置或策略文件中。
此命令仅用于调试目的。存档的输出格式和结构可能会在不同版本之间发生变化。
概要编辑
elastic-agent diagnostics [--file <string>] [-p] [--help] [global-flags]
选项编辑
-
--file
- 指定输出存档名称。默认为
elastic-agent-diagnostics-<timestamp>.zip
,其中时间戳是当前 UTC 时间。 -
--help
- 显示
diagnostics
命令的帮助信息。 -
-p
- 此外,还会对每个运行组件执行 30 秒的 CPU 分析。这将为每个组件生成一个额外的
cpu.pprof
文件。
有关更多标志,请参阅 全局标志。
示例编辑
elastic-agent diagnostics
elastic-agent enroll编辑
将 Elastic Agent 注册到 Fleet。
使用此命令将 Elastic Agent 注册到 Fleet,而无需将其作为服务安装。如果您从 DEB 或 RPM 包安装了 Elastic Agent 并计划使用 systemd 命令启动和管理服务,则需要执行此操作。此命令对于在安装 Elastic Agent 之前对其进行测试也很有用。
如果您已经安装了 Elastic Agent,请使用此命令修改 Elastic Agent 运行的设置。
要注册 Elastic Agent *并*将其作为服务安装,请改用 install
命令。作为服务安装是最常见的场景。
我们建议您以 root 用户身份运行 enroll
(或 install
)命令,因为某些集成需要 root 权限才能收集敏感数据。此命令会覆盖代理目录中的 elastic-agent.yml
文件。
此命令包含用于设置 Fleet Server 的可选标志。
概要编辑
要将 Elastic Agent 注册到 Fleet
elastic-agent enroll --url <string> --enrollment-token <string> [--ca-sha256 <string>] [--certificate-authorities <string>] [--daemon-timeout <duration>] [--delay-enroll] [--elastic-agent-cert <string>] [--elastic-agent-cert-key <string>] [--force] [--header <strings>] [--help] [--insecure ] [--proxy-disabled] [--proxy-header <strings>] [--proxy-url <string>] [--staging <string>] [--tag <string>] [global-flags]
要将 Elastic Agent 注册到 Fleet 并设置 Fleet Server
elastic-agent enroll --fleet-server-es <string> --fleet-server-service-token <string> [--fleet-server-service-token-path <string>] [--ca-sha256 <string>] [--certificate-authorities <string>] [--daemon-timeout <duration>] [--delay-enroll] [--elastic-agent-cert <string>] [--elastic-agent-cert-key <string>] [--fleet-server-cert <string>] [--fleet-server-cert-key <string>] [--fleet-server-cert-key-passphrase <string>] [--fleet-server-client-auth <string>] [--fleet-server-es-ca <string>] [--fleet-server-es-ca-trusted-fingerprint <string>] [--fleet-server-es-cert <string>] [--fleet-server-es-cert-key <string>] [--fleet-server-es-insecure] [--fleet-server-host <string>] [--fleet-server-insecure-http] [--fleet-server-policy <string>] [--fleet-server-port <uint16>] [--fleet-server-timeout <duration>] [--force] [--header <strings>] [--help] [--non-interactive] [--proxy-disabled] [--proxy-header <strings>] [--proxy-url <string>] [--staging <string>] [--tag <string>] [--url <string>] [global-flags]
如果没有指定 |
|
在使用自签名证书与 Elasticsearch 时需要。 |
|
在注册到使用自定义证书的 Fleet Server 时需要。URL 必须与用于生成 |
有关自定义证书的更多信息,请参阅 为自管理的 Fleet Server 配置 SSL/TLS。
选项编辑
-
--ca-sha256 <string>
- 用于证书验证的证书颁发机构哈希引脚的逗号分隔列表。
-
--certificate-authorities <string>
- 用于服务器验证的根证书的逗号分隔列表。
-
--daemon-timeout <duration>
- 等待 Elastic Agent 守护程序的超时时间。
-
--delay-enroll
- 延迟注册,以便在 Elastic Agent 服务首次启动时发生。此设置在您不希望 Elastic Agent 在下次重启或手动启动服务之前注册时很有用,例如,当您准备包含 Elastic Agent 的映像时。
-
--elastic-agent-cert
- 用作 Elastic Agent 与 Fleet Server 连接的客户端证书的证书。
-
--elastic-agent-cert-key
- 用作 Elastic Agent 与 Fleet Server 连接的私钥。
-
--enrollment-token <string>
- 用于将 Elastic Agent 注册到 Fleet 的注册令牌。您可以对多个代理使用相同的注册令牌。
-
--fleet-server-cert <string>
- 用于公开的 Fleet Server HTTPS 端点的证书。
-
--fleet-server-cert-key <string>
- 用于公开的 Fleet Server HTTPS 端点的私钥。
-
--fleet-server-cert-key-passphrase <string>
- 用于解密 Fleet Server 私钥的密码文件路径(如果使用的是加密的私钥)。
-
--fleet-server-client-auth <string>
- 以下之一:
none
、optional
或required
。默认为none
。Fleet Server 的client_authentication
选项,用于客户端 mTLS 连接。如果指定了optional
或required
,则会使用--certificate-authorities
标志中指定的 CA 验证客户端证书。 -
--fleet-server-es <string>
- 在启动 Elastic Agent 时启动 Fleet Server 进程,并连接到指定的 Elasticsearch URL。
-
--fleet-server-es-ca <string>
- 用于与 Elasticsearch 通信的证书颁发机构的路径。
-
--fleet-server-es-ca-trusted-fingerprint <string>
- 用于自签名 Elasticsearch 证书的证书颁发机构的 SHA-256 指纹(哈希)。此指纹将用于验证 Fleet Server 和 Elastic Agent 启动的任何输入为通信提供的自签名证书。在使用自签名证书与 Elasticsearch 时,此标志是必需的。
-
--fleet-server-es-cert
- Fleet Server 连接到 Elasticsearch 时将使用的客户端证书的路径。
-
--fleet-server-es-cert-key
- Fleet Server 连接到 Elasticsearch 时将使用的私钥的路径。
-
--fleet-server-es-insecure
-
允许 fleet server 在以下情况下连接到 Elasticsearch
- 连接到 HTTP 服务器时。
- 连接到 HTTPS 服务器时,但无法验证证书链。内容已加密,但证书未经验证。
使用此标志时,证书验证将被禁用。
-
--fleet-server-host <string>
- Fleet Server HTTP 绑定主机(覆盖策略)。
-
--fleet-server-insecure-http
- 通过 HTTP 公开 Fleet Server。此选项不推荐使用,因为它不安全。它在开发和测试期间很有用,但在生产环境中不应使用。使用此选项时,您应该将 Fleet Server 绑定到本地主机(这是默认设置)。
-
--fleet-server-policy <string>
- 在启动自管理的 Fleet Server 时使用,以允许使用特定策略。
-
--fleet-server-port <uint16>
- Fleet Server HTTP 绑定端口(覆盖策略)。
-
--fleet-server-service-token <string>
- 用于与 Elasticsearch 通信的服务令牌。与
--fleet-server-service-token-path
互斥。 -
--fleet-server-service-token-path <string>
- 用于与 Elasticsearch 通信的服务令牌文件。与
--fleet-server-service-token
互斥。 -
--fleet-server-timeout <duration>
- 等待 Fleet Server 准备好开始注册的超时时间。
-
--force
-
强制覆盖当前配置,而无需提示确认。此标志在使用自动化软件或脚本部署时很有用。
如果 Elastic Agent 已经安装在主机上,使用
--force
可能会导致不可预测的行为,导致 Fleet 中出现重复的 Elastic Agent。 -
--header <strings>
- 与 elasticsearch 通信时使用的标头。
-
--help
- 显示
enroll
命令的帮助信息。 -
--insecure
-
允许 Elastic Agent 通过不安全的连接连接到 Fleet Server。在以下情况下需要此设置
- 连接到 HTTP 服务器时。API 密钥以明文形式发送。
- 连接到 HTTPS 服务器时,但无法验证证书链。内容已加密,但证书未经验证。
- 使用 Elastic Agent 生成的自签名证书时。
我们强烈建议您使用安全连接。
-
--non-interactive
- 以非交互模式安装 Elastic Agent。当使用自动化软件或脚本部署时,此标志很有用。如果 Elastic Agent 已经安装在主机上,则安装将终止。
-
--proxy-disabled
- 禁用代理支持,包括环境变量。
-
--proxy-header <strings>
- 与 CONNECT 请求一起使用的代理标头。
-
--proxy-url <string>
- 配置代理 URL。
-
--staging <string>
- 配置代理以从暂存构建下载工件。
-
--tag <string>
-
应用于 Fleet 管理的 Elastic Agent 的逗号分隔标签列表。您可以使用这些标签来过滤 Fleet 中的代理列表。
目前,无法删除或编辑现有标签。要更改标签,您必须取消注册 Elastic Agent,然后使用新标签重新注册它。
-
--url <string>
- 用于将 Elastic Agent 注册到 Fleet 的 Fleet Server URL。
有关更多标志,请参阅 全局标志。
示例edit
将 Elastic Agent 注册到 Fleet
elastic-agent enroll \ --url=https://cedd4e0e21e240b4s2bbbebdf1d6d52f.fleet.eu-west-1.aws.cld.elstc.co:443 \ --enrollment-token=NEFmVllaa0JLRXhKebVKVTR5TTI6N2JaVlJpSGpScmV0ZUVnZVlRUExFQQ==
将 Elastic Agent 注册到 Fleet 并设置 Fleet Server
elastic-agent enroll --fleet-server-es=http://elasticsearch:9200 \ --fleet-server-service-token=AbEAAdesYXN1abMvZmxlZXQtc2VldmVyL3Rva2VuLTE2MTkxMzg3MzIzMTg7dzEta0JDTmZUcGlDTjlwRmNVTjNVQQ \ --fleet-server-policy=a35fd520-26f5-11ec-8bd9-3374690g57b6
使用 Fleet Server 启动 Elastic Agent(在自定义 CA 上运行)。此示例假设您已使用以下名称生成证书
-
ca.crt
: 根 CA 证书 -
fleet-server.crt
: Fleet Server 证书 -
fleet-server.key
: Fleet Server 私钥 -
elasticsearch-ca.crt
: 用于连接到 Elasticsearch 的 CA 证书
elastic-agent enroll \ --url=https://fleet-server:8220 \ --fleet-server-es=https://elasticsearch:9200 \ --fleet-server-service-token=AAEBAWVsYXm0aWMvZmxlZXQtc2XydmVyL3Rva2VuLTE2MjM4OTAztDU1OTQ6dllfVW1mYnFTVjJwTC2ZQ0EtVnVZQQ \ --fleet-server-policy=a35fd520-26f5-11ec-8bd9-3374690g57b6 \ --certificate-authorities=/path/to/ca.crt \ --fleet-server-es-ca=/path/to/elasticsearch-ca.crt \ --fleet-server-cert=/path/to/fleet-server.crt \ --fleet-server-cert-key=/path/to/fleet-server.key \ --fleet-server-port=8220
然后将另一个 Elastic Agent 注册到在先前示例中启动的 Fleet Server
elastic-agent enroll --url=https://fleet-server:8220 \ --enrollment-token=NEFmVllaa0JLRXhKebVKVTR5TTI6N2JaVlJpSGpScmV0ZUVnZVlRUExFQQ== \ --certificate-authorities=/path/to/ca.crt
elastic-agent helpedit
显示特定命令的帮助信息。
概要edit
elastic-agent help <command> [--help] [global-flags]
选项edit
-
command
- 命令的名称。
-
--help
- 显示
help
命令的帮助信息。
有关更多标志,请参阅 全局标志。
示例edit
elastic-agent help enroll
elastic-agent inspectedit
显示当前 Elastic Agent 配置。
如果没有指定参数,则显示完整的 Elastic Agent 配置。
概要edit
elastic-agent inspect [--help] elastic-agent inspect components [--show-config] [--show-spec] [--help] [id]
选项edit
-
components
-
显示组件的当前配置。此命令接受其他标志
-
--show-config
- 用于显示所有单元中的配置。
-
--show-spec
- 用于获取组件的输入/输出运行时规范。
-
-
--help
- 显示
inspect
命令的帮助信息。
有关更多标志,请参阅 全局标志。
示例edit
elastic-agent inspect elastic-agent inspect components --show-config elastic-agent inspect components log-default
elastic-agent installedit
将 Elastic Agent 永久安装到系统上,并使用系统的服务管理器进行管理。代理将在安装完成后自动启动。在 Linux(tar 包)上,此命令需要一个系统和服务管理器,例如 systemd。
如果您从 DEB 或 RPM 包安装了 Elastic Agent,则 install
命令将跳过安装本身,并充当 enroll
命令 的别名。请注意,使用 DEB 或 RPM 升级 Elastic Agent 后,需要重新启动 Elastic Agent 服务。
您必须以 root 用户身份(或 Windows 上的管理员)运行此命令才能将文件写入正确的位置。此命令将覆盖代理目录中的 elastic-agent.yml
文件。
运行此命令的语法因平台而异。有关特定于平台的示例,请参阅 安装 Elastic Agent。
概要edit
要将 Elastic Agent 安装为服务,将其注册到 Fleet 并启动 elastic-agent
服务
elastic-agent install --url <string> --enrollment-token <string> [--base-path <string>] [--ca-sha256 <string>] [--certificate-authorities <string>] [--daemon-timeout <duration>] [--delay-enroll] [--elastic-agent-cert <string>] [--elastic-agent-cert-key <string>] [--force] [--header <strings>] [--help] [--insecure ] [--non-interactive] [--proxy-disabled] [--proxy-header <strings>] [--proxy-url <string>] [--staging <string>] [--tag <string>] [global-flags]
要将 Elastic Agent 安装为服务,将其注册到 Fleet 并启动 fleet-server
进程以及 elastic-agent
服务
elastic-agent install --fleet-server-es <string> --fleet-server-service-token <string> [--fleet-server-service-token-path <string>] [--base-path <string>] [--ca-sha256 <string>] [--certificate-authorities <string>] [--daemon-timeout <duration>] [--delay-enroll] [--elastic-agent-cert <string>] [--elastic-agent-cert-key <string>] [--fleet-server-cert <string>] [--fleet-server-cert-key <string>] [--fleet-server-cert-key-passphrase <string>] [--fleet-server-client-auth <string>] [--fleet-server-es-ca <string>] [--fleet-server-es-ca-trusted-fingerprint <string>] [--fleet-server-es-cert <string>] [--fleet-server-es-cert-key <string>] [--fleet-server-es-insecure] [--fleet-server-host <string>] [--fleet-server-insecure-http] [--fleet-server-policy <string>] [--fleet-server-port <uint16>] [--fleet-server-timeout <duration>] [--force] [--header <strings>] [--help] [--non-interactive] [--proxy-disabled] [--proxy-header <strings>] [--proxy-url <string>] [--staging <string>] [--tag <string>] [--url <string>] [global-flags]
如果没有指定 |
|
在 Elasticsearch 端使用自签名证书时需要。 |
|
在注册到使用自定义证书的 Fleet Server 时需要。URL 必须与用于生成 |
有关自定义证书的更多信息,请参阅 为自管理的 Fleet Server 配置 SSL/TLS。
选项edit
-
--base-path <string>
-
将 Elastic Agent 安装到 默认 位置以外的位置。指定安装的自定义基本路径。
目前,
--base-path
选项不支持 Elastic Defend。 -
--ca-sha256 <string>
- 用于证书验证的证书颁发机构哈希引脚的逗号分隔列表。
-
--certificate-authorities <string>
- 用于服务器验证的根证书的逗号分隔列表。
-
--daemon-timeout <duration>
- 等待 Elastic Agent 守护程序的超时时间。
-
--delay-enroll
- 延迟注册,以便在 Elastic Agent 服务首次启动时发生。此设置在您不希望 Elastic Agent 在下次重启或手动启动服务之前注册时很有用,例如,当您准备包含 Elastic Agent 的映像时。
-
--elastic-agent-cert
- 用作 Elastic Agent 与 Fleet Server 连接的客户端证书的证书。
-
--elastic-agent-cert-key
- 用作 Elastic Agent 与 Fleet Server 连接的私钥。
-
--enrollment-token <string>
- 用于将 Elastic Agent 注册到 Fleet 的注册令牌。您可以对多个代理使用相同的注册令牌。
-
--fleet-server-cert <string>
- 用于公开的 Fleet Server HTTPS 端点的证书。
-
--fleet-server-cert-key <string>
- 用于公开的 Fleet Server HTTPS 端点的私钥。
-
--fleet-server-cert-key-passphrase <string>
- 用于解密 Fleet Server 私钥的密码文件路径(如果使用的是加密的私钥)。
-
--fleet-server-client-auth <string>
- 以下之一:
none
、optional
或required
。默认为none
。Fleet Server 的client_authentication
选项,用于客户端 mTLS 连接。如果指定了optional
或required
,则会使用--certificate-authorities
标志中指定的 CA 验证客户端证书。 -
--fleet-server-es <string>
- 在启动 Elastic Agent 时启动 Fleet Server 进程,并连接到指定的 Elasticsearch URL。
-
--fleet-server-es-ca <string>
- 用于与 Elasticsearch 通信的证书颁发机构的路径。
-
--fleet-server-es-ca-trusted-fingerprint <string>
- 用于自签名 Elasticsearch 证书的证书颁发机构的 SHA-256 指纹(哈希)。此指纹将用于验证 Fleet Server 和 Elastic Agent 启动的任何输入为通信提供的自签名证书。在使用自签名证书与 Elasticsearch 时,此标志是必需的。
-
--fleet-server-es-cert
- Fleet Server 连接到 Elasticsearch 时将使用的客户端证书的路径。
-
--fleet-server-es-cert-key
- Fleet Server 连接到 Elasticsearch 时将使用的私钥的路径。
-
--fleet-server-es-insecure
-
允许 fleet server 在以下情况下连接到 Elasticsearch
- 连接到 HTTP 服务器时。
- 连接到 HTTPS 服务器时,但无法验证证书链。内容已加密,但证书未经验证。
使用此标志时,证书验证将被禁用。
-
--fleet-server-host <string>
- Fleet Server HTTP 绑定主机(覆盖策略)。
-
--fleet-server-insecure-http
- 通过 HTTP 公开 Fleet Server。此选项不推荐使用,因为它不安全。它在开发和测试期间很有用,但在生产环境中不应使用。使用此选项时,您应该将 Fleet Server 绑定到本地主机(这是默认设置)。
-
--fleet-server-policy <string>
- 在启动自管理的 Fleet Server 时使用,以允许使用特定策略。
-
--fleet-server-port <uint16>
- Fleet Server HTTP 绑定端口(覆盖策略)。
-
--fleet-server-service-token <string>
- 用于与 Elasticsearch 通信的服务令牌。与
--fleet-server-service-token-path
互斥。 -
--fleet-server-service-token-path <string>
- 用于与 Elasticsearch 通信的服务令牌文件。与
--fleet-server-service-token
互斥。 -
--fleet-server-timeout <duration>
- 等待 Fleet Server 准备好开始注册的超时时间。
-
--force
-
强制覆盖当前配置,而无需提示确认。此标志在使用自动化软件或脚本部署时很有用。
如果 Elastic Agent 已经安装在主机上,使用
--force
可能会导致不可预测的行为,导致 Fleet 中出现重复的 Elastic Agent。 -
--header <strings>
- 与 elasticsearch 通信时使用的标头。
-
--help
- 显示
enroll
命令的帮助信息。 -
--insecure
-
允许 Elastic Agent 通过不安全的连接连接到 Fleet Server。在以下情况下需要此设置
- 连接到 HTTP 服务器时。API 密钥以明文形式发送。
- 连接到 HTTPS 服务器时,但无法验证证书链。内容已加密,但证书未经验证。
- 使用 Elastic Agent 生成的自签名证书时。
我们强烈建议您使用安全连接。
-
--non-interactive
- 以非交互模式安装 Elastic Agent。当使用自动化软件或脚本部署时,此标志很有用。如果 Elastic Agent 已经安装在主机上,则安装将终止。
-
--proxy-disabled
- 禁用代理支持,包括环境变量。
-
--proxy-header <strings>
- 与 CONNECT 请求一起使用的代理标头。
-
--proxy-url <string>
- 配置代理 URL。
-
--staging <string>
- 配置代理以从暂存构建下载工件。
-
--tag <strings>
-
应用于 Fleet 管理的 Elastic Agent 的逗号分隔标签列表。您可以使用这些标签来过滤 Fleet 中的代理列表。
目前,无法删除或编辑现有标签。要更改标签,您必须取消注册 Elastic Agent,然后使用新标签重新注册它。
-
--url <string>
- 用于将 Elastic Agent 注册到 Fleet 的 Fleet Server URL。
有关更多标志,请参阅 全局标志。
示例edit
将 Elastic Agent 安装为服务,将其注册到 Fleet 并启动 elastic-agent
服务
elastic-agent install \ --url=https://cedd4e0e21e240b4s2bbbebdf1d6d52f.fleet.eu-west-1.aws.cld.elstc.co:443 \ --enrollment-token=NEFmVllaa0JLRXhKebVKVTR5TTI6N2JaVlJpSGpScmV0ZUVnZVlRUExFQQ==
将 Elastic Agent 安装为服务,将其注册到 Fleet 并启动 fleet-server
进程以及 elastic-agent
服务
elastic-agent install --fleet-server-es=http://elasticsearch:9200 \ --fleet-server-service-token=AbEAAdesYXN1abMvZmxlZXQtc2VldmVyL3Rva2VuLTE2MTkxMzg3MzIzMTg7dzEta0JDTmZUcGlDTjlwRmNVTjNVQQ \ --fleet-server-policy=a35fd620-26f6-11ec-8bd9-3374690f57b6
使用 Fleet Server 启动 Elastic Agent(在自定义 CA 上运行)。此示例假设您已使用以下名称生成证书
-
ca.crt
: 根 CA 证书 -
fleet-server.crt
: Fleet Server 证书 -
fleet-server.key
: Fleet Server 私钥 -
elasticsearch-ca.crt
: 用于连接到 Elasticsearch 的 CA 证书
elastic-agent install \ --url=https://fleet-server:8220 \ --fleet-server-es=https://elasticsearch:9200 \ --fleet-server-service-token=AAEBAWVsYXm0aWMvZmxlZXQtc2XydmVyL3Rva2VuLTE2MjM4OTAztDU1OTQ6dllfVW1mYnFTVjJwTC2ZQ0EtVnVZQQ \ --fleet-server-policy=a35fd520-26f5-11ec-8bd9-3374690g57b6 \ --certificate-authorities=/path/to/ca.crt \ --fleet-server-es-ca=/path/to/elasticsearch-ca.crt \ --fleet-server-cert=/path/to/fleet-server.crt \ --fleet-server-cert-key=/path/to/fleet-server.key \ --fleet-server-port=8220
然后安装另一个 Elastic Agent 并将其注册到在先前示例中启动的 Fleet Server
elastic-agent install --url=https://fleet-server:8220 \ --enrollment-token=NEFmVllaa0JLRXhKebVKVTR5TTI6N2JaVlJpSGpScmV0ZUVnZVlRUExFQQ== \ --certificate-authorities=/path/to/ca.crt
elastic-agent restartedit
重新启动当前正在运行的 Elastic Agent 守护程序。
概要edit
elastic-agent restart [--help] [global-flags]
选项edit
-
--help
- 显示
restart
命令的帮助信息。
有关更多标志,请参阅 全局标志。
示例edit
elastic-agent restart
elastic-agent runedit
启动 elastic-agent
进程。
概要edit
elastic-agent run [global-flags]
全局标志edit
这些标志在您在命令行上运行 elastic-agent
时有效。
-
-c <string>
- 要使用的配置文件。如果未指定,Elastic Agent 将使用
{path.config}/elastic-agent.yml
。 -
--e
- 记录到 stderr 并禁用 syslog/文件输出。
-
--environment <environmentVar>
- 代理将运行的环境。
-
--path.config <string>
- Elastic Agent 在其中查找其配置文件的目录。默认值因平台而异。
-
--path.home <string>
-
Elastic Agent 的根目录。
path.home
确定配置文件和数据目录的位置。如果未指定,Elastic Agent 将使用当前工作目录。
-
--path.logs <string>
- Elastic Agent 的日志输出路径。默认值因平台而异。
-
--v
- 将日志级别设置为 INFO。
示例edit
elastic-agent run -c myagentconfig.yml
elastic-agent statusedit
返回正在运行的 Elastic Agent 守护程序和 Elastic Agent 中每个进程的当前状态。还将返回 Fleet 服务器的最后已知状态。 output
选项控制信息的详细程度和格式。
概要edit
elastic-agent status [--output <string>] [--help] [global-flags]
选项edit
-
--output <string>
- 以
human
(默认)、full
、json
或yaml
输出状态信息。human
在 Elastic Agent 处于HEALTHY
状态时返回有限的信息。如果任何组件或单元未处于HEALTHY
状态,则将显示该组件或单元的完整详细信息。full
、json
和yaml
始终返回完整的状态信息。组件映射到 Elastic Agent 下运行的单个进程,例如 Filebeat 或 Endpoint Security。单元映射到该进程中的离散配置单元,例如 Filebeat 输入或 Metricbeat 模块。
当输出为 json
或 yaml
时,状态代码将作为数值返回。可以使用以下表格映射状态代码
+
代码 | 状态 |
---|---|
0 |
|
1 |
|
2 |
|
3 |
|
4 |
|
5 |
|
6 |
|
7 |
|
-
--help
- 显示
status
命令的帮助信息。
有关更多标志,请参阅 全局标志。
示例edit
elastic-agent status
elastic-agent uninstalledit
从系统中永久卸载 Elastic Agent。
您必须以 root 用户身份(或 Windows 上的管理员)运行此命令才能删除文件。
请确保从安装 Elastic Agent 的目录运行 uninstall
命令,而不是从之前运行 install
命令的目录运行。
您必须以 root 用户身份运行此命令。
sudo /Library/Elastic/Agent/elastic-agent uninstall
您必须以 root 用户身份运行此命令。
sudo /opt/Elastic/Agent/elastic-agent uninstall
以管理员身份打开 PowerShell 提示符(右键单击 PowerShell 图标并选择 以管理员身份运行)。
从 PowerShell 提示符中运行
C:\"Program Files"\Elastic\Agent\elastic-agent.exe uninstall
概要编辑
elastic-agent uninstall [--force] [--help] [global-flags]
选项编辑
-
--force
- 卸载 Elastic Agent 且不提示确认。当使用自动化软件或脚本部署时,此标志很有用。
-
--help
- 显示
uninstall
命令的帮助信息。
有关更多标志,请参阅 全局标志。
示例编辑
elastic-agent uninstall
elastic-agent upgrade编辑
将当前运行的 Elastic Agent 升级到指定版本。这仅应与以独立模式运行的代理一起使用。注册到 Fleet 的代理应通过 Fleet 升级。
概要编辑
elastic-agent upgrade <version> [--source-uri <string>] [--help] [flags]
选项编辑
-
版本
- 要升级到的 Elastic Agent 版本。
-
--source-uri <string>
- 用于下载新版本的源 URI。默认情况下,Elastic Agent 使用 Elastic Artifacts URL。
-
--skip-verify
- 跳过软件包验证过程。此选项不推荐使用,因为它不安全。
-
--pgp-path <string>
- 使用本地存储的 PGP 密钥副本验证升级软件包。
-
--pgp-uri <string>
- 使用指定的在线 PGP 密钥验证升级软件包。
-
--help
- 显示
upgrade
命令的帮助信息。
有关使用 --skip-verify
、--pgp-path <string>
和 --pgp-uri <string>
软件包验证选项的详细信息,请参阅 验证 Elastic Agent 软件包签名。
有关更多标志,请参阅 全局标志。
示例编辑
elastic-agent upgrade 7.10.1
elastic-agent logs编辑
显示正在运行的 Elastic Agent 的日志。
概要编辑
elastic-agent logs [--follow] [--number <int>] [--component <string>] [--no-color] [--help] [global-flags]
选项编辑
-
--follow
或-f
- 跟踪日志更新,直到命令被中断(例如使用
Ctrl-C
)。 -
--number <int>
或-n <int>
- 要打印的日志行数。如果启用了跟踪日志,则会影响初始输出。
-
--component <string>
或-C <string>
- 根据组件名称过滤日志。
-
--no-color
- 根据每个条目的日志级别禁用颜色。
-
--help
- 显示
logs
命令的帮助信息。
有关更多标志,请参阅 全局标志。
示例编辑
elastic-agent logs -n 100 -f -C "system/metrics-default"
elastic-agent version编辑
显示 Elastic Agent 的版本。
概要编辑
elastic-agent version [--help] [global-flags]
选项编辑
-
--help
- 显示
version
命令的帮助信息。
有关更多标志,请参阅 全局标志。
示例编辑
elastic-agent version