Dall'archivio script > ASP.NET Core

Catturare la telemetria degli eventi di output cache in ASP.NET Core

di Marco De SanctisMarco De Sanctis, in ASP.NET Core,

In caso di esigenze particolari, in cui vogliamo configurare l'output cache di ASP.NET Core in base a nostre logiche personalizzate, una buona soluzione è quella di incapsulare tutte queste logiche all'interno di una classe, creando una Custom Policy.

Si tratta di una classe che implementa l'interfaccia IOutputCachePolicy:

public interface IOutputCachePolicy
{
    // invocato prima che il middleware di cache sia eseguito
    // qui possiamo configurare la maggior parte delle opzioni e abilitarlo/disabilitarlo
    // in base alle nostre esigenze
    ValueTask CacheRequestAsync(OutputCacheContext context, CancellationToken cancellation);

    // invocato quando la risposta è stata trovata in cache, appena prima di restituirla
    ValueTask ServeFromCacheAsync(OutputCacheContext context, CancellationToken cancellation);

    // invocato prima di eseguire la risposta dal server, e quindi 
    // prima che venga memorizzata in cache
    ValueTask ServeResponseAsync(OutputCacheContext context, CancellationToken cancellation);
}

Per esempio, immaginiamo di voler implementare un sistema di telemetria con Application Insights, così da tracciare quando le richieste vengono servite tramite OutputCache.

Per farlo, possiamo creare la nostra ApplicationInsightsPolicy:

public class ApplicationInsightsPolicy : IOutputCachePolicy
{
    private TelemetryClient _client;

    public ApplicationInsightsPolicy(TelemetryClient client)
    {
        _client = client;
    }

    public ValueTask CacheRequestAsync(OutputCacheContext context, CancellationToken cancellation)
    {
        return ValueTask.CompletedTask;
    }

    public ValueTask ServeFromCacheAsync(OutputCacheContext context, CancellationToken cancellation)
    {
        _client.TrackEvent(new EventTelemetry("CacheHit")
        { 
            Properties =
            {
                { "Url", context.HttpContext.Request.GetDisplayUrl() },
                { "CacheTags", string.Join(",", context.Tags) }
            }
        });
        return ValueTask.CompletedTask;
    }

    public ValueTask ServeResponseAsync(OutputCacheContext context, CancellationToken cancellation)
    {
        return ValueTask.CompletedTask;
    }
}

L'implementazione è davvero banale: quando la risposta viene servita dalla cache, l'OutputCacheMiddleware invocherà il metodo ServeFromCacheAsync, all'interno del quale abbiamo inserito la nostra logica di tracking tramite TelemetryClient.

Abbiamo poi lasciato vuoti gli altri metodi, per i quali non dobbiamo specificare alcuna logica.

A questo punto non ci resta che registrare la nostra custom policy nella BasePolicy, così che venga automaticamente associata a tutti gli endpoint per i quali l'output cache sia attivo:

builder.Services.AddOutputCache(config =>
{
    config.AddBasePolicy(policy =>
    {
        policy.Expire(TimeSpan.FromMinutes(60));
        policy.AddPolicy<ApplicationInsightsPolicy>();
    });
});

Se abbiamo configurato correttamente Application Insights, vedremo questo nostro evento apparire nei log, così che possiamo utilizzarlo per generare statistiche, dashboard e quant'altro.

Commenti

Visualizza/aggiungi commenti

| Condividi su: LinkedIn, Facebook
Aggiorna

Per inserire un commento, devi avere un account.

Fai il login e torna a questa pagina, oppure registrati alla nostra community.

Approfondimenti

I più letti di oggi