Esta página se aplica à Apigee e à Apigee híbrida.
Confira a documentação da Apigee Edge.
A Apigee expõe verificações de integridade em diferentes níveis que podem ser aproveitados dependendo do caso de uso.
- 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.
- Verificações de integridade no nível do ambiente: retorna a integridade de um ambiente específico na instância da Apigee.
- 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 healthyem 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:
- Use o prefixo
/healthz/
no 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 Readyem 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.