Relatar e verificar a integridade de serviço

Artigo
10/15/2024

Quando seus serviços enfrentam problemas, sua capacidade de reagir e corrigir os incidentes e as interrupções depende da sua capacidade de detectar os problemas rapidamente. Se relatar problemas e falhas ao gerenciador de integridade do Azure Service Fabric usando seu código de serviço, você pode usar ferramentas padrão de monitoramento de integridade fornecidas pelo Service Fabric para verificar o status de integridade.

Há três maneiras de relatar a integridade no serviço:

Usar os objetos Partition ou CodePackageActivationContext.
Você pode usar os objetos Partition e CodePackageActivationContext para relatar a integridade de elementos que fazem parte do contexto atual. Por exemplo, o código que é executado como parte de uma réplica pode relatar a integridade apenas dessa réplica, da partição a qual pertence e do aplicativo do qual faz parte.
Use FabricClient.
Você poderá usar o FabricClient para relatar a integridade do código do serviço se o cluster não for seguro ou se o serviço estiver sendo executado com privilégios de administrador. A maioria dos cenários do mundo real não usa clusters inseguros ou fornece privilégios de administrador. Com o FabricClient, você poderá relatar a integridade de qualquer entidade que faz parte do cluster. No entanto, o ideal é que o código do serviço envie apenas relatórios relacionados à sua própria integridade.
Use as APIs REST no cluster, no aplicativo, no aplicativo implantado, no serviço, no pacote de serviço, na partição, na réplica ou nos níveis de nó. Isso pode ser usado para relatar a integridade no interior de um contêiner.

Este artigo apresenta um exemplo que relata a integridade do código de serviço. O exemplo também mostra como as ferramentas fornecidas pelo Service Fabric podem ser usadas para verificar o status de integridade. Este artigo é uma rápida introdução aos recursos de monitoramento de integridade do Service Fabric. Para obter informações mais detalhadas, você pode ler a série de artigos explicativos sobre integridade, começando com o link no fim deste artigo.

Pré-requisitos

Você deve ter o seguinte instalado:

Visual Studio 2015 ou Visual Studio 2019
SDK da Malha do Serviço

Para criar um cluster de desenvolvimento local seguro

Abra o PowerShell com privilégios de administrador e execute os comandos a seguir:

Comandos que mostram como criar um cluster de desenvolvimento seguro

Para implantar um aplicativo e verificar sua integridade

Abra o Visual Studio como administrador.
Crie um projeto usando o modelo Serviço com Estado .
Pressione F5 para executar o aplicativo no modo de depuração. O aplicativo é implantado no cluster local.
Depois que o aplicativo estiver em execução, clique com o botão direito do mouse no ícone do Gerenciador de Cluster Local na área de notificação e selecione Gerenciar Cluster Local no menu de atalho para abrir o Service Fabric Explorer.
A integridade do aplicativo deve ser exibida como nesta imagem. Neste momento, o aplicativo deve estar íntegro, sem erros.
Você também pode verificar a integridade usando o PowerShell. Você pode usar Get-ServiceFabricApplicationHealth para verificar a integridade de um aplicativo e Get-ServiceFabricServiceHealth para verificar a integridade de um serviço. O relatório de integridade para o mesmo aplicativo no PowerShell está nesta imagem.

Para adicionar eventos de integridade personalizados ao seu código de serviço

Os modelos de projeto do Service Fabric no Visual Studio contêm código de exemplo. As etapas a seguir mostram como você pode relatar eventos de integridade personalizados do seu código de serviço. Esses relatórios serão exibidos automaticamente nas ferramentas padrão para monitoramento de integridade fornecidas pelo Service Fabric, como o Service Fabric Explorer, a exibição de integridade do Portal do Azure e o PowerShell.

Abra novamente o aplicativo que você criou anteriormente no Visual Studio ou crie um novo usando o modelo de Serviço com Estado do Visual Studio.
Abra o arquivo Stateful1.cs e encontre a chamada myDictionary.TryGetValueAsync no método RunAsync. Você pode ver que esse método retorna um result que mantém o valor atual do contador, pois a lógica principal desse aplicativo é manter uma contagem em execução. Se esse fosse um aplicativo real e a falta de resultado representasse uma falha, seria aconselhável sinalizar esse evento.
Para relatar um evento de integridade quando a falta de resultado representa uma falha, adicione as etapas a seguir.

a. Adicione o namespace System.Fabric.Health ao arquivo Stateful1.cs.
```
using System.Fabric.Health;
```
b. Adicione o seguinte código após a chamada myDictionary.TryGetValueAsync
```
if (!result.HasValue)
{
    HealthInformation healthInformation = new HealthInformation("ServiceCode", "StateDictionary", HealthState.Error);
    this.Partition.ReportReplicaHealth(healthInformation);
}
```
Relatamos a integridade da réplica porque ela está sendo relatada de um serviço com estado. O parâmetro HealthInformation armazena informações sobre o problema de integridade que está sendo relatado.

Se você tiver criado um serviço sem estado, use o código a seguir
```
if (!result.HasValue)
{
    HealthInformation healthInformation = new HealthInformation("ServiceCode", "StateDictionary", HealthState.Error);
    this.Partition.ReportInstanceHealth(healthInformation);
}
```

Se o serviço estiver sendo executado com privilégios de administrador ou se o cluster não for seguro, também será possível usar FabricClient para relatar a integridade conforme mostrado nas etapas a seguir.

a. Crie a instância do var myDictionary após a declaração FabricClient.

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

b. Adicione o seguinte código após a chamada 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);
}

Vamos simular essa falha e ver como ela é exibida nas ferramentas de monitoramento de integridade. Para simular a falha, comente a primeira linha no código de relatório de integridade adicionado anteriormente. Depois de comentar a primeira linha, o código se parecerá com este exemplo:
```
//if(!result.HasValue)
{
    HealthInformation healthInformation = new HealthInformation("ServiceCode", "StateDictionary", HealthState.Error);
    this.Partition.ReportReplicaHealth(healthInformation);
}
```
Esse código aciona o relatório de integridade sempre que o RunAsync é executado. Depois de fazer a alteração, pressione F5 para executar o aplicativo.
Depois que o aplicativo estiver em execução, abra o Service Fabric Explorer para verificar a integridade do aplicativo. Desta vez, o Service Fabric Explorer mostra que o aplicativo não está íntegro. O aplicativo é exibido como não íntegro por causa do erro relatado a partir do código que adicionamos anteriormente.
Se você selecionar a réplica primária na exibição de árvore do Service Fabric Explorer, verá que Estado de Integridade indica um erro também. O Service Fabric Explorer também exibe os detalhes do relatório de integridade que foram adicionados ao parâmetro HealthInformation no código. Você pode ver os mesmos relatórios de integridade no PowerShell e no Portal do Azure.

Esse relatório permanece no gerenciador de integridade até que seja substituído por outro relatório ou até que essa réplica seja excluída. Como nós não definimos TimeToLive para este relatório de integridade no objeto HealthInformation, o relatório nunca expira.

Recomendamos que a integridade seja relatada no nível mais granular. Neste caso, é a réplica. Você também pode relatar a integridade em Partition.

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

Para relatar a integridade em Application, DeployedApplication e DeployedServicePackage, use CodePackageActivationContext.

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

Compartilhar via

Relatar e verificar a integridade de serviço

Pré-requisitos

Para criar um cluster de desenvolvimento local seguro

Para implantar um aplicativo e verificar sua integridade

Para adicionar eventos de integridade personalizados ao seu código de serviço

Próximas etapas

Comentários

Recursos adicionais