Application Insights-naplózás .NET-tel

Ebben a cikkben megtudhatja, hogyan rögzíthet naplókat az Application Insights segítségével a .NET-alkalmazásokban a Microsoft.Extensions.Logging.ApplicationInsights szolgáltatói csomag használatával. Ha ezt a szolgáltatót használja, az Application Insights eszközeivel lekérdezheti és elemezheti a naplókat.

ASP.NET Core-alkalmazások

Application Insights-naplózás hozzáadása ASP.NET Core-alkalmazásokhoz:

1. Telepítse a Microsoft.Extensions.Logging.ApplicationInsights.

2. Hozzáadás ApplicationInsightsLoggerProvider:

using Microsoft.Extensions.Logging.ApplicationInsights;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.

builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

builder.Logging.AddApplicationInsights(
        configureTelemetryConfiguration: (config) => 
            config.ConnectionString = builder.Configuration.GetConnectionString("APPLICATIONINSIGHTS_CONNECTION_STRING"),
            configureApplicationInsightsLoggerOptions: (options) => { }
    );

builder.Logging.AddFilter<ApplicationInsightsLoggerProvider>("your-category", LogLevel.Trace);

var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.UseHttpsRedirection();

app.UseAuthorization();

app.MapControllers();

app.Run();

Ha telepítve van a NuGet-csomag, és a szolgáltató regisztrálva van a függőséginjektálással, az alkalmazás készen áll a naplózásra. Konstruktorinjektálás esetén vagy ILogger az általános típusú alternatíva ILogger<TCategoryName> szükséges. Ha ezek a megvalósítások megoldódnak, ApplicationInsightsLoggerProvider adja meg őket. A rendszer naplózott üzeneteket vagy kivételeket küld az Application Insightsnak.

Vegye figyelembe a következő példavezérlőt:

public class ValuesController : ControllerBase
{
    private readonly ILogger _logger;

    public ValuesController(ILogger<ValuesController> logger)
    {
        _logger = logger;
    }

    [HttpGet]
    public ActionResult<IEnumerable<string>> Get()
    {
        _logger.LogWarning("An example of a Warning trace..");
        _logger.LogError("An example of an Error level message");

        return new string[] { "value1", "value2" };
    }
}

További információ: Naplózás ASP.NET Core és Milyen Application Insights-telemetriatípus jön létre az ILogger-naplókból? Hol láthatom az ILogger-naplókat az Application Insightsban?

Konzolalkalmazás

Az Application Insights-naplózás konzolalkalmazásokhoz való hozzáadásához először telepítse a következő NuGet-csomagokat:

• Microsoft.Extensions.Logging.ApplicationInsights
• Microsoft.Extensions.DependencyInjection

Az alábbi példa a Microsoft.Extensions.Logging.ApplicationInsights csomagot használja, és bemutatja a konzolalkalmazások alapértelmezett viselkedését. A Microsoft.Extensions.Logging.ApplicationInsights csomagot egy konzolalkalmazásban kell használni, vagy amikor az Application Insights minimális implementációját szeretné elérni a teljes funkciókészlet nélkül, például metrikák, elosztott nyomkövetés, mintavételezés és telemetriai inicializálók nélkül.

using Microsoft.ApplicationInsights.Channel;
using Microsoft.ApplicationInsights.Extensibility;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;

using var channel = new InMemoryChannel();

try
{
    IServiceCollection services = new ServiceCollection();
    services.Configure<TelemetryConfiguration>(config => config.TelemetryChannel = channel);
    services.AddLogging(builder =>
    {
        // Only Application Insights is registered as a logger provider
        builder.AddApplicationInsights(
            configureTelemetryConfiguration: (config) => config.ConnectionString = "<YourConnectionString>",
            configureApplicationInsightsLoggerOptions: (options) => { }
        );
    });

    IServiceProvider serviceProvider = services.BuildServiceProvider();
    ILogger<Program> logger = serviceProvider.GetRequiredService<ILogger<Program>>();

    logger.LogInformation("Logger is working...");
}
finally
{
    // Explicitly call Flush() followed by Delay, as required in console apps.
    // This ensures that even if the application terminates, telemetry is sent to the back end.
    channel.Flush();

    await Task.Delay(TimeSpan.FromMilliseconds(1000));
}

További információ: Milyen Application Insights-telemetriatípus jön létre az ILogger-naplókból? Hol láthatom az ILogger-naplókat az Application Insightsban?

Naplózási hatókörök

ApplicationInsightsLoggingProvider támogatja a napló hatóköreit. A hatókörök alapértelmezés szerint engedélyezve vannak.

