Creare report e verificare l'integrità dei servizi

Articolo
06/01/2023

Quando si verificano problemi nei servizi, la possibilità di rispondere e correggere interruzioni ed eventi imprevisti dipende dalla capacità di rilevare i problemi in tempi rapidi. Se si segnalano problemi ed errori allo strumento di gestione dell'integrità di Azure Service Fabric dal codice del servizio, è possibile usare gli strumenti standard di monitoraggio dell'integrità forniti da Service Fabric per verificare lo stato di integrità.

È possibile segnalare lo stato di integrità dal servizio in tre modi:

Usare gli oggetti Partition o CodePackageActivationContext.
È possibile usare gli oggetti Partition e CodePackageActivationContext per segnalare lo stato di integrità degli elementi appartenenti al contesto corrente. Il codice in esecuzione come parte di una replica può ad esempio segnalare lo stato di integrità solo sulla replica, sulla partizione a cui appartiene e sull'applicazione di cui fa parte.
Usare FabricClient.
È possibile usare FabricClient per segnalare lo stato di integrità dal codice del servizio se il cluster non è sicuro o se il servizio è in esecuzione con privilegi di amministratore. La maggior parte degli scenari reali non usa cluster non protetti oppure fornisce privilegi di amministratore. Con FabricClientè possibile segnalare lo stato di integrità per qualsiasi entità appartenente al cluster. Idealmente il codice del servizio dovrebbe tuttavia inviare solo report correlati alla propria integrità.
Usare le API REST a livello di cluster, applicazione, applicazione distribuita, servizio, pacchetto di servizio, replica o nodo. In questo modo è possibile segnalare l'integrità direttamente da un contenitore.

Questo articolo illustra un esempio in cui viene segnalato lo stato di integrità dal codice del servizio. L'esempio mostra anche come usare gli strumenti forniti da Service Fabric per verificare lo stato di integrità. Questo articolo può essere usato come breve introduzione alle funzionalità di monitoraggio dell'integrità di Service Fabric. Per informazioni più dettagliate, è possibile leggere la serie di articoli di approfondimento sull'integrità accessibili dal collegamento presente alla fine di questo documento.

Prerequisiti

È necessario che siano installati i seguenti elementi:

Visual Studio 2015 o Visual Studio 2019
Service Fabric SDK

Per creare un cluster di sviluppo sicuro locale

Aprire PowerShell con privilegi di amministratore ed eseguire i comandi seguenti:

Comandi che mostrano come creare un cluster di sviluppo sicuro locale

Per distribuire un'applicazione e verificarne l'integrità

Aprire Visual Studio come amministratore.
Creare un progetto usando il modello Servizio con stato .
Premere F5 per eseguire l'applicazione in modalità di debug. L'applicazione verrà distribuita nel cluster locale.
Dopo aver eseguito l'applicazione, fare clic con il tasto destro del mouse sull'icona di Local Cluster Manager nell'area di notifica e aprire Service Fabric Explorer selezionando Gestisci cluster locale dal menu di scelta rapida.
L'integrità dell'applicazione sarà simile a quella visualizzata in questa immagine. A questo punto, l'applicazione dovrebbe essere integra e senza errori.
Per verificare l'integrità è possibile usare anche PowerShell. È possibile verificare l'integrità di un'applicazione usando Get-ServiceFabricApplicationHealth e l'integrità di un servizio usando Get-ServiceFabricServiceHealth. Il report sullo stato di integrità per la stessa applicazione in PowerShell è visualizzato in questa immagine.

Per aggiungere eventi di integrità personalizzati al codice del servizio

I modelli di progetto di Service Fabric in Visual Studio contengono codice di esempio. La procedura seguente illustra come segnalare eventi di integrità personalizzati dal codice del servizio. Questi report vengono automaticamente visualizzati negli strumenti standard per il monitoraggio dell'integrità forniti da Service Fabric, come Service Fabric Explorer, la vista del portale di Azure relativa all'integrità e PowerShell.

Aprire nuovamente l'applicazione creata in precedenza in Visual Studio o crearne una nuova usando il modello di Visual Studio Servizio con stato .
Aprire il file Stateful1.cs e cercare la chiamata myDictionary.TryGetValueAsync nel metodo RunAsync. Si noterà che questo metodo restituisce un result contenente il valore corrente del contatore, poiché la logica principale in questa applicazione è quella di mantenere un conteggio in esecuzione. Se questa applicazione era un'applicazione reale e se la mancanza di risultato rappresentava un errore, si vuole contrassegnare tale evento.
Per segnalare un evento di integrità per un errore dovuto alla mancanza di risultati, aggiungere la procedura seguente.

