Esta página se aplica à Apigee e à Apigee híbrida.
Confira a documentação da Apigee Edge.
Com os Alertas de segurança avançados de API, é possível criar alertas para eventos relacionados à segurança da API, como alterações nas pontuações de segurança ou incidentes de abuso detectado. Os alertas são criados usando o Cloud Monitoring. É possível configurar um alerta para enviar uma notificação por mensagem de texto, e-mail ou outros canais quando ele for acionado. Consulte Criar políticas de alertas de limite de métrica para mais informações sobre a criação de alertas.
Funções exigidas
Para configurar alertas e canais de notificação no Cloud Monitoring, é preciso receber os seguintes papéis:
roles/monitoring.alertPolicyEditor
roles/monitoring.notificationChannelEditor
Limitações
Para os alertas, as seguintes limitações se aplicam:
- O número máximo de políticas de alertas é 500 para todos os níveis de assinatura da Apigee.
- Os dados das métricas são armazenados por seis semanas.
- O período máximo avaliado por uma condição de limite de métrica é de 23 horas e 30 minutos.
- Pode haver um atraso de até quatro minutos a partir do momento em que um evento que aciona um alerta ocorre até o momento em que o alerta é criado e o envio de uma notificação.
Consulte Limites de alertas para uma lista completa dos limites de alertas.
As seções a seguir apresentam exemplos que mostram como criar alertas.
Exemplo: criar um alerta para uma redução na pontuação de segurança do proxy
Neste exemplo, um alerta é criado quando uma pontuação de segurança de proxy está abaixo de um limite especificado. Para criar o alerta, siga estas etapas:
Abra a página Criar política de alertas no Console do Google Cloud.
- Clique em Selecionar uma métrica.
- Desmarque Mostrar somente métricas e recursos ativos.
Observação: se não houver dados de tráfego recentes da API na sua organização, a métrica na próxima etapa não será exibida, a menos que essa opção esteja desmarcada.
- Selecione uma métrica da seguinte forma:
- Selecione Associação de ambiente do perfil de segurança da API Apigee.
- No painel aberto à direita, selecione Segurança.
- No próximo painel à direita, selecione Pontuação de segurança do proxy da API Apigee.
- Clique em Aplicar.
- (Opcional) Para restringir os dados do alerta, por exemplo, a um ambiente especificado,
crie um filtro da seguinte maneira:
- Em Adicionar filtros > Novo filtro, clique no campo Filtro e selecione um rótulo de recurso para filtrar, como env.
- No campo Comparador, selecione um comparador, como =.
- No campo Valor, selecione um valor para o rótulo do recurso, como um nome de ambiente.
Com esse filtro, um alerta só será acionado por dados que passarem na condição de filtro. Veja uma lista dos filtros disponíveis em Filtros.
- Em Transformar dados, no campo Função de janela contínua, selecione soma.
- Clique em Próxima.
- No painel Configurar gatilho do alerta, defina o seguinte:
- Em Tipos de condição, selecione Limite.
- Em Gatilho de alerta, selecione Qualquer série temporal violada.
- Em Posição do limite, selecione Abaixo do limite.
- No campo Valor do limite, insira um limite que aciona o alerta, como 600.
- Clique em Próxima.
- No campo Configurar notificações, clique no campo Canais de notificação e selecione canais, como mensagem de texto ou e-mail, para a notificação. Se você não configurou nenhum canal, clique em Gerenciar canais de notificação e adicione um ou mais canais.
- Clique em OK.
- No campo Documentação, insira qualquer texto que você queira exibir com a notificação, como uma descrição do que acionou o alerta. Por exemplo, você pode inserir "Uma pontuação de segurança caiu abaixo de 600".
- Em Nomear a política de alertas, digite um nome para a política de alertas.
- Clique em Próxima e analise os detalhes da política de alertas.
- Se estiver tudo certo, clique em Criar política para criar a política de alertas.
Exemplo: criar um alerta para aumentar o tráfego de abuso detectado para uma regra de detecção
Este exemplo mostra como criar um alerta quando o número de solicitações com tráfego de abuso detectado excede um limite especificado para qualquer regra de detecção. Para criar o alerta, siga estas etapas:
Abra a página Criar política de alertas no Console do Google Cloud.
- Clique em Selecionar uma métrica.
- Desmarque Mostrar somente métricas e recursos ativos.
Observação: se não houver dados de tráfego recentes da API na sua organização, a métrica na próxima etapa não será exibida, a menos que essa opção esteja desmarcada.
- Selecione uma métrica da seguinte forma:
- Selecione Regra de detecção de segurança da API Apigee.
- No painel aberto à direita, selecione Segurança.
- No próximo painel à direita, selecione Contagem de solicitações detectadas pela segurança da API Apigee por regra.
- Clique em Aplicar.
- (Opcional) Para restringir os dados do alerta, por exemplo, a um ambiente especificado,
crie um filtro da seguinte maneira:
- Em Adicionar filtros > Novo filtro, clique no campo Filtro e selecione um rótulo de recurso para filtrar, como env.
- No campo Comparador, selecione um comparador, como =.
- No campo Valor, selecione um valor para o rótulo do recurso, como um nome de ambiente.
Com esse filtro, um alerta só será acionado por dados que passem na condição do filtro, por exemplo, dados em um ambiente. Consulte uma lista dos filtros disponíveis em Filtros.
- Em Transformar dados, no campo Função de janela contínua, selecione soma.
- Clique em Próxima.
- No painel Configurar gatilho do alerta, defina o seguinte:
- Em Tipos de condição, selecione Limite.
- Em Gatilho de alerta, selecione Qualquer série temporal violada.
- Em Posição do limite, selecione Acima do limite.
- No campo Valor do limite, insira um limite que aciona o alerta, como 100.
- Clique em Próxima.
- No campo Configurar notificações, clique no campo Canais de notificação e selecione canais, como mensagem de texto ou e-mail, para a notificação. Se você não configurou nenhum canal, clique em Gerenciar canais de notificação e adicione um ou mais canais.
- Clique em OK.
- No campo Documentação, insira qualquer texto que você queira exibir com a notificação, como uma descrição do que acionou o alerta. Por exemplo, você pode inserir "O tráfego de abuso detectado excedeu 100 para $(resource.label.env)". Ele usa o rótulo $(resource.label.env), que exibe o ambiente com os dados que acionaram o alerta.
- Em Nomear a política de alertas, digite um nome para a política de alertas.
- Clique em Próxima e analise os detalhes da política de alertas.
- Se estiver tudo certo, clique em Criar política para criar a política de alertas.
Métricas para alertas de segurança
A tabela abaixo descreve as métricas disponíveis para a criação de alertas de segurança:
Recurso | Métrica | Descrição | Filtros compatíveis |
---|---|---|---|
Ambiente Apigee | Contagem de solicitações de segurança da API Apigee:apigee.googleapis.com/security/request_count |
Número de solicitações de API processadas pelo Advanced API Security, desde o último exemplo. | local, org, env, proxy |
Ambiente Apigee | Contagem de solicitações detectadas pela segurança da API Apigee:apigee.googleapis.com/security/detected_request_count |
Número de solicitações de API detectadas pela detecção de abuso da segurança avançada da API, desde o último exemplo. | local, org, env, proxy |
Regra de detecção de segurança da API Apigee | A segurança da API Apigee detectou a contagem de solicitações por regra:apigee.googleapis.com/security/detected_request_count_by_rule |
Número de solicitações de API detectadas pela detecção de abuso da Segurança avançada da API e agrupadas por regra de detecção desde o último exemplo. | local, org, env, proxy, detection_rule |
Incidente de segurança da API Apigee | Contagem de solicitações de incidentes de segurança da API Apigee:apigee.googleapis.com/security/incident_request_count |
Número de solicitações de API detectadas como parte de um incidente de segurança de API. Esse valor é medido uma vez por hora. | local, org, env, proxy |
Incidente de segurança da API Apigee | Contagem de solicitações de incidentes de segurança da API Apigee por regra de detecção:apigee.googleapis.com/security/incident_request_count_by_rule |
Número de solicitações de API detectadas como parte de um incidente de segurança de API agrupadas por regra de detecção. Esse valor é medido uma vez por hora. | local, org, env, incident_id, detection_rule |
Associação de ambiente do perfil de segurança da API Apigee | Pontuação de segurança de origens da API Apigee:apigee.googleapis.com/security/source_score |
Pontuação de segurança atual do proxy de API da Apigee com base na avaliação da origem de segurança da API avançada. Esse valor é medido pelo menos uma vez a cada três horas. | local, org, env, perfil |
Associação de ambiente do perfil de segurança da API Apigee | Pontuação de segurança do proxy de API da Apigee:apigee.googleapis.com/security/proxy_score |
Pontuação de segurança atual do proxy de API da Apigee com base na avaliação do proxy de segurança de APIs avançada. Esse valor é medido pelo menos uma vez a cada três horas. | local, org, env, perfil, proxy |
Associação de ambiente do perfil de segurança da API Apigee | Pontuação de segurança do objetivo da API Apigee:apigee.googleapis.com/security/target_score |
Pontuação de segurança atual do proxy de API da Apigee com base na avaliação de destino de segurança da API avançada. Esse valor é medido pelo menos uma vez a cada três horas. | local, org, env, perfil, target_server |
Associação de ambiente do perfil de segurança da API Apigee | Pontuação de segurança do ambiente da Apigee:apigee.googleapis.com/security/environment_score |
Pontuação de segurança total atual do ambiente da Apigee com base em avaliações de segurança de APIs avançadas de origens, proxies e destinos. Esse valor é medido pelo menos uma vez a cada três horas. | local, org, env, perfil |
Filtros
Rótulo de filtro | Descrição |
---|---|
localização | Local do recurso: sempre global. |
org | Nome da organização da Apigee |
env | Nome do ambiente da Apigee |
perfil | Nome do perfil de segurança da API Apigee |
proxy | Nome do proxy da API Apigee |
target_server | Nome do servidor de destino da Apigee |
detection_rule | Nome da regra de detecção de segurança da API Apigee |