Como executar verificações de integridade

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

A Apigee oferece suporte a duas abordagens de verificação de integridade. A opção certa para você depende de como o tráfego do cliente chega à Apigee.

  • Verificação de integridade ativa:para arquiteturas que roteiam o tráfego de clientes para a Apigee por um balanceador de carga Google Cloud com suporte de um grupo gerenciado de instâncias (MIG). O balanceador de carga (ou seu cliente) sonda ativamente um dos endpoints /healthz/* para determinar a integridade da instância / ambiente, e o balanceador de carga faz failover entre regiões. Se a arquitetura usar MIGs, continue usando a verificação de integridade ativa.
  • Verificação de integridade do PSC:para arquiteturas que roteiam o tráfego de clientes para a Apigee pelo Private Service Connect (PSC). O Apigee monitora as instâncias regionais e atualiza automaticamente o estado de integridade por região. Não são necessárias sondagens iniciadas pelo cliente ou pelo balanceador de carga. Se a arquitetura usar o PSC, ative a verificação de integridade do PSC.

Selecione uma guia para saber mais.

Verificação de integridade ativa

A Apigee expõe verificações de integridade ativas em diferentes níveis que podem ser aproveitados dependendo do caso de uso.

  1. Verificação de integridade da instância da Apigee em nível regional: retorna a integridade da instância geral da Apigee em uma região.
  2. Verificações de integridade no nível do ambiente: retorna a integridade de um ambiente específico na instância da Apigee.
  3. Verificação de integridade personalizada por um proxy de API: em casos de uso complexos, é possível configurar um proxy de API dedicado como um endpoint personalizado de verificação de integridade.

Como executar uma verificação de integridade em nível regional

A Apigee oferece uma verificação de integridade de instância no nível regional / da Apigee para avaliar o status de integridade geral da instância da Apigee em uma região específica. Esse padrão de verificação de integridade, amplamente usado por balanceadores de carga, determina o status de integridade das instâncias da Apigee e realiza failovers regionais. É possível executar uma verificação de integridade em nível regional construindo a solicitação da seguinte maneira:

  • Caminho da verificação de integridade: /healthz/ingress
  • Adicione o cabeçalho da solicitação: User-Agent: GoogleHC
$ curl -H 'User-Agent: GoogleHC' https://$HOST/healthz/ingress
Apigee Ingress is healthy
 em que, $HOST representa o nome do host definido no grupo de ambiente da Apigee que é veiculado pelo balanceador de carga.

Como executar uma verificação de integridade no nível do ambiente

A Apigee oferece uma verificação de integridade para avaliar a integridade de um ambiente específico exibido pela instância da Apigee. Esse padrão de verificação de integridade é preferível quando você quer executar failovers regionais com base na integridade de determinados ambientes críticos/seletivos. É possível executar uma verificação de integridade no nível do ambiente chamando qualquer proxy de API válido em um ambiente construindo a solicitação da seguinte maneira:

  • Adicione /healthz/ ao início do caminho base do proxy.
  • Adicione o cabeçalho da solicitação: User-Agent: GoogleHC

Por exemplo, suponha que /catalog seja um caminho base de proxy válido implantado em um ambiente. Para fazer uma verificação de integridade, chame o proxy da seguinte maneira: 

$ curl -H 'User-Agent: GoogleHC' https://$HOST/healthz/catalog
Server Ready
 em que, $HOST representa o nome do host definido no grupo de ambiente da Apigee que é veiculado pelo balanceador de carga.

Como executar uma verificação de integridade personalizada por uma API

Se você quiser realizar outras validações, poderá definir a lógica personalizada de verificação de integridade em um proxy de API implantado em um ambiente. Por exemplo, talvez a verificação de integridade falhe quando vários ambientes estiverem desativados. Ou talvez a verificação de integridade falhe com base na integridade ou latência de destino.

Nesse caso, é possível realizar a verificação de integridade fazendo uma chamada regular de API para o proxy.

Por exemplo, suponha que você queira verificar a integridade de um ambiente chamado prod. Implante um proxy de API nesse ambiente com o /healthcheck-prod do caminho base. Para verificar a integridade do ambiente prod exibido pela instância da Apigee, chame o proxy desta maneira: 

$ curl https://$HOST/healthcheck-prod
 em que, $HOST representa o nome do host definido no grupo de ambiente da Apigee que é veiculado pelo balanceador de carga.

Observações sobre uso

Para verificações de integridade regionais e no ambiente: se elas forem realizadas pelos balanceadores de carga do Google Cloud, o balanceador de carga define o cabeçalho User-Agent correto. Se o próprio cliente consome essas chamadas de API de verificação de integridade, você precisa garantir que a User-Agent correta esteja definida.

Para a Apigee híbrida: o recurso de verificação de integridade está disponível apenas para a versão 1.4 e mais recentes.

Verificação de integridade do PSC

A Apigee oferece suporte à verificação de integridade com o Private Service Connect (PSC), permitindo o failover automático entre regiões para implantações multirregionais. Se você tiver várias instâncias do Apigee em várias regiões, poderá ativar as verificações de integridade do PSC para que o tráfego faça failover automaticamente para uma região íntegra quando a instância do Apigee na região ativa ficar sem integridade. Não é necessário fazer nenhuma solicitação do cliente ou do balanceador de carga para acionar a verificação.O Google Cloud monitora a instância continuamente em seu nome e atualiza o estado de integridade automaticamente.

O recurso de verificação de integridade do PSC é configurado no back-end do Apigee. Não é necessário implantar recursos extras, escrever código ou mudar os proxies de API.

Pré-requisitos

  • Você tem uma organização de assinatura ou pagamento por uso da Apigee.
  • Sua organização tem duas ou mais instâncias da Apigee, cada uma em uma Google Cloud região diferente.
  • O tráfego do cliente chega à Apigee pelo Private Service Connect (PSC).
  • Cada ambiente, grupo de ambientes, proxy de API, fluxo compartilhado e recurso é implantado de forma idêntica em todas as instâncias do Apigee que participam do failover. Implantações inconsistentes podem causar um comportamento inesperado quando o tráfego muda entre regiões.

Como ativar

A verificação de integridade do PSC é um recurso opcional gerenciado pelo Google. Para solicitar a ativação na sua organização, entre em contato com a equipe da sua conta do Apigee ou com o suporte do Apigee. Se ativado, o failover regional automático fica ativo para todas as instâncias da sua organização. Ele não requer configuração adicional.

Recomendações de teste

Como a verificação de integridade do PSC introduz um failover regional imediato e automático que afeta diretamente o roteamento de tráfego, recomendamos que você teste o recurso em um ambiente do Apigee que não seja de produção antes de ativá-lo para sua organização de produção. Verifique se o failover e a recuperação funcionam conforme o esperado para seus padrões de tráfego de API e se os aplicativos cliente processam a transição de maneira transparente.

Para simular um cenário de failover e validar sua configuração, entre em contato com a equipe da sua conta da Apigee ou com o suporte da Apigee. A equipe pode ajudar você a induzir condições de falha em um ambiente controlado para que seja possível observar o comportamento de failover antes de ativar o recurso em produção.

Como funciona o failover

Quando a verificação de integridade do PSC determina que a instância da Apigee na sua região ativa está em estado ruim, o tráfego do cliente é roteado imediatamente e de forma automática para uma instância da Apigee em bom estado em outra região. Quando a instância não íntegra se recupera, o tráfego retorna à região original. O failover e a recuperação acontecem de forma transparente para seus aplicativos clientes.

Limitações atuais

  • No momento, a verificação de integridade do PSC detecta apenas interrupções completas da infraestrutura regional. Ele não é acionado em incidentes em que o tráfego ainda pode fluir, mesmo que esteja degradado em taxas de erro ou latência. Uma verificação de integridade mais ampla no nível do componente está planejada para uma versão futura.

Como verificar o estado de integridade no Cloud Logging

É possível observar os eventos de status de integridade por região das suas instâncias do Apigee no Cloud Logging. No Análise de registros do projeto Google Cloud que hospeda sua organização do Apigee, execute o seguinte filtro: 

resource.type="compute.googleapis.com/NetworkEndpointGroupV2"

Para mais informações, consulte Monitorar registros de verificação de integridade composta.

Para cada região, consulte o campo healthState nas entradas de registro correspondentes. Um valor de HEALTHY indica que a instância do Apigee nessa região está acessível e atendendo ao tráfego. Outros valores indicam que a verificação de integridade do PSC não está roteando o tráfego para essa região.