a. Aggiungere lo spazio dei nomi System.Fabric.Health al file Stateful1.cs.
```
using System.Fabric.Health;
```
b. Aggiungere il codice seguente dopo la chiamata di myDictionary.TryGetValueAsync
```
if (!result.HasValue)
{
    HealthInformation healthInformation = new HealthInformation("ServiceCode", "StateDictionary", HealthState.Error);
    this.Partition.ReportReplicaHealth(healthInformation);
}
```
Viene segnalata l'integrità di una replica, perché la segnalazione viene eseguita da un servizio con stato. Il parametro HealthInformation archivia informazioni relative al problema di integrità segnalato.

Se è stato creato un servizio senza stato, utilizzare il codice seguente.
```
if (!result.HasValue)
{
    HealthInformation healthInformation = new HealthInformation("ServiceCode", "StateDictionary", HealthState.Error);
    this.Partition.ReportInstanceHealth(healthInformation);
}
```

Se il servizio è in esecuzione con privilegi di amministratore o se il cluster non è sicuro, è anche possibile usare FabricClient per segnalare lo stato di integrità, come illustrato nella procedura seguente.

a. Creare l'istanza di FabricClient dopo la dichiarazione var myDictionary.

var fabricClient = new FabricClient(new FabricClientSettings() { HealthReportSendInterval = TimeSpan.FromSeconds(0) });

b. Aggiungere il codice seguente dopo la chiamata di myDictionary.TryGetValueAsync .

if (!result.HasValue)
{
   var replicaHealthReport = new StatefulServiceReplicaHealthReport(
        this.Context.PartitionId,
        this.Context.ReplicaId,
        new HealthInformation("ServiceCode", "StateDictionary", HealthState.Error));
    fabricClient.HealthManager.ReportHealth(replicaHealthReport);
}

Simulare l'errore e osservare come venga visualizzato negli strumenti di monitoraggio dello stato. Per simulare l'errore, impostare la prima riga come commento nel codice del report di integrità aggiunto in precedenza. Al termine di questa operazione, il codice sarà simile all'esempio seguente.
```
//if(!result.HasValue)
{
    HealthInformation healthInformation = new HealthInformation("ServiceCode", "StateDictionary", HealthState.Error);
    this.Partition.ReportReplicaHealth(healthInformation);
}
```
Questo codice genera il report di integrità ogni volta che si esegue RunAsync. Dopo aver apportato la modifica, premere F5 per eseguire l'applicazione.
Dopo l'esecuzione dell'applicazione, aprire Service Fabric Explorer per verificare l'integrità dell'applicazione. In questo caso, Service Fabric Explorer indica un problema di integrità dell'applicazione, L'applicazione viene visualizzata come non integra perché l'errore segnalato dal codice aggiunto in precedenza.
Se si seleziona la replica primaria nella visualizzazione ad albero di Service Fabric Explorer, viene visualizzato anche in questo caso un errore dello stato di integrità . In Service Fabric Explorer vengono visualizzati anche i dettagli del report di integrità aggiunti al parametro HealthInformation nel codice. È possibile visualizzare gli stessi report di integrità anche in PowerShell e nel portale di Azure.

Questo report resta in Health Manager finché non viene sostituito da un altro o finché la replica non viene eliminata. Poiché per questo report di integrità non è stato impostato un valore TimeToLive nell'oggetto HealthInformation, il report non avrà scadenza.

È consigliabile creare report sull'integrità al livello più dettagliato possibile, che in questo caso corrisponde alla replica. È anche possibile segnalare lo stato di integrità relativo all'oggetto Partition.

HealthInformation healthInformation = new HealthInformation("ServiceCode", "StateDictionary", HealthState.Error);
this.Partition.ReportPartitionHealth(healthInformation);

Per segnalare l'integrità su Application, DeployedApplicatione DeployedServicePackage, usare CodePackageActivationContext.

HealthInformation healthInformation = new HealthInformation("ServiceCode", "StateDictionary", HealthState.Error);
var activationContext = FabricRuntime.GetActivationContext();
activationContext.ReportApplicationHealth(healthInformation);

Passaggi successivi

Introduzione al monitoraggio dell'integrità di Service Fabric
REST API for reporting service health (API REST per segnalare l'integrità del servizio)
REST API for reporting application health (API REST per segnalare l'integrità dell'applicazione)