Visão geral das anomalias nas operações

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

Confira a documentação da Apigee Edge.

As anomalias de operações identificam padrões de dados incomuns ou inesperados com suas APIs. As anomalias nas operações monitoram continuamente e realizam análises estatísticas para encontrar anomalias.

As anomalias de operações detectam automaticamente estes tipos de anomalia:

• Aumento de todos os erros HTTP 4xx ou 5xx nos níveis de organização, ambiente e região
• Aumento da latência total da resposta para o 90o percentil (p90) no nível da organização, do ambiente e da região

Por exemplo, neste gráfico da taxa de erros da API, ela aumenta subitamente por volta das 7h. Comparado aos dados que levaram a esse período, esse aumento é incomum o suficiente para ser classificado como uma anomalia.

As anomalias de operações também podem discernir variações que têm menos probabilidade de indicar anomalias. Por exemplo, você pode ver algumas pequenas variações na taxa de erros que levou à anomalia, mas isso não é significativo o suficiente para ser categorizado como anomalia.

Com as anomalias nas operações, você pode:

• Ver e investigar anomalias: as anomalias de operações informam eventos de API incomuns (anomalias). É possível detalhar para descobrir onde e quando o incidente ocorreu e o que o acionou, para que você possa corrigir a situação rapidamente.
• Crie alertas de anomalias e configure notificações para que a Apigee envie uma mensagem quando um incidente ocorrer.

Pré-requisitos para usar as anomalias nas operações

Para usar anomalias nas operações:

• O complemento AAPI Ops precisa estar ativado para sua organização. Consulte Ativar as operações AAPI em uma organização.
• Os usuários de anomalias de operações precisam ter os seguintes papéis:
  • roles/apigee.readOnlyAdmin
  • roles/logging.viewer
  • roles/monitoring.viewer
• Usuários que investigam anomalias no painel também precisam do papel roles/logging.viewer.

Ativar as operações AAPI em uma organização

É preciso ativar na sua organização as operações AAPI para poder usar. Antes de fazer isso, consiga um token de acesso do OAuth 2.0. Em seguida, ative as operações da AAPI usando uma chamada de API que transmita o token de acesso.

Ver a configuração dos complementos

Verifique se operações da AAPI já não estão ativadas fazendo a seguinte chamada de API:

curl "https://apigee.googleapis.com/v1/organizations/YOUR_ORG" \
  -X GET \
  -H "Content-type: application/json" \
  -H "Authorization: Bearer $TOKEN"

em que YOUR_ORG é o nome da sua organização e $TOKEN é a variável de ambiente de um token de acesso OAuth. Isso retorna informações básicas sobre sua organização, que incluem uma seção para complementos da Apigee que começam com a linha:

"addonsConfig": {

Verifique se esta seção contém uma entrada que começa com "advancedApiOpsConfig", como o exemplo a seguir:

"advancedApiOpsConfig": {
          "enabled": "true"
      }

Se a entrada estiver presente, as operações da AAPI já estão ativadas na organização. Caso contrário, você precisará ativá-la conforme descrito a seguir.

Ativar operações da AAPI

Para ativar as operações da AAPI na organização com a configuração padrão, emita uma solicitação POST, como mostrado abaixo.

Cuidado: essa chamada de API substitui a configuração atual dos complementos. Você precisa incluir as configurações atuais de todos os complementos na solicitação acima para evitar que eles sejam substituídos.

Observação: a chamada de API abaixo inicia uma operação de longa duração que pode demorar para ser concluída.

curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "enabled": "true"
      }
      <Current add-ons configuration>
    }
  }'

em que <Current add-ons configuration> é a configuração atual dos complementos. Veja a configuração atual dos complementos na resposta à chamada para ver a configuração atual dos complementos. Por exemplo, se a configuração de complementos atual for

"addonsConfig": {
    "integrationConfig": {
        "enabled":"true"
     },
    "monetizationConfig": {
        "enabled":"true"
     }
  },

o comando para ativar as operações AAPI seria

curl "https://apigee.googleapis.com/v1/organizations/YOUR_ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "enabled": "true"
      },
    "integrationConfig": {
          "enabled": "true"
      },
    "monetizationConfig": {
          "enabled": "true"
      }
    }
  }'

Depois de enviar a solicitação, você verá uma resposta como esta:

{
  "name": "organizations/apigee-docs-d/operations/0718a945-76e0-4393-a456-f9929603b32c",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/apigee-docs-d",
    "state": "IN_PROGRESS"
  }
}

Desativar as operações AAPI na sua organização

Se por algum motivo você precisar desativar a segurança avançada da AAPI na sua organização, emita uma solicitação POST, transmitindo a configuração de complementos no corpo da solicitação, conforme mostrado abaixo.

Cuidado: a configuração dos complementos transmitida no corpo da solicitação substituirá a configuração atual. Veja a configuração dos complementos atuais no perfil da organização da Apigee e inclua-a no payload da solicitação.

Observação: a chamada de API abaixo inicia uma operação de longa duração que pode levar algum tempo para ser concluída.

curl "https://apigee.googleapis.com/v1/organizations/$ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "enabled": "false"
      }
     <Include current add-ons configuration>
    }
  }'

Veja a seguir um exemplo de resposta que mostra que a operação está em andamento:

{
  "name": "organizations/$ORG/operations/06274ffb-8940-41da-836d-781cba190437",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/$ORG",
    "state": "IN_PROGRESS"
  }
}

Para mais informações, consulte Configurar a API de complementos da organização.

Como funciona a detecção de anomalias

A detecção de anomalias envolve as seguintes etapas:

• Treinar modelos
• Registrar eventos de anomalias

Treinar modelos

As anomalias de operações funcionam com o treinamento de um modelo do comportamento dos proxies de API com base em dados históricos de séries temporais. Nenhuma ação é necessária de sua parte para treinar o modelo. A Apigee cria e treina modelos automaticamente para você com base nas seis horas anteriores de dados da API. Portanto, a Apigee requer no mínimo seis horas de dados em um proxy de API para treinar o modelo antes de registrar uma anomalia.

O objetivo do treinamento é melhorar a precisão do modelo, que pode ser testada em dados históricos. A maneira mais simples de testar a precisão de um modelo é calcular a taxa de erros, que é a soma dos falsos positivos e falsos negativos, dividida pelo número total de eventos previstos.

Registrar eventos de anomalias

No ambiente de execução, as anomalias de operações comparam o comportamento atual dos seus proxies de API com o comportamento previsto pelo modelo. As anomalias operacionais podem determinar, com um nível de confiança específico, quando uma métrica operacional está excedendo o valor previsto. Por exemplo, quando a taxa de erros 5xx excede a taxa prevista pelo modelo.

Quando a Apigee detecta uma anomalia, ela registra automaticamente o evento no painel de anomalias de operações. A lista de eventos exibidos no painel inclui todas as anomalias detectadas, além de alertas acionados.