New Relic Elixir Agent 使用教程

New Relic Elixir Agent 使用教程

New Relic 的 Elixir Agent 是一个用于监控 Elixir 应用程序的开源工具，它提供了对应用事务、分布式追踪等关键行为的追踪以及BEAM活动的概览。本教程将引导您了解其基本结构、如何启动、以及配置方法。

1. 项目的目录结构及介绍

Elixir Agent的仓库遵循了标准的Elixir项目布局，其主要目录结构如下：

• .gitignore: 规定了哪些文件不应被Git版本控制系统跟踪。
• CHANGELOG.md: 记录了项目的版本更新日志。
• CODE_OF_CONDUCT.md: 社区的行为准则。
• LICENSE: 显示项目遵循的Apache-2.0许可证。
• README.md: 包含了项目的快速入门信息。
• VERSION: 当前版本号。
• config: 配置相关文件夹，可能包含了示例配置或默认配置文件。
• lib: 项目的主要代码库，存放着Elixir代理的核心逻辑。
• mix.exs: Mix项目的配置文件，定义了依赖、应用程序名称、版本等。
• test: 测试文件夹，存储所有单元测试和集成测试。

2. 项目的启动文件介绍

在Elixir项目中，虽然“启动文件”通常指mix.exs中的配置与依赖设置，但实际的应用启动涉及更复杂的流程，尤其是对于如New Relic Elixir Agent这样的库。它并不直接提供一个独立的启动文件供您执行，而是通过您的应用间接启动。您需要在自己的Elixir应用中添加该agent作为依赖，并正确配置后，通过启动您的Elixir应用来启动agent。

添加依赖到您的项目:

在mix.exs文件的defp deps do块中加入以下行来添加此agent依赖:

defp deps do
  [
    {:new_relic_agent, "~> 1.0"}
  ]
end

之后运行mix do deps.get, compile来安装新依赖并编译。

3. 项目的配置文件介绍

应用配置

Elixir Agent的配置可以通过两种方式完成：应用配置和环境变量。

• 应用配置（推荐）: 在您的config/config.exs或其他适当配置文件中设置以下键值对以进行基本配置：

  config :new_relic_agent, 
    app_name: "YourAppName",
    license_key: "your_license_key"
  

• 环境变量: 也可以通过设置NEW_RELIC_APP_NAME和NEW_RELIC_LICENSE_KEY环境变量来避免把密钥暴露在源码中。

更高级配置

除了基础的app_name和license_key，您还可以配置其他选项，例如自定义HTTP客户端设置，或者在Elixir 1.15以上版本调整日志配置以适应Logger的变化。

对于更复杂的需求，如自定义日志处理、HTTP连接超时调整等，参阅仓库内的文档或配置指南详细说明。

---

请注意，正确集成和配置New Relic Elixir Agent需遵循Elixir的混合体(Mix)项目管理和其最佳实践。确保在生产环境中仔细测试所有配置变动。