Kurz: Monitorování a diagnostika aplikace ASP.NET Core na platformě Service Fabric pomocí Application Insights

Tento kurz je pátou částí série. Provede vás kroky ke konfiguraci monitorování a diagnostiky ASP.NET Core aplikace spuštěné v clusteru Service Fabric pomocí Application Insights. Budeme shromažďovat telemetrii z aplikace vyvinuté v první části kurzu Sestavení aplikace .NET pro Service Fabric.

Ve čtvrté části této série kurzů se naučíte:

V této sérii kurzů se naučíte:

Požadavky

Než začnete s tímto kurzem:

• Pokud nemáte předplatné Azure, vytvořte si bezplatný účet .
• Nainstalujte Visual Studio 2019 a nainstalujte úlohy vývoje pro vývoj a vývoj pro Azure a vývoj webů .
• Nainstalujte sadu Service Fabric SDK.

Stažení ukázkové aplikace Voting

Pokud jste nevytvořili hlasovací ukázkovou aplikaci v první části této série kurzů, můžete si ji stáhnout. Spuštěním následujícího příkazu v příkazovém okně nebo terminálu naklonujte úložiště ukázkové aplikace do místního počítače.

git clone https://github.com/Azure-Samples/service-fabric-dotnet-quickstart

Nastavení prostředku Application Insights

Application Insights je platforma pro správu výkonu aplikací Azure a doporučená platforma Service Fabric pro monitorování a diagnostiku aplikací.

Pokud chcete vytvořit prostředek Application Insights, přejděte na web Azure Portal. V navigační nabídce vlevo vyberte vytvořit prostředek a otevřete Azure Marketplace. Vyberte na monitorování a Správa a pak Application Insights.

Teď budete muset vyplnit požadované informace o atributech vytvářeného prostředku. Zadejte vhodný Název, Skupinu prostředků a Předplatné. Nastavte Umístění, do kterého v budoucnu nasadíte cluster Service Fabric. V tomto kurzu nasadíme aplikaci do místního clusteru, takže pole Umístění není relevantní. Jako Typ aplikace ponechte možnost Webová aplikace ASP.NET.

Jakmile vyplníte požadované informace, vyberte vytvořit a zajistěte prostředek – to by mělo trvat přibližně minutu.

Přidání Application Insights do služeb aplikace

Spusťte Visual Studio 2019 se zvýšenými oprávněními, a to tak, že kliknete pravým tlačítkem myši na ikonu sady Visual Studio v nabídce Start a zvolíte Spustit jako správce. Vyberte soubor > otevřít > projekt/řešení a přejděte k hlasovací aplikaci (buď vytvořenou v první části kurzu nebo naklonované Git). Otevřete hlasovacího. sln. Pokud se zobrazí výzva k obnovení balíčků NuGet aplikace, vyberte Ano.

Postupujte podle těchto kroků a nakonfigurujte Application Insights pro služby VotingWeb a VotingData:

1. Klikněte pravým tlačítkem na název služby a vyberte přidat > připojené služby > monitorování pomocí Application Insights.

   

2. Vyberte Začínáme.

3. Přihlaste se k účtu, který používáte pro předplatné Azure, a vyberte předplatné, ve kterém jste vytvořili prostředek Application Insights. Vyhledejte prostředek v rozevírací nabídce Prostředek v části Stávající prostředek Application Insights. Vyberte Registrovat a přidejte Application Insights do služby.

   

4. Jakmile otevřené dialogové okno dokončí akci, klikněte na Dokončit.

Přidání balíčku NuGet Microsoft.ApplicationInsights.ServiceFabric.Native do služeb

Application Insights má dva balíčky NuGet specifické pro Service Fabric, které je možné použít v závislosti na scénáři. Jeden se používá s nativními službami Service Fabric a druhý s kontejnery a spustitelnými soubory hosta. V tomto případě použijeme balíček NuGet Microsoft.ApplicationInsights.ServiceFabric.Native, abychom mohli využít znalost kontextu služby, kterou poskytuje. Další informace o sadě Application Insights SDK a Service Fabric specifických balíčcích NuGet najdete v části Microsoft Application Insights pro Service Fabric.

Tady je postup nastavení balíčku NuGet:

1. V horní části Průzkumník řešení klikněte pravým tlačítkem na možnost hlasovacího řešení a vyberte Spravovat balíčky NuGet pro řešení....
2. V horní navigační nabídce okna NuGet-Solution vyberte Procházet a zaškrtněte políčko zahrnout předběžné verze vedle panelu hledání.

3. Vyhledejte Microsoft.ApplicationInsights.ServiceFabric.Native a vyberte příslušný balíček NuGet.

4. Na pravé straně zaškrtněte dvě zaškrtávací políčka vedle těchto dvou služeb v aplikaci, VotingWeb a VotingData a vyberte instalovat.

5. V dialogovém okně Náhled změn , které se zobrazí, vyberte OK a přijměte přijetí licence. Tím se dokončí přidání balíčku NuGet do služeb.

