向云原生应用程序添加可观测性

4 分钟

了解可观测性的重要性后，你将了解如何将其包含在云原生应用程序中。为此，请将 OpenTelemetry 添加到应用。

将 OpenTelemetry 添加到应用

.NET 具有丰富的内置可观测性工具生态系统，可生成日志记录、指标和跟踪数据。可以使用这些工具向云原生应用程序添加可观测性。这些库包括：

日志记录：Microsoft.Extensions.Logging.ILogger
指标： System.Diagnostics.Metrics.Meter
跟踪：System.Diagnostics.Activity 和 System.Diagnostics.ActivitySource

OpenTelemetry 使用上述所有遥测数据，但首先，云原生应用需要通过 NuGet 包添加 OpenTelemetry 支持。这些包可以分为三个组：

类别	包装	DESCRIPTION
核心 API	OpenTelemetry	提供核心 OpenTelemetry 功能的主库。
核心 API	OpenTelemetry.Extensions.Hosting	提供用于在 ASP.NET Core 主机中自动启动和停止 OpenTelemetry 跟踪的扩展方法。
仪器设备	OpenTelemetry.Instrumentation.AspNetCore	ASP.NET Core 应用程序的检测。此包收集有关应用的大量指标，而无需编写任何代码。
出口商	OpenTelemetry.Exporter.Console	控制台的导出程序允许应用将遥测数据写出到控制台。

更多的检测和导出程序包可用于包含在云原生应用中。有关详细信息，请参阅 OpenTelemetry 的 .NET 可观测性。根据要构建的应用类型，可以添加最相关的包。

本模块重点介绍如何将 OpenTelemetry 与 eShopLite 云原生应用配合使用。此应用是使用 .NET Core 和 Blazor WebAssembly 生成的，因此这意味着所有代码示例都基于利用依赖项注入。

显示应用中各个 OpenTelemetry 组件的图表。

可以选择将所有 OpenTelemetry 包同时包含到微服务应用中的产品和商店服务。但是，在实际应用中，你有更多的服务。将所有这些包添加到每个包都涉及不必要的重复。更好的方法是将新的诊断项目添加到解决方案中，任何微服务都可以引用这些项目来观察。

下面是一些示例代码，该代码创建微服务可以调用以使用 OpenTelemetry 的方法 AddObservability ：

using OpenTelemetry.Metrics;
using OpenTelemetry.Resources;
using OpenTelemetry.Trace;

namespace Microsoft.Extensions.DependencyInjection;

public static class DiagnosticServiceCollectionExtensions
{
  public static IServiceCollection AddObservability(this IServiceCollection services,
      string serviceName,
      IConfiguration configuration)
  {
    // create the resource that references the service name passed in
    var resource = ResourceBuilder.CreateDefault().AddService(serviceName: serviceName, serviceVersion: "1.0");

    // add the OpenTelemetry services
    var otelBuilder = services.AddOpenTelemetry();

    otelBuilder
        // add the metrics providers
        .WithMetrics(metrics =>
        {
          metrics
            .SetResourceBuilder(resource)
            .AddRuntimeInstrumentation()
            .AddAspNetCoreInstrumentation()
            .AddHttpClientInstrumentation()
            .AddEventCountersInstrumentation(c =>
            {
              c.AddEventSources(
                      "Microsoft.AspNetCore.Hosting",
                      "Microsoft-AspNetCore-Server-Kestrel",
                      "System.Net.Http",
                      "System.Net.Sockets");
            })
            .AddMeter("Microsoft.AspNetCore.Hosting", "Microsoft.AspNetCore.Server.Kestrel")
            .AddConsoleExporter();

        })
        // add the tracing providers
        .WithTracing(tracing =>
        {
          tracing.SetResourceBuilder(resource)
                      .AddAspNetCoreInstrumentation()
                      .AddHttpClientInstrumentation()
                      .AddSqlClientInstrumentation();
        });

    return services;
  }

  // Add the Prometheus endpoints to your service, this will expose the metrics at http://service/metrics
  public static void MapObservability(this IEndpointRouteBuilder routes)
  {
    routes.MapPrometheusScrapingEndpoint();
  }
}

该方法返回一个 IServiceCollection 类，该类可以作为服务添加到 ASP.NET Core WebApplicationBuilder。

然后，此作将创建一个变量 var otelBuilder = services.AddOpenTelemetry() 来存储 OpenTelemetry 生成器。然后，代码可以将指标和跟踪添加到 otelBuilder。

例如，此配置添加了以下项的检测：

ASP.NET Core
C# 运行时
HttpCLient
Kestrel Web 服务器

这些指标显示在控制台中。该方法 .AddConsoleExporter() 将导出程序添加到生成器。

它还会将跟踪添加到控制台，用于：

ASP.NET Core
HttpClient
SQL 客户端

最后一行返回 IServiceCollection 类。

完成诊断项目后，只需向项目添加引用和向服务添加一行代码即可。例如，若要在产品服务中包含 OpenTelemetry，请在文件中添加项目引用 Product.csproj ：

<ProjectReference Include="..\Diagnostics\Diagnostics.csproj" />

然后，将以下行添加到 builder 声明下的 Program.cs 文件中：

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddObservability("Products", builder.Configuration);

让我们将此代码添加到 eShopLite 应用中的“产品”服务。

向云原生应用程序添加可观测性

将 OpenTelemetry 添加到应用

反馈