Elastic Agent 环境变量

编辑

Elastic Agent 环境变量

编辑

在容器化环境中运行时，可以使用环境变量来配置 Elastic Agent。此页面上的变量按操作类型分组。

常用变量
配置 Kibana：在 Kibana 中准备 Fleet 插件
配置 Fleet Server：在 Elastic Agent 上引导 Fleet Server
配置 Elastic Agent 和 Fleet：注册 Elastic Agent

常用变量

编辑

为了限制需要设置的环境变量数量，提供了以下常用变量。这些变量可用于所有 Elastic Agent 操作，但优先级低于特定于操作的环境变量。

例如，当使用相同的 Elasticsearch 和 Kibana 凭据来准备 Kibana 中的 Fleet 插件、配置 Fleet Server 和注册 Elastic Agent 时，这些常用变量非常有用。

设置	描述
`ELASTICSEARCH_HOST`	(字符串) 要与其通信的 Elasticsearch 主机。默认值： `http://elasticsearch:9200`
`ELASTICSEARCH_USERNAME`	(字符串) 用于连接到 Kibana 并为 Fleet 获取 `service_token` 的基本身份验证用户名。默认值： `elastic`
`ELASTICSEARCH_PASSWORD`	(字符串) 用于连接到 Kibana 并为 Fleet 获取 `service_token` 的基本身份验证密码。默认值： `changeme`
`ELASTICSEARCH_CA`	(字符串) 认证机构证书的路径。默认情况下，Elastic Agent 使用其运行所在的运营系统的受信任证书机构 (CA) 列表。如果签署节点证书的证书机构不在主机系统的受信任证书机构列表中，请使用此配置添加包含 CA 证书的 `.pem` 文件的路径。默认值： `""`
`KIBANA_HOST`	(字符串) Kibana 主机。默认值： `http://kibana:5601`
`KIBANA_USERNAME`	(字符串) 用于连接到 Kibana 以检索 `service_token` 的基本身份验证用户名。默认值： `elastic`
`KIBANA_PASSWORD`	(字符串) 用于连接到 Kibana 以检索 `service_token` 的基本身份验证密码。默认值： `changeme`
`KIBANA_CA`	(字符串) 认证机构证书的路径。默认情况下，Elastic Agent 使用其运行所在的运营系统的受信任证书机构 (CA) 列表。如果签署节点证书的证书机构不在主机系统的受信任证书机构列表中，请使用此配置添加包含 CA 证书的 `.pem` 文件的路径。默认值： `""`
`ELASTIC_NETINFO`	(布尔值) 当 `false` 时，禁用 `add_host_metadata` 处理器的 `netinfo.enabled` 参数。对于主机.ip 和主机.mac 字段索引大小增加的大规模设置，建议将其设置为 `false`。默认情况下，Elastic Agent 初始化 `add_host_metadata` 处理器。`netinfo.enabled` 参数定义将 IP 地址和 MAC 地址作为字段 `host.ip` 和 `host.mac` 摄取。有关更多信息，请参见 add_host_metadata 默认值： `"false"`

为 Fleet 准备 Kibana

编辑

用于在 Kibana 中准备 Fleet 插件的设置。

设置	描述
`KIBANA_FLEET_HOST`	(字符串) 要在其上启用 Fleet 的 Kibana 主机。设置后将覆盖 `FLEET_HOST`。默认值： `http://kibana:5601`
`KIBANA_FLEET_USERNAME`	(字符串) 用于连接到 Kibana 并检索 `service_token` 以启用 Fleet 的基本身份验证用户名。设置后将覆盖 `ELASTICSEARCH_USERNAME`。默认值： `elastic`
`KIBANA_FLEET_PASSWORD`	(字符串) 用于连接到 Kibana 并检索 `service_token` 以启用 Fleet 的基本身份验证密码。设置后将覆盖 `ELASTICSEARCH_PASSWORD`。默认值： `changeme`
`KIBANA_FLEET_CA`	(字符串) 认证机构证书的路径。设置后将覆盖 `KIBANA_CA`。默认情况下，Elastic Agent 使用其运行所在的运营系统的受信任证书机构 (CA) 列表。如果签署节点证书的证书机构不在主机系统的受信任证书机构列表中，请使用此配置添加包含 CA 证书的 `.pem` 文件的路径。默认值： `""`