Ha a hatókör típusa IReadOnlyCollection<KeyValuePair<string,object>>, akkor a gyűjteményben lévő kulcs-érték párok egyéni tulajdonságokként lesznek hozzáadva az Application Insights telemetriai adataihoz. Az alábbi példában a naplók a tulajdonságok szerint vannak rögzítveTraceTelemetry.("MyKey", "MyValue")

using (_logger.BeginScope(new Dictionary<string, object> { ["MyKey"] = "MyValue" }))
{
    _logger.LogError("An example of an Error level message");
}

Ha bármilyen más típust használ hatókörként, a rendszer az Application Insights telemetriai tulajdonsága Scope alatt tárolja. Az alábbi példában van egy olyan tulajdonság neveScope, TraceTelemetry amely tartalmazza a hatókört.

    using (_logger.BeginScope("hello scope"))
    {
        _logger.LogError("An example of an Error level message");
    }

Gyakori kérdések

Milyen Application Insights-telemetriatípus jön létre az ILogger-naplókból? Hol láthatók az ILogger-naplók az Application Insightsban?

ApplicationInsightsLoggerProvider rögzíti a naplókat ILogger , és létrehozza TraceTelemetry őket. Ha egy Exception objektumot a rendszer a metódusnak Log ad át, ExceptionTelemetry a rendszer ILoggerahelyett TraceTelemetryjön létre.

ILogger Telemetria megtekintése

Az Azure Portalon:

1. Nyissa meg az Azure Portalt, és nyissa meg az Application Insights-erőforrást.
2. Válassza ki az Application Insights Naplók szakaszát.
3. A Kusto lekérdezésnyelv (KQL) használatával kérdezheti le a traces táblában tárolt ILogger-üzeneteket. Példa lekérdezés: traces | where message contains "YourSearchTerm".
4. Pontosítsa a lekérdezéseket, hogy az ILogger-adatokat súlyosság, időtartomány vagy adott üzenettartalom alapján szűrje.

A Visual Studióban (helyi hibakereső):

1. Indítsa el az alkalmazást hibakeresési módban a Visual Studióban.
2. Nyissa meg a Diagnosztikai eszközök ablakot az alkalmazás futtatása közben.
3. Az Események lapon az ILogger-naplók más telemetriai adatokkal együtt jelennek meg.
4. Adott ILogger-üzenetek megkereséséhez használja a diagnosztikai eszközök ablak keresési és szűrési funkcióit.

Ha mindig szeretne küldeni TraceTelemetry, használja ezt a kódrészletet:

builder.AddApplicationInsights(
    options => options.TrackExceptionsAsExceptionTelemetry = false);

Egyes ILogger-naplók miért nem rendelkeznek ugyanazokkal a tulajdonságokkal, mint mások?

Az Application Insights az TelemetryConfiguration összes többi telemetriához használt adatok használatával rögzíti és küldi ILogger a naplókat. De van egy kivétel. Alapértelmezés szerint nincs teljesen beállítva, TelemetryConfiguration amikor Program.cs vagy Startup.cs naplóz. Az ezekről a helyekről származó naplók nem rendelkeznek az alapértelmezett konfigurációval, ezért nem minden példányt és TelemetryProcessor példányt futtatnakTelemetryInitializer.

A Microsoft.Extensions.Logging.ApplicationInsights különálló csomagot használom, és manuálisan szeretnék több egyéni telemetriát naplózni. Hogyan csináljam?

Az önálló csomag TelemetryClient használata esetén a rendszer nem szúrja be a függőséginjektáló (DI) tárolóba. Létre kell hoznia egy új példányt, és ugyanazt a konfigurációt kell használnia TelemetryClient , amelyet a naplózási szolgáltató használ, ahogyan az alábbi kód is mutatja. Ez a követelmény biztosítja, hogy ugyanazt a konfigurációt használja a rendszer az összes egyéni telemetriához és telemetria esetében.ILogger

public class MyController : ApiController
{
   // This TelemetryClient instance can be used to track additional telemetry through the TrackXXX() API.
   private readonly TelemetryClient _telemetryClient;
   private readonly ILogger _logger;

   public MyController(IOptions<TelemetryConfiguration> options, ILogger<MyController> logger)
   {
        _telemetryClient = new TelemetryClient(options.Value);
        _logger = logger;
   }  
}

Nincs telepítve az SDK, és az Azure Web Apps bővítmény használatával engedélyezem az Application Insightst a ASP.NET Core-alkalmazásokhoz. Hogyan használni az új szolgáltatót?

Az Azure Web Apps Application Insights bővítménye az új szolgáltatót használja. Az alkalmazás appsettings.json fájljában módosíthatja a szűrési szabályokat.

Következő lépések

• Naplózás a .NET-ben
• Bejelentkezés a ASP.NET Core-ban
• .NET-nyomkövetési naplók az Application Insightsban