Elastic APM Server 使用指南

Elastic APM Server 使用指南

apm-server APM Server 项目地址: https://gitcode.com/gh_mirrors/ap/apm-server

---

1. 项目目录结构及介绍

Elastic APM Server 的源代码组织在 https://github.com/elastic/apm-server 上。以下是其主要的目录结构及其简介：

• docs: 包含项目文档，包括用户指南和开发者指南。
• cmd: 存放主程序入口和其他命令相关的代码。
• dev_docs: 开发者相关文档，帮助开发者了解如何贡献代码。
• licenses: 各个依赖库和组件的许可证文件。
• x-pack: 扩展功能相关代码，可能包括一些高级特性或管理工具。
• .gitignore, .dockerignore, go.mod, go.sum: 版本控制忽略文件，Docker构建时忽略文件以及Go模块管理文件。
• Makefile: 构建和维护项目的脚本，包含了各种构建、测试和清理的任务。
• apm-server.yml: 默认的配置文件模板，用于快速启动APM Server。

其它如 ci, scripts, systemtest, tooling 等目录服务于持续集成、自动化测试、辅助工具等方面，对终端用户来说不是日常交互的重点。

2. 项目的启动文件介绍

Elastic APM Server没有一个单独标记为“启动文件”的文件。它通过Go语言编写的命令来运行，主要通过执行项目根目录下的命令行指令来启动。通常，用户可以通过构建项目后，在项目目录下运行构建出的可执行文件（默认名为apm-server）来启动服务。例如，通过以下步骤中的Makefile命令来实现：

make
./apm-server

或者利用提供的YAML配置文件以调试模式启动：

./apm-server -c apm-server.yml -e -d "*"

3. 项目的配置文件介绍

主配置文件: apm-server.yml

配置文件位于项目根目录中，提供了一种定制APM Server行为的方式。这个文件包含了服务器监听的端口、数据处理设置、目标Elasticsearch集群的信息等关键设置。

核心配置项示例：

• output.elasticsearch.hosts: 指定Elasticsearch集群的地址，确保APM数据能够被正确索引。
• server.host: APM Server自身的监听地址。
• apm HOURLY_INDEX_TEMPLATE_ENABLED: 控制是否启用小时级别的索引模板。
• ssl.enabled: 是否启用HTTPS通信。
• api.secret_token: 安全令牌，用于保护API访问。

配置文件可以根据具体需求进行调整，详细配置项解释可在Elastic的官方文档中找到，确保在修改配置前仔细阅读文档以免造成不必要的错误配置。

使用APM Server之前，理解这些核心目录结构、启动逻辑以及配置细节对于有效部署和管理是非常重要的。请务必参考官方文档获取最新且详细的指导信息。

apm-server APM Server 项目地址: https://gitcode.com/gh_mirrors/ap/apm-server