Apache SkyWalking .NET Core Agent 项目教程

Apache SkyWalking .NET Core Agent 项目教程

SkyAPM-dotnet 项目地址: https://gitcode.com/gh_mirrors/sky/SkyAPM-dotnet

1. 项目目录结构及介绍

Apache SkyWalking .NET Core Agent 项目的目录结构如下：

SkyAPM-dotnet/
├── .github/              # GitHub 相关的配置文件
├── benchmark/            # 性能测试相关代码
├── build/                # 构建脚本和配置
├── docs/                 # 文档资料
├── sample/               # 示例应用程序
├── scripts/              # 执行脚本
├── src/                  # 源代码目录
│   ├── SkyApm.Benchmark  # 性能测试代码
│   ├── SkyApm.Core       # 核心库代码
│   └── SkyApm.Provider   # 提供者接口代码
├── test/                 # 单元测试代码
├── .gitignore            # Git 忽略文件
├── .gitmodules           # Git 子模块配置
├── CHANGELOG.md          # 更新日志
├── CONTIBUTING.md        # 贡献指南
├── LICENSE               # 许可证信息
├── NuGet.config          # NuGet 配置文件
├── README.md             # 项目介绍
├── appveyor.yml          # AppVeyor CI 配置
├── build.cake            # Cake 构建脚本
└── skyapm-dotnet.sln     # Visual Studio 解决方案文件

• .github/：包含 GitHub Actions 工作流和其他 GitHub 相关配置。
• benchmark/：包含对 SkyWalking .NET Core Agent 进行性能测试的代码。
• build/：包含构建项目所需的脚本和配置。
• docs/：存放项目文档资料。
• sample/：包含示例应用程序，用于演示如何集成 SkyWalking Agent。
• scripts/：存放一些执行脚本，用于项目开发或部署。
• src/：源代码目录，包含项目的核心代码。
• test/：包含单元测试代码，用于验证功能的正确性。

2. 项目的启动文件介绍

项目的启动主要依赖于 skyapm-dotnet.sln 解决方案文件，该文件可以在 Visual Studio 中打开。解决方案中包含了多个项目，其中 SkyApm.Agent.AspNetCore 是用于 ASP.NET Core 应用程序的 SkyWalking 代理。

在 sample/ 目录中，通常会有一个名为 sampleapp 的示例项目，该项目展示了如何将 SkyWalking 代理集成到 ASP.NET Core 应用程序中。以下是启动示例应用程序的步骤：

1. 打开 sampleapp 目录。
2. 使用命令 dotnet new mvc -n sampleapp 创建一个新的 MVC 项目（如果尚未创建）。
3. 运行 dotnet add package SkyAPM.Agent.AspNetCore 添加 SkyWalking 代理到项目中。
4. 设置环境变量 ASPNETCORE_HOSTINGSTARTUPASSEMBLIES=SkyAPM.Agent.AspNetCore。
5. 设置服务名称 SKYWALKING__SERVICENAME=sample_app。
6. 运行 dotnet run 启动应用程序。

3. 项目的配置文件介绍

项目的配置主要通过 appsettings.json 文件进行，以下是配置文件的示例：

{
  "SkyWalking": {
    "ServiceName": "sample_app",
    "Reporter": {
      "Name": "grpc",
      "GrpcServers": "192.168.0.1:11800"
    }
  }
}

在上述配置中：

• ServiceName：定义了服务的名称，这个名称将用于在 SkyWalking UI 中标识服务。
• Reporter：定义了报告数据的配置，这里使用的是 gRPC 协议，并指定了后端的 gRPC 服务地址。

此外，还可以使用命令行工具 SkyAPM.DotNet.CLI 来生成配置文件。例如：

dotnet skyapm config sample_app --reporter=grpc --grpcservers=192.168.0.1:11800

这将生成一个配置文件，其中包含了 SkyWalking 代理所需的配置信息。

SkyAPM-dotnet 项目地址: https://gitcode.com/gh_mirrors/sky/SkyAPM-dotnet