› › ›

APM 服务器命令参考

编辑

APM 服务器命令参考编辑

这些命令仅适用于 APM 服务器二进制安装方法。

APM 服务器提供了一个命令行界面，用于启动 APM 服务器和执行常见任务，例如测试配置文件。

命令行还支持全局标志来控制全局行为。

如果满足以下条件，请使用 sudo 运行以下命令：

配置文件归 root 所有，或者
APM 服务器配置为捕获需要 root 访问权限的数据

此处描述的某些功能需要 Elastic 许可证。有关更多信息，请参阅 https://elastic.ac.cn/subscriptions 和许可证管理。

命令
`apikey`	管理 APM 代理和服务器之间通信的 API 密钥。
`export`	将配置、索引模板或 ILM 策略导出到标准输出。
`help`	显示任何命令的帮助。
`keystore`	管理密钥库。
`run`	运行 APM 服务器。如果在未指定命令的情况下启动 APM 服务器，则默认使用此命令。
`test`	测试配置。
`version`	显示有关当前版本的信息。

另请参阅全局标志。

`apikey` 命令编辑

此功能处于技术预览阶段，可能会在未来的版本中更改或删除。Elastic 将努力解决任何问题，但技术预览版中的功能不受官方 GA 功能的支持 SLA 的约束。

已在 8.6.0 中弃用。

用户应通过 Kibana 或 Elasticsearch REST API 创建 API 密钥。请参阅 API 密钥。

APM 代理和 APM 服务器之间的通信现在支持在 Authorization 标头中发送 API 密钥。APM 服务器提供了一个 apikey 命令，可以创建、验证、使无效和显示有关代理/服务器通信的 API 密钥的信息。大多数操作都需要 manage_own_api_key 集群权限，并且您必须确保已适当地配置 apm-server.api_key 或 output.elasticsearch。

语法

apm-server apikey SUBCOMMAND [FLAGS]

子命令

create

使用指定的权限创建一个 API 密钥。没有必需的标志。

请求创建 API 密钥的用户需要具有 APM 服务器使用的 APM 权限。默认情况下，超级用户具有这些权限。对于其他用户，您可以创建它们。有关所需权限，请参阅创建 API 密钥用户。

info

查询 API 密钥。需要 --id 或 --name。

invalidate

使 API 密钥无效。需要 --id 或 --name。

verify

检查凭据字符串是否具有给定的权限。需要 --credentials。

标志

--agent-config: 代理远程读取配置所需。对 create 和 verify 子命令有效。与 create 一起使用时，将 config_agent:read 权限授予创建的密钥。与 verify 一起使用时，请求 config_agent:read 权限。
--credentials CREDS: verify 子命令所需。指定要检查其权限的凭据。凭据是 API 密钥的 id:api_key 的 base64 编码表示形式。
--expiration TIME: 与 create 一起使用时，指定密钥的过期时间，例如“1d”（默认永不过期）。
--id ID: API 密钥的 ID。对 info 和 invalidate 子命令有效。与 info 一起使用时，查询指定的 ID。与 invalidate 一起使用时，删除指定的 ID。
--ingest: 摄取事件所需。对 create 和 verify 子命令有效。与 create 一起使用时，将 event:write 权限授予创建的密钥。与 verify 一起使用时，请求 event:write 权限。
--json: 以 JSON 格式打印命令的输出。对所有 apikey 子命令有效。
--name NAME: API 密钥的名称。对 create、info 和 invalidate 子命令有效。与 create 一起使用时，指定要创建的 API 密钥的名称（默认值：“apm-key”）。与 info 一起使用时，指定要查询的 API 密钥（可能有多个匹配项）。与 invalidate 一起使用时，指定要删除的 API 密钥（可能有多个匹配项）。
--sourcemap: 上传源映射所需。对 create 和 verify 子命令有效。与 create 一起使用时，将 sourcemap:write 权限授予创建的密钥。与 verify 一起使用时，请求 sourcemap:write 权限。
--valid-only: 与 info 一起使用时，仅返回有效的 API 密钥（未过期或无效）。

另请参阅全局标志。

示例

apm-server apikey create --ingest --agent-config --name example-001
apm-server apikey info --name example-001 --valid-only
apm-server apikey invalidate --name example-001

有关更多信息，请参阅 API 密钥。

`export` 命令编辑

将配置、索引模板或 ILM 策略导出到标准输出。您可以使用此命令快速查看您的配置或查看索引模板或 ILM 策略的内容。

语法

apm-server export SUBCOMMAND [FLAGS]

子命令

config: 将当前配置导出到标准输出。如果使用 -c 标志，则此命令将导出指定文件中定义的配置。
template: 将索引模板导出到标准输出。您可以指定 --es.version 和 --index 标志来进一步定义要导出的内容。此外，您可以通过 --dir 定义目录，将模板导出到文件而不是 stdout。

ilm-policy: 将索引生命周期管理策略导出到标准输出。您可以指定 --es.version 和 --dir，将策略作为文件导出到该目录，而不是导出到 stdout。

标志

--es.version VERSION: 与 template 一起使用时，导出与指定版本兼容的索引模板。与 ilm-policy 一起使用时，如果为 ILM 启用了指定的 ES 版本，则导出 ILM 策略。
-h, --help: 显示 export 命令的帮助。
--index BASE_NAME: 与 template 一起使用时，设置用于索引模板的基名。如果未指定此标志，则默认基名为 apm-server。
--dir DIRNAME: 定义一个目录，将模板和 ILM 策略作为文件导出到该目录，而不是将它们打印到 stdout。

