通过OpenTelemetry为.NET应用埋点并上报链路数据_应用实时监控服务(ARMS)-阿里云帮助中心

前提条件

获取接入点信息

登录 ARMS 控制台，在左侧导航栏单击 接入中心 。
在 服务端应用 区域单击 OpenTelemetry 卡片。
在弹出的 OpenTelemetry 面板中选择数据需要上报的地域。

框架名称	是否支持.NET Framework（Windows 平台）	是否支持.NET （跨平台，原.NET Core）	支持的框架版本	链接
ASPNET	支持	ASP.NET (.NET Framework) MVC / WebApi 在.NET 上不支持	-	-
ASPNETCORE	/	支持	-	-
AZURE	支持	支持	支持 2021 年 10 月 01 日之后发布的 Azure. 前缀的包。	Azure SDK
ELASTICSEARCH	支持	支持	Elastic.Clients.Elasticsearch 支持版本：[8.0.0, 8.10.0) 。版本≥8.10.0 由 Elastic.Transport instrumentation 支持。	Elastic.Clients.Elasticsearch
ELASTICTRANSPORT	支持	支持	≥0.4.16	Elastic.Transport
ENTITYFRAMEWORKCORE	/	支持	≥6.0.12	Microsoft.EntityFrameworkCore
GRAPHQL	/	支持	≥7.5.0	GraphQL
GRPCNETCLIENT	支持	支持	[2.52.0, 3.0.0)	Grpc.Net.Client
HTTPCLIENT	支持	支持	*	System.Net.Http.HttpClient System.Net.HttpWebRequest
QUARTZ	.NET Framework 不支持≤ 4.7.1 的版本	支持	≥3.4.0	Quartz
MASSTRANSIT	/	支持	≥8.0.0	MassTransit
MONGODB	支持	支持	[2.13.3, 3.0.0)	MongoDB.Driver.Core
MYSQLCONNECTOR	支持	支持	≥2.0.0	MySqlConnector
MYSQLDATA	/	支持	≥8.1.0	MySql.Data
NPGSQL	支持	支持	≥6.0.0	Npgsql
NSERVICEBUS	支持	支持	≥8.0.0	NServiceBus
SQLCLIENT	支持	支持	Microsoft.Data.SqlClient v3.*暂不支持	Microsoft.Data.SqlClient System.Data.SqlClient System.Data (shipped with .NET Framework)
STACKEXCHANGEREDIS	/	支持	[2.0.405, 3.0.0)	StackExchange.Redis
WCFCLIENT	支持	支持	-	-
WCFSERVICE	支持	/	-	-

mkdir dotnet-simple-demo
cd dotnet-simple-demo
dotnet new web

{
  "$schema": "http://json.schemastore.org/launchsettings.json",
  "profiles": {
    "http": {
      "commandName": "Project",
      "dotnetRunMessages": true,
      "launchBrowser": true,
      "applicationUrl": "http://localhost:8080",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
}

```
dotnet build
```

curl -L -O https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/latest/download/otel-dotnet-auto-install.sh
./otel-dotnet-auto-install.sh

```
export OTEL_TRACES_EXPORTER=otlp \
  OTEL_METRICS_EXPORTER=none \
  OTEL_LOGS_EXPORTER=none \
  OTEL_SERVICE_NAME=<serviceName> \
  OTEL_EXPORTER_OTLP_PROTOCOL=grpc
  OTEL_EXPORTER_OTLP_ENDPOINT=<endpoint> \
  OTEL_EXPORTER_OTLP_HEADERS="Authentication=<token>"
. $HOME/.otel-dotnet-auto/instrument.sh
```

1. ```
dotnet run
```
2. ```
curl localhost:8080/
```

dotnet add package OpenTelemetry
dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol
dotnet add package OpenTelemetry.Exporter.Console # 可选，在控制台导出数据
dotnet add package OpenTelemetry.Extensions.Hosting

using System.Diagnostics;
using OpenTelemetry;
using OpenTelemetry.Trace;
using OpenTelemetry.Resources;
using OpenTelemetry.Exporter;
namespace Demo
    internal static class OpentelemetryExporterDemo
        internal static void Run()
            Console.WriteLine("otlp running");
            // OpenTelemetry上报应用名
            var serviceName = "otlp-test";
            using var tracerProvider = Sdk.CreateTracerProviderBuilder()
                .AddSource(serviceName)
                .SetResourceBuilder(
                ResourceBuilder.CreateDefault().AddService(serviceName))
                .AddOtlpExporter(opt =>
                                     // 根据前提条件中获取的接入点信息进行修改
                                     opt.Endpoint = new Uri("<endpoint>");
                                     // 使用HTTP协议上报数据
                                     opt.Protocol = OtlpExportProtocol.HttpProtobuf;
                .AddConsoleExporter() // 可选，在控制台导出数据
                .Build();
            for(int i = 0; i<10; i++)
                var MyActivitySource = new ActivitySource(serviceName);
                using var activity = MyActivitySource.StartActivity("SayHello");
                activity?.SetTag("bar", "Hello World");
}

using System.Diagnostics;
using System.Net.Http;
using OpenTelemetry;
using OpenTelemetry.Resources;
using OpenTelemetry.Trace;
namespace Demo
    public class Otlp
        public static void Main(string[] args)
            OpentelemetryExporterDemo.Run();
}

```
dotnet run
```

```
mkdir <your-project-name>
cd <your-project-name>
dotnet new mvc
```

dotnet add package OpenTelemetry.Exporter.Console # 在控制台导出采集的数据
dotnet add package OpenTelemetry.Extensions.Hosting
dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol # 以OTLP协议导出

```
dotnet add package OpenTelemetry.Instrumentation.AspNetCore
```

using System.Diagnostics;
using OpenTelemetry.Exporter;
using OpenTelemetry.Resources;
using OpenTelemetry.Trace;

public static class DiagnosticsConfig
    public const string ServiceName = "<your-service-name>";
    public const string HostName = "<your-host-name>";
    public static ActivitySource ActivitySource = new ActivitySource(ServiceName);
}