引导 Fleet Server

编辑

用于在此 Elastic Agent 上引导 Fleet Server 的设置。部署中至少需要一个 Fleet Server。

设置	描述
`FLEET_SERVER_ENABLE`	(整数) 设置为 `1` 以在此 Elastic Agent 上引导 Fleet Server。设置为 `1` 时，这也会自动强制执行 Fleet 注册。默认值：无
`FLEET_SERVER_ELASTICSEARCH_HOST`	(字符串) Fleet Server 要与其通信的 Elasticsearch 主机。设置后将覆盖 `ELASTICSEARCH_HOST`。默认值： `http://elasticsearch:9200`
`FLEET_SERVER_ELASTICSEARCH_CA`	(字符串) 认证机构证书的路径。设置后将覆盖 `ELASTICSEARCH_CA`。默认情况下，Elastic Agent 使用其运行所在的运营系统的受信任证书机构 (CA) 列表。如果签署节点证书的证书机构不在主机系统的受信任证书机构列表中，请使用此配置添加包含 CA 证书的 `.pem` 文件的路径。默认值： `""`
`FLEET_SERVER_ES_CERT`	(字符串) Fleet Server 将用于连接到 Elasticsearch 的相互 TLS 客户端证书的路径。默认值： `""`
`FLEET_SERVER_ES_CERT_KEY`	(字符串) Fleet Server 将用于连接到 Elasticsearch 的相互 TLS 私钥的路径。默认值： `""`
`FLEET_SERVER_INSECURE_HTTP`	(布尔值) 当 `true` 时，Fleet Server 通过不安全的或未经验证的 HTTP 公开。不建议将其设置为 `true`。默认值： `false`
`FLEET_SERVER_SERVICE_TOKEN`	(字符串) 如果启用了 `KIBANA_FLEET_SETUP`，则用于与 Elasticsearch 和 Kibana 通信的服务令牌。如果指定了服务令牌值和服务令牌路径，则该值可用于设置，并且该路径将传递到容器中的代理。默认值：无
`FLEET_SERVER_SERVICE_TOKEN_PATH`	(字符串) 如果启用了 `KIBANA_FLEET_SETUP`，则用于与 Elasticsearch 和 Kibana 通信的服务令牌文件的路径。如果指定了服务令牌值和服务令牌路径，则该值可用于设置，并且该路径将传递到容器中的代理。默认值：无
`FLEET_SERVER_POLICY_NAME`	(字符串) Fleet Server 要自己使用的策略的名称。设置后将覆盖 `FLEET_TOKEN_POLICY_NAME`。默认值：无
`FLEET_SERVER_POLICY_ID`	(字符串) Fleet Server 要自己使用的策略 ID。
`FLEET_SERVER_HOST`	(字符串) Fleet Server HTTP 的绑定主机。覆盖策略中定义的主机。默认值：无
`FLEET_SERVER_PORT`	(字符串) Fleet Server HTTP 的绑定端口。覆盖策略中定义的端口。默认值：无
`FLEET_SERVER_CERT`	(字符串) 用于 HTTPS 的证书的路径。默认值：无
`FLEET_SERVER_CERT_KEY`	(字符串) 用于 HTTPS 的证书的私钥的路径。默认值：无
`FLEET_SERVER_CERT_KEY_PASSPHRASE`	(字符串) 加密私钥文件的私钥密码的路径。默认值：无
`FLEET_SERVER_CLIENT_AUTH`	(字符串) `none`、`optional` 或 `required` 之一。Fleet Server 的客户端身份验证选项，用于客户端 mTLS 连接。如果指定了 `optional` 或 `required`，则将使用 CA 验证客户端证书。默认值： `none`
`FLEET_SERVER_ELASTICSEARCH_CA_TRUSTED_FINGERPRINT`	(字符串) 用于自签名 Elasticsearch 证书的证书颁发机构的 SHA-256 指纹（哈希值）。此指纹用于验证 Fleet Server 提供的自签名证书以及 Elastic Agent 启动的任何用于通信的输入。在将自签名证书与 Elasticsearch 一起使用时，需要此标志。默认值： `""`
`FLEET_DAEMON_TIMEOUT`	(持续时间) 设置以指示 Fleet Server 在引导过程中等待 Elastic Agent 的时间长度。
`FLEET_SERVER_TIMEOUT`	(持续时间) 设置以指示 Elastic Agent 等待 Fleet Server 检查其是否处于健康状态的时间长度。