另请参阅全局标志。

示例

apm-server export config
apm-server export template --es.version 8.14.2 --index myindexname

`help` 命令编辑

显示任何命令的帮助。如果未指定命令，则显示 run 命令的帮助。

语法

apm-server help COMMAND_NAME [FLAGS]

COMMAND_NAME: 指定要显示其帮助的命令的名称。

标志

-h, --help: 显示 help 命令的帮助。

另请参阅全局标志。

示例

apm-server help export

`keystore` 命令编辑

管理密钥库。

语法

apm-server keystore SUBCOMMAND [FLAGS]

子命令

add KEY: 将指定的密钥添加到密钥库。使用 --force 标志覆盖现有密钥。使用 --stdin 标志通过 stdin 传递值。
create: 创建一个密钥库来保存密钥。使用 --force 标志覆盖现有密钥库。
list: 列出密钥库中的密钥。
remove KEY: 从密钥库中删除指定的密钥。

标志

--force: 对 add 和 create 子命令有效。与 add 一起使用时，覆盖指定的密钥。与 create 一起使用时，覆盖密钥库。
--stdin: 与 add 一起使用时，使用标准输入作为密钥值的来源。
-h, --help: 显示 keystore 命令的帮助。

另请参阅全局标志。

示例

apm-server keystore create
apm-server keystore add ES_PWD
apm-server keystore remove ES_PWD
apm-server keystore list

有关更多示例，请参阅密钥库。

`run` 命令编辑

运行 APM 服务器。如果在未指定命令的情况下启动 APM 服务器，则默认使用此命令。

语法

apm-server run [FLAGS]

或

apm-server [FLAGS]

标志

-N, --N: 禁用发布以进行测试。
--cpuprofile FILE: 将 CPU 配置文件数据写入指定的文件。此选项对 APM 服务器的故障排除很有用。
-h, --help: 显示 run 命令的帮助。
--httpprof [HOST]:PORT: 启动用于分析的 HTTP 服务器。此选项对 APM 服务器的故障排除和分析很有用。
--memprofile FILE: 将内存配置文件数据写入指定的输出文件。此选项对 APM 服务器的故障排除很有用。
--system.hostfs MOUNT_POINT: 指定主机文件系统的挂载点，用于监控主机。

另请参阅全局标志。

示例

apm-server run -e

或

apm-server -e

`test` 命令编辑

测试配置。

语法

apm-server test SUBCOMMAND [FLAGS]

子命令

config: 测试配置设置。
output: 测试 APM 服务器是否可以使用当前设置连接到输出。

标志

-h, --help: 显示 test 命令的帮助。

另请参阅全局标志。

示例

apm-server test config

`version` 命令编辑

显示有关当前版本的信息。

语法

apm-server version [FLAGS]

标志

-h, --help: 显示 version 命令的帮助信息。

另请参阅全局标志。

示例

apm-server version

全局标志编辑

每当您运行 APM Server 时，这些全局标志都可用。

-E, --E "SETTING_NAME=VALUE"

覆盖特定的配置设置。您可以指定多个覆盖。例如

apm-server -E "name=mybeat" -E "output.elasticsearch.hosts=['http://myhost:9200']"

此设置应用于当前运行的 APM Server 进程。APM Server 配置文件不会更改。

-c, --c 文件

指定用于 APM Server 的配置文件。您在此处指定的文件是相对于 path.config 的。如果未指定 -c 标志，则使用默认配置文件 apm-server.yml。

-d, --d 选择器

为指定的选器启用调试。对于选择器，您可以指定以逗号分隔的组件列表，也可以使用 -d "*" 为所有组件启用调试。例如，-d "publisher" 显示所有与发布者相关的消息。

-e, --e

记录到 stderr 并禁用 syslog/文件输出。

-environment

出于日志记录目的，指定 APM Server 运行的环境。当未配置日志输出时，此设置用于选择默认日志输出。支持的值为：systemd、container、macos_service 和 windows_service。如果指定了 systemd 或 container，APM Server 默认情况下将记录到 stdout 和 stderr。

--path.config

设置配置文件的路径。有关详细信息，请参阅安装布局部分。

--path.data

设置数据文件的路径。有关详细信息，请参阅安装布局部分。

--path.home

设置其他文件的路径。有关详细信息，请参阅安装布局部分。

--path.logs

设置日志文件的路径。有关详细信息，请参阅安装布局部分。

--strict.perms

对配置文件设置严格的权限检查。默认值为 -strict.perms=true。有关更多信息，请参阅配置文件所有权。

-v, --v

记录 INFO 级别的消息。

« 用于安全设置的密钥库调整数据摄取 »

APM 服务器命令参考

APM 服务器命令参考编辑

apikey 命令编辑

已在 8.6.0 中弃用。

export 命令编辑

help 命令编辑

keystore 命令编辑

run 命令编辑

test 命令编辑

version 命令编辑

全局标志编辑

`apikey` 命令编辑

`export` 命令编辑

`help` 命令编辑

`keystore` 命令编辑

`run` 命令编辑

`test` 命令编辑

`version` 命令编辑