Elastic APM .NET Agent 项目使用教程

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

Elastic APM .NET Agent 项目的目录结构如下：

• src: 包含了代理的源代码。每个子目录都针对一个特定的库，其中有一个核心项目，被其他所有项目引用。

  • Elastic.Apm: 面向 .NET Standard 2.0 的核心项目，包含了代理 API、报告数据到 APM 服务器的设施、日志设施以及针对 .NET Standard 2.0 的自动 Instrumentation。
  • Elastic.Apm.AspNetCore: 针对 ASP.NET Core 的自动 Instrumentation。
  • Elastic.Apm.EntityFrameworkCore: 针对 EntityFramework Core 的自动 Instrumentation。
  • Elastic.Apm.NetCoreAll: 方便的项目，引用了 src 文件夹中所有与 .NET Core 相关的项目。它包含了一个 ASP.NET Core 中间件扩展，可以用一行代码启用代理和每个其他组件。
  • 其他相关库的自动 Instrumentation项目，例如 Elastic.Apm.AspNetFullFramework、Elastic.Apm.MongoDb 等。

• test: 包含了测试项目，通常每个源代码项目都有一个对应的测试项目。

• docs: 包含了官方文档。

• sample: 包含了被 APM .NET Agent 监控的示例应用程序。

• build: 包含了构建解决方案时使用的文件和一个用于执行常见构建任务的项目。

• ci: 包含了在 CI 环境中构建、测试和发布代理的所有脚本。

2. 项目的启动文件介绍

在 src 目录下，核心项目 Elastic.Apm 包含了启动代理所需的代码。具体来说，ElasticApmAgent.sln 是解决方案文件，它定义了项目的所有配置和依赖。

在 Elastic.Apm.NetCoreAll 项目中，可以找到 Startup.cs 文件，这是 ASP.NET Core 应用程序的入口点。在这个文件中，你可以看到代理的初始化代码，例如：

public void ConfigureServices(IServiceCollection services)
{
    // 其他服务配置...

    services.AddElasticApm(config => {
        // 配置 APM 代理
        config.ServerUrls = new[] { "http://localhost:8200" };
    });
}

3. 项目的配置文件介绍

Elastic APM .NET Agent 的配置通常在应用程序的 appsettings.json 文件中完成。下面是一个配置文件的示例：

{
  "ElasticApm": {
    "ServerUrls": "http://localhost:8200", // APM 服务器地址
    "ServiceName": "MyService",           // 服务名称
    "ServiceVersion": "1.0.0",             // 服务版本
    "Environment": "Development"           // 环境
  }
}

在 Startup.cs 文件中，你可以通过调用 AddElasticApm 方法，并将配置委托传递给它，来加载这些配置：

public void ConfigureServices(IServiceCollection services)
{
    // 加载配置文件中的 APM 配置
    Configuration.GetSection("ElasticApm").Bind(config);
    services.AddElasticApm(config);
}

这样，Elastic APM .NET Agent 就会根据配置文件中的设置来初始化和配置代理。