Sette opp overvåking

Slik setter du opp overvåking i Altinn-appen din.

Aktivere OpenTelemetry

Det nye oppsettet for overvåking og instrumentering aktiveres ved å sette UseOpenTelemetry til true i appsettings.json eller tilsvarende konfigurasjonsfil.

{
  "AppSettings": {
    "UseOpenTelemetry": true
  }
}

Med denne innstillingen blir OpenTelemetry konfigurert i stedet for den klassiske Application Insights SDK.

Hva skjer når du aktiverer OpenTelemetry?

All telemetri (målinger, logger og sporing) blir eksportert til:

• Lokal kjøring: Det lokale overvåkingsoppsettet (for testing og utvikling)
• Kjøring i miljø (test/produksjon): Azure Monitor

Du kan også oppgi instrumenteringsnøkkel (instrumentation key) eller Application Insights connection string i appsettings eller miljøvariabler lokalt. Da vil Altinn.App eksportere til Azure Monitor også ved lokal kjøring.

Automatisk instrumentering

Når appen kjøres med UseOpenTelemetry, får du automatisk med:

• HTTP-sporing (traces): Registrerer alle innkommende og utgående HTTP-forespørsler
• HTTP-målinger: Måler responstider, antall forespørsler og feilrater
• Altinn-spesifikk telemetri: Domenespesifikke målinger og sporing for Altinn.App

Eksempel: Hvis en bruker sender inn et skjema, vil systemet automatisk registrere hvor lang tid det tok, hvilken HTTP-statuskode som ble returnert, og hvilke eksterne tjenester som ble kalt underveis.

For informasjon om hvordan du legger inn egendefinert telemetri, se Instrumentering.

Konfigurere OpenTelemetry SDK

I noen tilfeller kan du ha behov for å tilpasse hvordan OpenTelemetry fungerer. Dette er relevant dersom du

• trenger egendefinert berikelse (enrichment) – å legge til ekstra informasjon i telemetrien
• trenger egendefinert utvalgsmetode (sampling) – å kontrollere hvor mye data som samles inn
• trenger å eksportere telemetri til en annen backend (for eksempel en egen overvåkingsløsning)

Hva er berikelse (enrichment)?

Berikelse betyr å legge til ekstra informasjon i telemetrien for å gjøre den mer nyttig.

Eksempel: Du kan automatisk legge til miljønavnet (test/produksjon) eller organisasjonsnummer på all telemetri som sendes ut.

Hva er utvalgsmetode (sampling)?

Utvalgsmetode betyr å velge ut bare en del av telemetrien som skal samles inn. Dette kan redusere kostnader og datamengde.

Eksempel: I stedet for å lagre informasjon om hver eneste forespørsel, lagrer du kun hver tiende forespørsel, eller bare forespørsler som tar over 1 sekund.

Legge til en ekstra eksportør

I eksempelet under legger vi til en ekstra eksportør (ConsoleExporter) som sender telemetri til konsollen i tillegg til standard Azure Monitor. Dette kan være nyttig for lokal testing.

Først oppdaterer vi App.csproj-filen:

        <PackageReference Include="OpenTelemetry.Exporter.Console" Version="1.9.0" />

Deretter må vi oppdatere konfigurasjonen i Program.cs:

using OpenTelemetry.Logs;
using OpenTelemetry.Metrics;
using OpenTelemetry.Trace;

void RegisterCustomAppServices(IServiceCollection services, IConfiguration config, IWebHostEnvironment env)
{
    // Konfigurer eksport for telemetrien (målinger, traces, logger).
    // Her bruker vi konsolleksport som eksempel.
    // Dette kunne også sendt telemetrien til en egendefinert backend.
    services.ConfigureOpenTelemetryMeterProvider(builder =>
        builder.AddConsoleExporter(
            (_, readerOptions) =>
            {
                // Høyere frekvens på eksport av målinger, for å se endringer raskere
                readerOptions.PeriodicExportingMetricReaderOptions.ExportIntervalMilliseconds = 5_000;
                readerOptions.PeriodicExportingMetricReaderOptions.ExportTimeoutMilliseconds = 4_000;
            }
        )
    );
    services.ConfigureOpenTelemetryTracerProvider(builder =>
    {
        // Egendefinert utvalgsmetode (sampling)
        builder.SetSampler(new ParentBasedSampler(new AlwaysOnSampler()));
        builder.AddConsoleExporter();
    });
    services.ConfigureOpenTelemetryLoggerProvider(builder => builder.AddConsoleExporter());
}

Lære mer om konfigurasjon

For å lære mer om hva som kan konfigureres og hvordan, se dokumentasjonen i opentelemetry-dotnet-repositoriet:

• Customizing OpenTelemetry .NET SDK for Tracing
• Customizing OpenTelemetry .NET SDK for Logs
• Customizing OpenTelemetry .NET SDK for Metrics

Migrere fra Application Insights SDK

Microsoft har dokumentert at

The long-term plan for Application Insights is to collect data using OpenTelemetry.

(Den langsiktige planen for Application Insights er å samle inn data med OpenTelemetry)

Dette betyr at den klassiske SDK vil med stor sannsynlighet fases ut i fremtiden. Vi anbefaler derfor å migrere når det er mulig, ved å følge instruksene over.

Migrere komponenter som setter i gang og behandler telemetri

Hvis du har egendefinert kode som setter i gang telemetri (initializers) eller behandler telemetri underveis (processors), må du migrere disse til OpenTelemetry-ekvivalenter.

Viktige hensyn

• Både OpenTelemetry og Application Insights SDK bruker W3C Trace-Context-videreføring (propagation) som standard for distribuerte sporingsdata. Dette betyr at sammenhengen på tvers av systemer skal fungere godt i en migreringsfase.

Forklaring: W3C Trace-Context er en standard som gjør at ulike systemer kan dele sporingsdata og forstå sammenhengen mellom forespørsler som går på tvers av flere tjenester.