6. Teď je potřeba v obou službách nastavit inicializátor telemetrie. Provedete to tak, že otevřete VotingWeb. cs a VotingData. cs. U obou z nich proveďte následující kroky:

   1. Přidejte tyto dva příkazy using v horní části každého <ServiceName> . cs a za existující příkazy using :

   using Microsoft.ApplicationInsights.Extensibility;
   using Microsoft.ApplicationInsights.ServiceFabric;
   

   2. V obou souborech, v rámci vnořeného příkazu return CreateServiceInstanceListeners () nebo CreateServiceReplicaListeners () v oblasti ConfigureServices > Services s dalšími deklarovanými službami s jedním prvkem, přidejte:

   .AddSingleton<ITelemetryInitializer>((serviceProvider) => FabricTelemetryInitializerExtension.CreateFabricTelemetryInitializer(serviceContext))
   

   Tím se do vaší telemetrie přidá kontext služby, který umožňuje lepší porozumění zdroji telemetrie v Application Insights. Váš vnořený příkaz return v souboru VotingWeb.cs by měl vypadat takto:

   return new WebHostBuilder()
       .UseKestrel()
       .ConfigureServices(
           services => services
               .AddSingleton<HttpClient>(new HttpClient())
               .AddSingleton<FabricClient>(new FabricClient())
               .AddSingleton<StatelessServiceContext>(serviceContext)
               .AddSingleton<ITelemetryInitializer>((serviceProvider) => FabricTelemetryInitializerExtension.CreateFabricTelemetryInitializer(serviceContext)))
       .UseContentRoot(Directory.GetCurrentDirectory())
       .UseStartup<Startup>()
       .UseApplicationInsights()
       .UseServiceFabricIntegration(listener, ServiceFabricIntegrationOptions.None)
       .UseUrls(url)
       .Build();
   

   Podobně byste v souboru VotingData.cs měli mít následující:

   return new WebHostBuilder()
       .UseKestrel()
       .ConfigureServices(
           services => services
               .AddSingleton<StatefulServiceContext>(serviceContext)
               .AddSingleton<IReliableStateManager>(this.StateManager)
               .AddSingleton<ITelemetryInitializer>((serviceProvider) => FabricTelemetryInitializerExtension.CreateFabricTelemetryInitializer(serviceContext)))
       .UseContentRoot(Directory.GetCurrentDirectory())
       .UseStartup<Startup>()
       .UseApplicationInsights()
       .UseServiceFabricIntegration(listener, ServiceFabricIntegrationOptions.UseUniqueServiceUrl)
       .UseUrls(url)
       .Build();
   

Dvakrát ověřte, že UseApplicationInsights() je metoda volána jak v VotingWeb. cs , tak v VotingData. cs , jak je uvedeno výše.

ConfigureServices(services => services
    ...
    .AddSingleton<ITelemetryModule>(new ServiceRemotingDependencyTrackingTelemetryModule())
    .AddSingleton<ITelemetryModule>(new ServiceRemotingRequestTrackingTelemetryModule())
)

V tuto chvíli jste připraveni nasadit aplikaci. Vyberte možnost Spustit v horní části (nebo F5) a sada Visual Studio sestaví a zabalí aplikaci, nastaví místní cluster a nasadí do ní aplikaci.

Po nasazení aplikace localhost:8080 přejděte na místo, kde byste měli být schopni zobrazit hlasovací ukázkovou aplikaci s jednou stránkou. Hlasujte pro několik různých položek, abyste vytvořili nějaká ukázková data a telemetrii – my jsme zvolili zákusky.

Až budete hotovi s přidáváním hlasů, můžete některé možnosti hlasování Odebrat.

Zobrazení telemetrie a mapy aplikace v Application Insights

Přejděte ke svému prostředku Application Insights na webu Azure Portal.

Vyberte Přehled a vraťte se na úvodní stránku vašeho prostředku. Pak vyberte Hledat v horní části a podívejte se na trasování, která přicházejí do. Zobrazení trasování v Application Insights trvá několik minut. V případě, že se žádné nezobrazí, chvíli počkejte a stiskněte tlačítko Aktualizovat v horní části.

Když se posunete dolů v okně Vyhledávání, zobrazí se veškerá příchozí telemetrie, která je součástí Application Insights. Pro každou akci, kterou jste provedli v hlasovací aplikaci, by se měl zobrazit odchozí požadavek PUT ze služby VotingWeb (PUT Votes/Put [název]),příchozí požadavek PUT ze služby VotingData (PUT VoteData/Put [název]) a pár požadavků GET pro aktualizaci zobrazovaných dat. Vzhledem k tomu, že se jedná o požadavky HTTP, zobrazí se také trasování závislosti protokolu HTTP na místním hostiteli. Tady je příklad toho, co se vám zobrazí pro přidání jednoho hlasu:

