Esta página aplica-se ao Apigee e ao Apigee Hybrid.
Veja a documentação do
Apigee Edge.
Os alertas de segurança avançada da API permitem-lhe criar alertas para eventos relacionados com a segurança da API, como alterações às suas classificações de segurança ou incidentes de abuso da API detetados. Cria alertas através do Cloud Monitoring. Pode configurar um alerta para lhe enviar uma notificação por mensagem de texto, email ou outros canais, quando o alerta é acionado.
Consulte o artigo Crie políticas de alerta de limite de métricas para mais informações sobre a criação de alertas e Incidentes para políticas de alerta baseadas em métricas para informações sobre a gestão de alertas gerados.
Funções necessárias
Para configurar alertas e canais de notificação no Cloud Monitoring, tem de lhe ser atribuídas as seguintes funções:
roles/monitoring.alertPolicyEditor
roles/monitoring.notificationChannelEditor
Limitações
Para os alertas, aplicam-se as seguintes limitações:
- O número máximo de políticas de alerta é 500 para todos os níveis de subscrição do Apigee.
- Os dados das métricas são armazenados durante 6 semanas.
- O período máximo durante o qual uma condição de limite de métricas é avaliada é de 23 horas e 30 minutos.
- Pode haver um atraso de até 4 minutos desde o momento em que ocorre um evento que aciona um alerta até ao momento em que o alerta é criado e é enviada uma notificação.
Consulte Limites para alertas para ver uma lista completa de limites para alertas.
As secções seguintes apresentam exemplos que mostram como criar alertas.
Exemplo: crie um alerta para uma diminuição na pontuação de segurança do proxy (avaliação de risco v1)
Este exemplo cria um alerta quando uma classificação de segurança do proxy fica abaixo de um limite especificado. Para criar o alerta, siga estes passos:
Na Google Cloud consola, aceda a Monitorização >Alertas > Políticas > Criar política de alertas.
- Clique em Selecionar uma métrica.
- Desmarque a opção Mostrar apenas recursos e métricas ativos.
Nota: se não existirem dados de tráfego da API recentes na sua organização, a métrica no passo seguinte não é apresentada, a menos que esta opção esteja desmarcada.
- Selecione uma métrica da seguinte forma:
- Selecione Apigee API Security Profile Environment Association.
- No painel apresentado à direita, selecione Segurança.
- No painel seguinte à direita, selecione Nível de segurança do proxy de API do Apigee.
- Clique em Aplicar.
- (Opcional) Para restringir os dados do alerta, por exemplo, a um ambiente especificado,
pode criar um filtro da seguinte forma:
- Em Adicionar filtros > Novo filtro, clique no campo Filtro e selecione uma etiqueta de recurso para filtrar, como env.
- No campo Comparador, selecione um comparador, como =.
- No campo Valor, selecione um valor para a etiqueta de recurso, como um nome do ambiente.
Com este filtro, um alerta só é acionado por dados que passam a condição do filtro. Consulte Filtros para ver uma lista dos filtros disponíveis.
- Em Transformar dados, no campo Função de período móvel, selecione soma.
- Clicar em Seguinte.
- No painel Configurar acionador de alerta, defina o seguinte:
- Em Tipos de condições, selecione Limite.
- Em Acionador de alerta, selecione Qualquer série temporal viola.
- Em Posição do limite, selecione Abaixo do limite.
- No campo Valor limite, introduza um limite que acione o alerta, como 600.
- Clicar em Seguinte.
- No campo Configurar notificações, clique no campo Canais de notificação e selecione canais, como mensagem de texto ou email, para a notificação. Se não tiver configurado nenhum canal, clique em Gerir canais de notificação e adicione um ou mais canais.
- Clique em OK.
- No campo Documentação, introduza qualquer texto que queira enviar com a notificação, como uma descrição do que acionou o alerta. Por exemplo, pode introduzir "A pontuação de segurança ficou abaixo de 600."
- Em Nomeie a política de alerta, introduza um nome para a política de alerta.
- Clique em Seguinte e reveja os detalhes da política de alertas.
- Se estiver tudo correto, clique em Criar política para criar a política de alerta.
Exemplo: crie um alerta para o aumento do tráfego de abuso detetado para uma regra de deteção
Este exemplo mostra como criar um alerta quando o número de pedidos com tráfego de abuso detetado excede um limite especificado para qualquer regra de deteção. Para criar o alerta, siga estes passos:
Na Google Cloud consola, aceda a Monitorização >Alertas > Políticas > Criar política de alertas.
Aceder a Criar política de alertas
- Clique em Selecionar uma métrica.
- Desmarque a opção Mostrar apenas recursos e métricas ativos.
Nota: se não existirem dados de tráfego da API recentes na sua organização, a métrica no passo seguinte não é apresentada, a menos que esta opção seja desmarcada.
- Selecione uma métrica da seguinte forma:
- Selecione Regra de deteção de segurança de API da Apigee.
- No painel apresentado à direita, selecione Segurança.
- No painel seguinte à direita, selecione Apigee API Security detected request count by rule (Apigee API Security: número de pedidos detetados por regra).
- Clique em Aplicar.
- (Opcional) Para restringir os dados do alerta, por exemplo, a um ambiente especificado,
pode criar um filtro da seguinte forma:
- Em Adicionar filtros > Novo filtro, clique no campo Filtro e selecione uma etiqueta de recurso para filtrar, como env.
- No campo Comparador, selecione um comparador, como =.
- No campo Valor, selecione um valor para a etiqueta de recurso, como um nome do ambiente.
Com este filtro, um alerta só é acionado por dados que passam a condição do filtro, como dados num ambiente. Consulte Filtros para ver uma lista dos filtros disponíveis.
- Em Transformar dados, no campo Função de período móvel, selecione soma.
- Clicar em Seguinte.
- No painel Configurar acionador de alerta, defina o seguinte:
- Em Tipos de condições, selecione Limite.
- Em Acionador de alerta, selecione Qualquer série temporal viola.
- Em Posição do limite, selecione Acima do limite.
- No campo Valor do limite, introduza um limite que acione o alerta, como 100.
- Clicar em Seguinte.
- No campo Configurar notificações, clique no campo Canais de notificação e selecione canais, como mensagem de texto ou email, para a notificação. Se não tiver configurado nenhum canal, clique em Gerir canais de notificação e adicione um ou mais canais.
- Clique em OK.
- No campo Documentação, introduza qualquer texto que queira enviar com a notificação, como uma descrição do que acionou o alerta. Por exemplo, pode introduzir "O tráfego de abuso detetado excedeu 100 para $(resource.label.env)." Isto usa a etiqueta $(resource.label.env), que apresenta o ambiente cujos dados acionaram o alerta.
- Em Nomeie a política de alerta, introduza um nome para a política de alerta.
- Clique em Seguinte e reveja os detalhes da política de alertas.
- Se estiver tudo correto, clique em Criar política para criar a política de alerta.
Exemplo: crie um alerta de monitorização da condição de monitorização da avaliação de risco (avaliação de risco v2)
Este exemplo cria uma nova política de alertas do Cloud Monitoring para uma condição de monitorização de avaliação de risco que envia um alerta se a pontuação de segurança em qualquer um dos respetivos proxies monitorizados ficar abaixo de um determinado limite.
- Crie uma condição de monitorização.
- Siga as instruções em Crie um alerta de monitorização para criar um novo alerta de monitorização. O Apigee pré-preenche alguns campos por si quando a página é carregada.
- Se quiser, pode alterar as definições para personalizar a política de alertas. Siga as orientações em Crie uma política de alertas. Tem de indicar um nome para a política de alerta.
- Clique em Criar política para guardar a nova política de alertas.
Métricas para alertas de segurança
A tabela abaixo descreve as métricas disponíveis para criar alertas de segurança:
Recurso | Métrica | Descrição | Filtros suportados |
---|---|---|---|
Ambiente do Apigee | Número de pedidos de segurança da API Apigee:apigee.googleapis.com/security/request_count |
Número de pedidos de API processados pela segurança avançada da API desde a última amostra. | location, org, env, proxy |
Ambiente do Apigee | Número de pedidos detetados pela segurança da API Apigee:apigee.googleapis.com/security/detected_request_count |
Número de pedidos de API detetados pela deteção de abuso da segurança avançada da API desde a última amostra. | location, org, env, proxy |
Regra de deteção de segurança da API Apigee | Número de pedidos detetados pela segurança da API Apigee por regra:apigee.googleapis.com/security/detected_request_count_by_rule |
Número de pedidos da API detetados pela deteção de abusos da segurança avançada da API e agrupados por regra de deteção desde a última amostra. | location, org, env, proxy, detection_rule |
Incidente de segurança da API Apigee | Número de pedidos de incidentes de segurança da API Apigee:apigee.googleapis.com/security/incident_request_count |
Número de pedidos de API detetados como parte de um incidente de segurança de API. Este valor é medido uma vez por hora. | location, org, env, proxy |
Incidente de segurança da API Apigee | Número de pedidos de incidentes de segurança da API Apigee por regra de deteção:apigee.googleapis.com/security/incident_request_count_by_rule |
Número de pedidos API detetados como parte de um incidente de segurança da API agrupados por regra de deteção. Este valor é medido uma vez por hora. | location, org, env, incident_id, detection_rule |
Apigee API Security Profile Environment Association | Pontuação de segurança das origens de APIs do Apigee:apigee.googleapis.com/security/source_score |
Aplica-se à avaliação de risco v1. Pontuação de segurança atual do proxy de API Apigee com base na avaliação da origem da segurança avançada da API. Este valor é medido, pelo menos, uma vez a cada 3 horas. | location, org, env, profile |
Apigee API Security Profile Environment Association | Pontuação de segurança do proxy de API Apigee:apigee.googleapis.com/security/proxy_score |
Aplica-se à avaliação de risco v1. Pontuação de segurança atual do proxy de API do Apigee com base na avaliação do proxy de segurança avançada da API. Este valor é medido, pelo menos, uma vez a cada 3 horas. | location, org, env, profile, proxy |
Apigee API Security Profile Environment Association | Pontuação de segurança do destino da API Apigee:apigee.googleapis.com/security/target_score |
Aplica-se à avaliação de risco v1. Classificação de segurança atual do proxy de API do Apigee com base na avaliação de destino da segurança avançada da API. Este valor é medido, pelo menos, uma vez a cada 3 horas. | location, org, env, profile, target_server |
Apigee API Security Profile Environment Association | Pontuação de segurança do ambiente do Apigee:apigee.googleapis.com/security/environment_score |
Aplica-se à avaliação de risco v1. Pontuação de segurança total atual do ambiente do Apigee com base nas avaliações de segurança avançada de APIs de origens, proxies e destinos. Este valor é medido, pelo menos, uma vez a cada 3 horas. | location, org, env, profile |
Apigee API Security Assessment Result | Pontuação de segurança:apigee.googleapis.com/security/score |
Aplica-se à avaliação de risco v2. Pontuação de segurança atual de um recurso implementado com base num perfil de segurança. | location, org, scope, resource, security_profile |
Filtros
Etiqueta do filtro | Descrição |
---|---|
localização | Localização do recurso: sempre global. |
org | Nome da organização Apigee |
env | Nome do ambiente Apigee |
perfil | Nome do perfil de segurança da API Apigee |
proxy | Nome do proxy de API Apigee |
target_server | Nome do servidor de destino do Apigee |
detection_rule | Nome da regra de deteção de segurança da API Apigee |
âmbito | Para a avaliação de risco v2, identificador do âmbito associado ao recurso avaliado. |
recurso | Para a avaliação de risco v2, identificador do recurso avaliado. |
security_profile | Para a avaliação de risco v2, identificador do perfil de segurança usado para avaliar o recurso. |