注册 Elastic Agent

编辑

用于将 Elastic Agent 注册到 Fleet Server 的设置。

设置	描述
`ELASTIC_AGENT_CERT`	(字符串) Elastic Agent 将用于连接到 Fleet Server 的相互 TLS 客户端证书的路径。
`ELASTIC_AGENT_CERT_KEY`	(字符串) Elastic Agent 将用于连接到 Fleet Server 的相互 TLS 私钥的路径。
`ELASTIC_AGENT_CERT_KEY_PASSPHRASE`	(字符串) Elastic Agent 用于连接 Fleet Server 的相互 TLS 私钥密码文件的路径。该文件只能包含密码字符，不能包含换行符或其他非打印字符。仅当 `--elastic-agent-cert-key` 被加密并需要密码才能使用时，才会使用此选项。
`ELASTIC_AGENT_TAGS`	(字符串) 要应用于 Fleet 管理的 Elastic Agent 的逗号分隔的标签列表。您可以使用这些标签来过滤 Fleet 中的 Agent 列表。
`FLEET_ENROLL`	(布尔值) 设置为 `1` 可将 Elastic Agent 注册到 Fleet Server。默认值： `false`
`FLEET_FORCE`	(布尔值) 设置为 `true` 可强制覆盖当前 Elastic Agent 配置，无需提示确认。此标志在使用自动化软件或脚本部署时很有用。默认值： `false`
`FLEET_URL`	(字符串) 要注册的 Fleet Server 的 URL。默认值： `""`
`FLEET_ENROLLMENT_TOKEN`	(字符串) 用于注册的令牌。默认值： `""`
`FLEET_TOKEN_NAME`	(字符串) 用于从 Kibana 获取令牌的令牌名称。默认值： `""`
`FLEET_TOKEN_POLICY_NAME`	(字符串) 用于从 Kibana 获取令牌的令牌策略名称。默认值： `false`
`FLEET_CA`	(字符串) 认证机构证书的路径。设置后将覆盖 `ELASTICSEARCH_CA`。默认情况下，Elastic Agent 使用其运行所在的运营系统的受信任证书机构 (CA) 列表。如果签署节点证书的证书机构不在主机系统的受信任证书机构列表中，请使用此配置添加包含 CA 证书的 `.pem` 文件的路径。默认值： `false`
`FLEET_INSECURE`	(布尔值) 当设置为 `true` 时，Elastic Agent 将通过不安全或未验证的 HTTP 与 Fleet Server 通信。不建议将此设置为 `true`。默认值： `false`
`KIBANA_FLEET_HOST`	(字符串) 要在其上启用 Fleet 的 Kibana 主机。设置后将覆盖 `FLEET_HOST`。默认值： `http://kibana:5601`
`KIBANA_FLEET_USERNAME`	(字符串) 用于连接到 Kibana 并检索 `service_token` 以启用 Fleet 的基本身份验证用户名。设置后将覆盖 `ELASTICSEARCH_USERNAME`。默认值： `elastic`
`KIBANA_FLEET_PASSWORD`	(字符串) 用于连接到 Kibana 并检索 `service_token` 以启用 Fleet 的基本身份验证密码。设置后将覆盖 `ELASTICSEARCH_PASSWORD`。默认值： `changeme`
`KIBANA_FLEET_CA`	(字符串) 认证机构证书的路径。设置后将覆盖 `KIBANA_CA`。默认情况下，Elastic Agent 使用其运行所在的运营系统的受信任证书机构 (CA) 列表。如果签署节点证书的证书机构不在主机系统的受信任证书机构列表中，请使用此配置添加包含 CA 证书的 `.pem` 文件的路径。默认值： `""`

« 使用自定义 Ingest Pipeline 与 Kubernetes 集成将 Elastic Agent 作为 OTel 收集器运行 »