Můžete vybrat jedno ze trasování, abyste si zobrazili další podrobnosti. Zobrazí se užitečné informace o požadavku, které poskytuje Application Insights, včetně doby odezvy a adresy URL požadavku. Navíc vzhledem k tomu, že jste přidali balíček NuGet specifický pro Service Fabric, se v části Vlastní data uvedené níže zobrazí také data o vaší aplikaci v kontextu clusteru Service Fabric. To zahrnuje kontext služby, takže se zobrazí ID oddílu a ID repliky zdroje požadavku, pomocí kterých můžete lépe vyhledat problémy při diagnostice chyb v aplikaci.

Kromě toho můžete vybrat možnost Mapa aplikace v levé nabídce na stránce Přehled nebo vybrat ikonu Mapa aplikace , abyste se převzali do mapy aplikace, kde se zobrazí vaše dvě připojené služby.

Mapa aplikace vám může pomoct lépe porozumět topologii vaší aplikace, zejména když začnete přidávat více různých služeb, které mezi sebou spoluprací. Poskytuje také základní data o úspěšnosti požadavků a může vám pomoct diagnostikovat požadavky, které selhaly, abyste zjistili, kde pravděpodobně dochází k problémům. Další informace o používání mapy aplikace najdete v tématu Mapa aplikace v Application Insights.

Přidání vlastní instrumentace do aplikace

Přestože Application Insights poskytuje od začátku spoustu telemetrie, možná budete chtít přidat další vlastní instrumentaci. Ta může vycházet z vašich obchodních potřeb nebo být určená k vylepšení diagnostiky v případě, že ve vaší aplikaci dochází k problémům. Application Insights má rozhraní API pro ingestování vlastních událostí a metrik, o kterém si můžete přečíst více tady.

Přidejme do souboru VoteDataController.cs (v části VotingData > Kontrolery) několik vlastních událostí, abychom mohli sledovat přidávání a odstraňování hlasů ze základního votesDictionary.

1. Za ostatní příkazy using přidejte using Microsoft.ApplicationInsights;.
2. Na začátku třídy za vytvořením objektu IReliableStateManager deklarujte nový objekt TelemetryClient: private TelemetryClient telemetry = new TelemetryClient();.
3. Do funkce Put() přidejte událost, která potvrzuje přidání hlasu. Po dokončení transakce přímo před příkaz return OkResult přidejte telemetry.TrackEvent($"Added a vote for {name}");.
4. Ve funkci Delete() je podmínka if/else na základě toho, jestli votesDictionary obsahuje hlasy pro danou možnost hlasování.
   1. Do příkazu if za metodu await tx.CommitAsync() přidejte událost, která potvrzuje odstranění hlasu: telemetry.TrackEvent($"Deleted votes for {name}");
   2. Do příkazu else před příkaz return přidejte událost, která ukazuje, že nedošlo k odstranění: telemetry.TrackEvent($"Unable to delete votes for {name}, voting option not found");

Vaše funkce Put() a Delete() by po přidání událostí měly vypadat podobně jako v následujícím příkladu:

// PUT api/VoteData/name
[HttpPut("{name}")]
public async Task<IActionResult> Put(string name)
{
    var votesDictionary = await this.stateManager.GetOrAddAsync<IReliableDictionary<string, int>>("counts");

    using (ITransaction tx = this.stateManager.CreateTransaction())
    {
        await votesDictionary.AddOrUpdateAsync(tx, name, 1, (key, oldvalue) => oldvalue + 1);
        await tx.CommitAsync();
    }

    telemetry.TrackEvent($"Added a vote for {name}");
    return new OkResult();
}

// DELETE api/VoteData/name
[HttpDelete("{name}")]
public async Task<IActionResult> Delete(string name)
{
    var votesDictionary = await this.stateManager.GetOrAddAsync<IReliableDictionary<string, int>>("counts");

    using (ITransaction tx = this.stateManager.CreateTransaction())
    {
        if (await votesDictionary.ContainsKeyAsync(tx, name))
        {
            await votesDictionary.TryRemoveAsync(tx, name);
            await tx.CommitAsync();
            telemetry.TrackEvent($"Deleted votes for {name}");
            return new OkResult();
        }
        else
        {
            telemetry.TrackEvent($"Unable to delete votes for {name}, voting option not found");
            return new NotFoundResult();
        }
    }
}

Až budete hotovi s prováděním změn, spusťte aplikaci, aby se sestavila a nasadila její nejnovější verze. Po nasazení aplikace přejděte na adresu localhost:8080 a přidejte a odstraňte některé možnosti hlasování. Pak se vraťte k vašemu prostředku Application Insights, abyste zobrazili trasování pro poslední běh (stejně jako předtím, trasování může trvat 1-2 minut, než se objeví v Application Insights). Pro všechny přidané a odstraněné hlasy by se měla kromě telemetrie odpovědi zobrazit také vlastní událost*.

Další kroky

V tomto kurzu jste se naučili:

Teď, když jste nastavili monitorování a diagnostiku pro aplikaci ASP.NET, vyzkoušejte následující:

• Další zkoumání monitorování a diagnostiky v Service Fabric
• Analýza událostí Service Fabric pomocí Application Insights
• Další informace o Application Insights najdete v dokumentaci k Application Insights.