// ...
builder.Services.AddOpenTelemetry()
    .WithTracing(tracerProviderBuilder =>
        tracerProviderBuilder
            .AddSource(DiagnosticsConfig.ActivitySource.Name)
            .SetResourceBuilder(OpenTelemetry.Resources.ResourceBuilder.CreateDefault()
                .AddAttributes(new Dictionary<string, object> {
                    {"service.name", DiagnosticsConfig.ServiceName},
                    {"host.name",DiagnosticsConfig.HostName}
            .AddAspNetCoreInstrumentation()
            .AddConsoleExporter() // 在控制台导出Trace数据，可选
            .AddOtlpExporter(opt =>
                // 使用HTTP协议上报
                opt.Endpoint = new Uri("<http_endpoint>");
                opt.Protocol = OtlpExportProtocol.HttpProtobuf;
// ...

// ...
builder.Services.AddOpenTelemetry()
    .WithTracing(tracerProviderBuilder =>
        tracerProviderBuilder
            .AddSource(DiagnosticsConfig.ActivitySource.Name)
            .SetResourceBuilder(OpenTelemetry.Resources.ResourceBuilder.CreateDefault()
                .AddAttributes(new Dictionary<string, object> {
                    {"service.name", DiagnosticsConfig.ServiceName},
                    {"host.name",DiagnosticsConfig.HostName}
            .AddAspNetCoreInstrumentation()
            .AddConsoleExporter() // 在控制台导出Trace数据，可选
            .AddOtlpExporter(opt =>
                // 使用gRPC协议上报
                opt.Endpoint = new Uri("<grpc_endpoint>");
                opt.Headers = "Authentication=<token>";
                opt.Protocol = OtlpExportProtocol.Grpc;
// ...

// 引入所需包
using System.Diagnostics;
using OpenTelemetry.Exporter;
using OpenTelemetry.Resources;
using OpenTelemetry.Trace;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddControllersWithViews();
// OpenTelemetry 初始化
builder.Services.AddOpenTelemetry()
    .WithTracing(tracerProviderBuilder =>
        tracerProviderBuilder
            .AddSource(DiagnosticsConfig.ActivitySource.Name)
            .SetResourceBuilder(OpenTelemetry.Resources.ResourceBuilder.CreateDefault()
                .AddAttributes(new Dictionary<string, object> {
                    {"service.name", DiagnosticsConfig.ServiceName},
                    {"host.name",DiagnosticsConfig.HostName}
            .AddAspNetCoreInstrumentation()
            .AddConsoleExporter() // 在控制台输出Trace数据，可选
            .AddOtlpExporter(opt =>
                // 使用HTTP协议上报
                opt.Endpoint = new Uri("<http_endpoint>");
                opt.Protocol = OtlpExportProtocol.HttpProtobuf;
                // 使用gRPC协议上报
                // opt.Endpoint = new Uri("<grpc_endpoint>");
                // opt.Headers = "Authentication=<token>";
                // opt.Protocol = OtlpExportProtocol.Grpc;
var app = builder.Build();
if (!app.Environment.IsDevelopment())
    app.UseExceptionHandler("/Home/Error");
    app.UseHsts();
app.UseHttpsRedirection();
app.UseStaticFiles();
app.UseRouting();
app.UseAuthorization();
app.MapControllerRoute(
    name: "default",
    pattern: "{controller=Home}/{action=Index}/{id?}");
app.Run();
// 创建DiagnosticsConfig类
public static class DiagnosticsConfig
    public const string ServiceName = "<your-service-name>"; // 服务名
    public const string HostName = "<your-host-name>"; // 主机名
    public static ActivitySource ActivitySource = new ActivitySource(ServiceName);

dotnet run

Building...
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: http://localhost:5107
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
      Hosting environment: Development
info: Microsoft.Hosting.Lifetime[0]
      Content root path: /path/to/<your-project-name>

通过OpenTelemetry上报.NET应用数据

前提条件

背景信息

示例 Demo

方法一：自动埋点

方法二：手动埋点

方法三：半自动埋点

查看监控数据