Ferramenta: get_alert_policy
Use essa ferramenta como a principal para receber informações sobre uma política de alertas específica. As políticas de alertas definem as condições em que você quer ser notificado sobre problemas com seus serviços. Isso é útil para entender os detalhes de uma configuração de alerta específica.
O exemplo a seguir demonstra como usar curl para invocar a ferramenta get_alert_policy MCP.
| Solicitação curl |
|---|
curl --location 'https://monitoring.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "get_alert_policy", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
Esquema de entrada
O protocolo da solicitação GetAlertPolicy.
GetAlertPolicyRequest
| Representação JSON |
|---|
{ "name": string } |
| Campos | |
|---|---|
name |
Obrigatório. A política de alertas a ser recuperada. O formato é: |
Esquema de saída
Uma descrição das condições em que algum aspecto do seu sistema é considerado "não íntegro" e as formas de notificar pessoas ou serviços sobre esse estado. Para uma visão geral das políticas de alertas, consulte Introdução a alertas.
AlertPolicy
| Representação JSON |
|---|
{ "name": string, "displayName": string, "documentation": { object ( |
| Campos | |
|---|---|
name |
Identificador. Obrigatório se a política existir. O nome do recurso para esta política. O formato é:
|
displayName |
Um nome curto ou frase usada para identificar a política em painéis, notificações e incidentes. Para evitar confusão, não use o mesmo nome de exibição para várias políticas no mesmo projeto. O nome é limitado a 512 caracteres Unicode. A convenção para o display_name de uma PrometheusQueryLanguageCondition é "{nome do grupo de regras}/{nome do alerta}", em que {nome do grupo de regras} e {nome do alerta} são extraídos do arquivo de configuração correspondente do Prometheus. Essa convenção não é aplicada. Em qualquer caso, o display_name não é uma chave exclusiva da AlertPolicy. |
documentation |
Documentação incluída com notificações e incidentes relacionados a essa política. A prática recomendada é que a documentação inclua informações para ajudar os responsáveis pela resposta a entender, reduzir, encaminhar e corrigir os problemas detectados pela política de alertas. Os canais de notificação com capacidade limitada podem não mostrar essa documentação. |
userLabels |
Dados de chave/valor fornecidos pelo usuário para organizar e identificar os objetos O campo pode conter até 64 entradas. Cada chave e valor é limitado a 63 caracteres Unicode ou 128 bytes, o que for menor. Os rótulos e valores podem conter apenas letras minúsculas, numerais, sublinhados e traços. As chaves precisam começar com uma letra. Observe que {nome do alerta} do Prometheus é um nome de rótulo válido do Prometheus, enquanto {grupo de regras} do Prometheus é uma string UTF-8 sem restrições. Isso significa que eles não podem ser armazenados como estão em rótulos de usuário, porque podem conter caracteres não permitidos nos valores de rótulo de usuário. Um objeto com uma lista de pares |
conditions[] |
Uma lista de condições para a política. As condições são combinadas por "E" ou "OU" de acordo com o campo |
combiner |
Como combinar os resultados de várias condições para determinar se um incidente deve ser aberto. Se |
enabled |
Se a política está ativada ou não. Na gravação, a interpretação padrão se não for definida é que a política está ativada. Na leitura, os clientes não devem fazer nenhuma suposição sobre o estado se ele não tiver sido preenchido. O campo sempre precisa ser preenchido nas operações "List" e "Get", a menos que uma projeção de campo tenha sido especificada para removê-lo. |
validity |
Descrição somente leitura de como a política de alertas é inválida. Esse campo só é definido quando a política de alertas é inválida. Uma política de alertas inválida não gera incidentes. |
notificationChannels[] |
Identifica os canais de notificação para os quais as notificações devem ser enviadas quando incidentes são abertos ou fechados ou quando novas violações ocorrem em um incidente já aberto. Cada elemento dessa matriz corresponde ao campo |
creationRecord |
Um registro somente leitura da criação da política de alertas. Se fornecido em uma chamada para criar ou atualizar, esse campo será ignorado. |
mutationRecord |
Um registro somente leitura da mudança mais recente na política de alertas. Se fornecido em uma chamada para criar ou atualizar, esse campo será ignorado. |
alertStrategy |
Controla como os canais de notificação dessa política de alertas são notificados. |
severity |
Opcional. A gravidade de uma política de alertas indica a importância dos incidentes gerados por ela. O nível de gravidade será exibido na página de detalhes do incidente e nas notificações. |
Documentação
| Representação JSON |
|---|
{
"content": string,
"mimeType": string,
"subject": string,
"links": [
{
object ( |
| Campos | |
|---|---|
content |
O corpo da documentação, interpretado de acordo com |
mimeType |
O formato do campo |
subject |
Opcional. A linha de assunto da notificação. A linha de assunto não pode exceder 10.240 bytes. Nas notificações geradas por essa política, o conteúdo da linha de assunto após a expansão da variável será truncado para 255 bytes ou menos no limite de caracteres UTF-8 mais recente. O limite de 255 bytes é recomendado nesta conversa. É o limite imposto por alguns produtos de emissão de passagens de terceiros, e é comum definir campos de texto em bancos de dados como VARCHAR(255). O conteúdo da linha de assunto pode ser transformado em modelo usando variáveis. Se esse campo estiver ausente ou vazio, uma linha de assunto padrão será gerada. |
links[] |
Opcional. Links para conteúdo como playbooks, repositórios e outros recursos. Esse campo pode conter até três entradas. |
Link
| Representação JSON |
|---|
{ "displayName": string, "url": string } |
| Campos | |
|---|---|
displayName |
Um nome de exibição curto para o link. O nome de exibição não pode estar em branco nem ter mais de 63 caracteres. Exemplo: "playbook". |
url |
O URL de uma página da Web. É possível criar um modelo de URL usando variáveis no caminho ou nos parâmetros de consulta. O tamanho total de um URL não pode exceder 2.083 caracteres antes e depois da expansão da variável. Exemplo: "https://my_domain.com/playbook?name=${resource.name}" |
UserLabelsEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
Condição
| Representação JSON |
|---|
{ "name": string, "displayName": string, // Union field |
| Campos | |
|---|---|
name |
Obrigatório se a condição existir. O nome de recurso exclusivo para essa condição. O formato é:
Ao chamar o método Ao chamar o método A prática recomendada é preservar |
displayName |
Um nome curto ou uma frase usada para identificar a condição em painéis, notificações e incidentes. Para evitar confusão, não use o mesmo nome de exibição para várias condições na mesma política. |
Campo de união condition. Apenas um dos seguintes tipos de condição será especificado. condition pode ser apenas de um dos tipos a seguir: |
|
conditionThreshold |
Uma condição que compara uma série temporal com um limite. |
conditionAbsent |
Uma condição que verifica se uma série temporal continua recebendo novos pontos de dados. |
conditionMatchedLog |
Uma condição que verifica mensagens de registro correspondentes a restrições específicas. Se definido, nenhuma outra condição pode estar presente. |
conditionMonitoringQueryLanguage |
Uma condição que usa a linguagem de consulta do Monitoring para definir alertas. |
conditionPrometheusQueryLanguage |
Uma condição que usa a linguagem de consulta do Prometheus para definir alertas. |
conditionSql |
Uma condição que avalia periodicamente o resultado de uma consulta SQL. |
MetricThreshold
| Representação JSON |
|---|
{ "filter": string, "aggregations": [ { object ( |
| Campos | |
|---|---|
filter |
Obrigatório. Um filtro que identifica qual série temporal deve ser comparada com o limite. O filtro é semelhante ao especificado na solicitação |
aggregations[] |
Especifica o alinhamento dos pontos de dados em série temporal individuais, bem como a forma de combinar as série temporal recuperadas (por exemplo, ao agregar vários fluxos em cada recurso em um único fluxo para cada recurso ou ao agregar fluxos em todos os membros de um grupo de recursos). Várias agregações são aplicadas na ordem especificada. Esse campo é semelhante ao da |
denominatorFilter |
Um filtro que identifica uma série temporal a ser usada como denominador de uma proporção que será comparada com o limite. Se um O filtro precisa especificar o tipo de métrica e pode conter restrições sobre o tipo de recurso, os rótulos de recursos e os rótulos de métricas. Esse campo não pode ter mais de 2.048 caracteres Unicode. |
denominatorAggregations[] |
Especifica o alinhamento dos pontos de dados em série temporal individuais selecionadas por Ao calcular proporções, os campos |
forecastOptions |
Quando esse campo está presente, a condição |
comparison |
A comparação a ser aplicada entre as séries temporais (indicadas por No momento, apenas |
thresholdValue |
Um valor para comparar a série temporal. |
duration |
Obrigatório. O período em que uma série temporal precisa violar o limite para ser considerada com falha. No momento, apenas valores múltiplos de um minuto (por exemplo, 0, 60, 120 ou 300 segundos) são aceitos. Se um valor inválido for fornecido, um erro será retornado. Ao escolher uma duração, é útil ter em mente a frequência dos dados de série temporal subjacentes (que também pode ser afetada por alinhamentos especificados no campo Duração em segundos com até nove dígitos fracionários, terminando em " |
trigger |
O número/porcentagem de série temporal para as quais a comparação precisa ser válida para que a condição seja acionada. Se não for especificado, a condição será acionada se a comparação for verdadeira para qualquer uma das série temporal identificadas por |
evaluationMissingData |
Um controle de condição que determina como as condições de limite de métrica são avaliadas quando os dados param de chegar. Para usar esse controle, o valor do campo |
Agregação
| Representação JSON |
|---|
{ "alignmentPeriod": string, "perSeriesAligner": enum ( |
| Campos | |
|---|---|
alignmentPeriod |
O O valor precisa ser de pelo menos 60 segundos. Se um alinhador por série diferente de O valor máximo de Duração em segundos com até nove dígitos fracionários, terminando em " |
perSeriesAligner |
Um Nem todas as operações de alinhamento podem ser aplicadas a todas as série temporal. As opções válidas dependem do Os dados de série temporal precisam ser alinhados para que seja possível realizar a redução entre séries temporais. Se |
crossSeriesReducer |
A operação de redução a ser usada para combinar séries temporais em uma única série, em que o valor de cada ponto de dados na série resultante é uma função de todos os valores já alinhados na série temporal de entrada. Nem todas as operações de redução podem ser aplicadas a todas as série temporal. As opções válidas dependem do Os dados de série temporal precisam ser alinhados primeiro (consulte |
groupByFields[] |
O conjunto de campos a serem preservados quando |
Duração
| Representação JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Campos | |
|---|---|
seconds |
Segundos assinados do período. Precisa estar entre -315.576.000.000 e +315.576.000.000 (inclusive). Observação: esses limites são calculados da seguinte forma: 60 s/min * 60 min/h * 24 h/dia * 365,25 dias/ano * 10.000 anos |
nanos |
Frações assinadas de um segundo com resolução de nanossegundos do período. Durações menores que um segundo são representadas com um campo |
ForecastOptions
| Representação JSON |
|---|
{ "forecastHorizon": string } |
| Campos | |
|---|---|
forecastHorizon |
Obrigatório. O período de tempo no futuro para prever se uma série temporal vai violar o limite. Se o valor previsto violar o limite e a violação for observada em todas as previsões feitas para o Duração em segundos com até nove dígitos fracionários, terminando em " |
Gatilho
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união type. Um tipo de gatilho. type pode ser apenas de um dos tipos a seguir: |
|
count |
O número absoluto de série temporal que precisam falhar na condição para que ela seja acionada. |
percent |
A porcentagem de série temporal que precisam falhar no predicado para que a condição seja acionada. |
MetricAbsence
| Representação JSON |
|---|
{ "filter": string, "aggregations": [ { object ( |
| Campos | |
|---|---|
filter |
Obrigatório. Um filtro que identifica qual série temporal deve ser comparada com o limite. O filtro é semelhante ao especificado na solicitação |
aggregations[] |
Especifica o alinhamento dos pontos de dados em série temporal individuais, bem como a forma de combinar as série temporal recuperadas (por exemplo, ao agregar vários fluxos em cada recurso em um único fluxo para cada recurso ou ao agregar fluxos em todos os membros de um grupo de recursos). Várias agregações são aplicadas na ordem especificada. Esse campo é semelhante ao da |
duration |
Obrigatório. O período em que uma série temporal precisa deixar de informar novos dados para ser considerada com falha. O valor mínimo desse campo é de 120 segundos. Valores maiores que sejam múltiplos de um minuto, por exemplo, 240 ou 300 segundos, são aceitos. Se um valor inválido for fornecido, um erro será retornado. Duração em segundos com até nove dígitos fracionários, terminando em " |
trigger |
O número/porcentagem de série temporal para as quais a comparação precisa ser válida para que a condição seja acionada. Se não for especificado, a condição será acionada se a comparação for verdadeira para qualquer uma das série temporal identificadas por |
LogMatch
| Representação JSON |
|---|
{ "filter": string, "labelExtractors": { string: string, ... } } |
| Campos | |
|---|---|
filter |
Obrigatório. Um filtro com base em registros. Consulte Consultas de registros avançadas para saber como esse filtro deve ser criado. |
labelExtractors |
Opcional. Um mapa de uma chave do rótulo para uma expressão extratora, que é usada para extrair o valor dessa chave do rótulo. Cada entrada nesse mapa é uma especificação de como os dados devem ser extraídos das entradas de registro que correspondem a Consulte a documentação sobre Um objeto com uma lista de pares |
LabelExtractorsEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
MonitoringQueryLanguageCondition
| Representação JSON |
|---|
{ "query": string, "duration": string, "trigger": { object ( |
| Campos | |
|---|---|
query |
Consulta da linguagem de consulta do Monitoring que gera um fluxo booleano. |
duration |
Opcional. O período em que uma série temporal precisa violar o limite para ser considerada com falha. No momento, apenas valores múltiplos de um minuto (por exemplo, 0, 60, 120 ou 300 segundos) são aceitos. Se um valor inválido for fornecido, um erro será retornado. Ao escolher uma duração, é útil ter em mente a frequência dos dados de série temporal subjacentes (que também pode ser afetada por alinhamentos especificados no campo Duração em segundos com até nove dígitos fracionários, terminando em " |
trigger |
O número/porcentagem de série temporal para as quais a comparação precisa ser válida para que a condição seja acionada. Se não for especificado, a condição será acionada se a comparação for verdadeira para qualquer uma das série temporal identificadas por |
evaluationMissingData |
Um controle de condição que determina como as condições de limite de métrica são avaliadas quando os dados param de chegar. |
PrometheusQueryLanguageCondition
| Representação JSON |
|---|
{ "query": string, "duration": string, "evaluationInterval": string, "labels": { string: string, ... }, "ruleGroup": string, "alertRule": string, "disableMetricValidation": boolean } |
| Campos | |
|---|---|
query |
Obrigatório. A expressão PromQL a ser avaliada. Em cada ciclo de avaliação, essa expressão é avaliada no momento atual, e todas as série temporal resultantes se tornam alertas pendentes/acionados. Este campo não pode ficar em branco. |
duration |
Opcional. Os alertas são considerados disparados quando a expressão PromQL é avaliada como "true" por esse tempo. Os alertas cuja expressão PromQL não foi avaliada como "true" por tempo suficiente são considerados pendentes. Precisa ser uma duração não negativa ou estar ausente. Este campo é opcional. O valor padrão é zero. Duração em segundos com até nove dígitos fracionários, terminando em " |
evaluationInterval |
Opcional. Com que frequência essa regra precisa ser avaliada. Precisa ser um múltiplo positivo de 30 segundos ou estar ausente. Este campo é opcional. O valor padrão é de 30 segundos. Se essa PrometheusQueryLanguageCondition foi gerada de uma regra de alerta do Prometheus, esse valor será extraído do grupo de regras envolvido. Duração em segundos com até nove dígitos fracionários, terminando em " |
labels |
Opcional. Rótulos a serem adicionados ou substituídos no resultado da consulta PromQL. Os nomes dos rótulos precisam ser válidos. Os valores de rótulo podem ser transformados em modelos usando variáveis. Os únicos nomes de variáveis disponíveis são os nomes dos rótulos no resultado do PromQL, incluindo "__name__" e "value". "labels" pode estar vazio. Um objeto com uma lista de pares |
ruleGroup |
Opcional. O nome do grupo de regras desse alerta no arquivo de configuração correspondente do Prometheus. Algumas ferramentas externas exigem que esse campo seja preenchido corretamente para se referir ao arquivo de configuração original do Prometheus. O nome do grupo de regras e o nome do alerta são necessários para atualizar as AlertPolicies relevantes caso a definição do grupo de regras mude no futuro. Este campo é opcional. Se esse campo não estiver vazio, ele precisará conter uma string UTF-8 válida. Esse campo não pode ter mais de 2.048 caracteres Unicode. |
alertRule |
Opcional. O nome da regra de alerta deste alerta no arquivo de configuração correspondente do Prometheus. Algumas ferramentas externas exigem que esse campo seja preenchido corretamente para se referir ao arquivo de configuração original do Prometheus. O nome do grupo de regras e o nome do alerta são necessários para atualizar as AlertPolicies relevantes caso a definição do grupo de regras mude no futuro. Este campo é opcional. Se esse campo não estiver vazio, ele precisará ser um nome de rótulo do Prometheus válido. Esse campo não pode ter mais de 2.048 caracteres Unicode. |
disableMetricValidation |
Opcional. Indica se a validação da existência de métricas deve ser desativada para essa condição. Isso permite que as políticas de alerta sejam definidas em métricas que ainda não existem, melhorando fluxos de trabalho avançados do cliente, como a configuração de políticas de alerta usando o Terraform. Os usuários com a função |
LabelsEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
SqlCondition
| Representação JSON |
|---|
{ "query": string, // Union field |
| Campos | |
|---|---|
query |
Obrigatório. A consulta SQL da Análise de dados de registros a ser executada, como uma string. A consulta precisa estar em conformidade com o formato exigido. Especificamente, a consulta não pode tentar filtrar a entrada por tempo. Um filtro será aplicado automaticamente para filtrar a entrada e garantir que a consulta receba todas as linhas desde a última execução. Por exemplo, a consulta a seguir extrai todas as entradas de registro que contêm uma solicitação HTTP: |
Campo de união schedule. A programação indica a frequência de execução da consulta. schedule pode ser apenas de um dos tipos a seguir: |
|
minutes |
Programe a execução da consulta a cada tantos minutos. |
hourly |
Programe a execução da consulta a cada tantas horas. |
daily |
Programe a execução da consulta a cada tantos dias. |
Campo de união evaluate. O teste a ser executado no conjunto de resultados do SQL. evaluate pode ser apenas de um dos tipos a seguir: |
|
rowCountTest |
Teste a contagem de linhas em relação a um limite. |
booleanTest |
Teste o valor booleano na coluna indicada. |
Minutos
| Representação JSON |
|---|
{ "periodicity": integer } |
| Campos | |
|---|---|
periodicity |
Obrigatório. Número de minutos entre as execuções. O intervalo precisa ser maior ou igual a 5 minutos e menor ou igual a 1.440 minutos. |
Por hora
| Representação JSON |
|---|
{ "periodicity": integer, // Union field |
| Campos | |
|---|---|
periodicity |
Obrigatório. O número de horas entre as execuções. Precisa ser maior ou igual a 1 hora e menor ou igual a 48 horas. |
Campo de união
|
|
minuteOffset |
Opcional. O número de minutos após a hora (em UTC) para executar a consulta. Precisa ser maior ou igual a 0 minuto e menor ou igual a 59 minutos. Se não for especificado, um deslocamento arbitrário será usado. |
Diariamente
| Representação JSON |
|---|
{
"periodicity": integer,
"executionTime": {
object ( |
| Campos | |
|---|---|
periodicity |
Obrigatório. O número de dias entre as execuções. Precisa ser maior ou igual a 1 dia e menor ou igual a 31 dias. |
executionTime |
Opcional. A hora do dia (em UTC) em que a consulta deve ser executada. Se não for especificado, o servidor vai escolher um horário arbitrário e executar a consulta no mesmo horário todos os dias. |
TimeOfDay
| Representação JSON |
|---|
{ "hours": integer, "minutes": integer, "seconds": integer, "nanos": integer } |
| Campos | |
|---|---|
hours |
Horas de um dia no formato de 24 horas. Precisa ser maior ou igual a 0 e geralmente menor ou igual a 23. Uma API pode permitir o valor "24:00:00" para o horário de fechamento da empresa, por exemplo. |
minutes |
Minutos de uma hora. Precisa ser maior ou igual a 0 e menor ou igual a 59. |
seconds |
Segundos de um minuto. Precisa ser maior ou igual a 0 e normalmente menor ou igual a 59. Uma API pode permitir o valor 60 se permitir segundos bissextos. |
nanos |
Frações de segundos, em nanossegundos. Precisa ser maior ou igual a 0 e menor ou igual a 999.999.999. |
RowCountTest
| Representação JSON |
|---|
{
"comparison": enum ( |
| Campos | |
|---|---|
comparison |
Obrigatório. A comparação a ser aplicada entre o número de linhas retornadas pela consulta e o limite. |
threshold |
Obrigatório. O valor com que comparar a contagem de linhas. |
BooleanTest
| Representação JSON |
|---|
{ "column": string } |
| Campos | |
|---|---|
column |
Obrigatório. O nome da coluna que contém o valor booleano. Se o valor em uma linha for NULL, ela será ignorada. |
BoolValue
| Representação JSON |
|---|
{ "value": boolean } |
| Campos | |
|---|---|
value |
O valor booleano. |
Status
| Representação JSON |
|---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
| Campos | |
|---|---|
code |
O código de status, que precisa ser um valor de enumeração de |
message |
Uma mensagem de erro em inglês para o desenvolvedor. Qualquer mensagem de erro para o usuário precisa ser localizada e enviada no campo |
details[] |
Uma lista de mensagens com os detalhes do erro. Há um conjunto comum de tipos de mensagens para as APIs usarem. Um objeto contendo campos de um tipo arbitrário. Um campo adicional |
Qualquer
| Representação JSON |
|---|
{ "typeUrl": string, "value": string } |
| Campos | |
|---|---|
typeUrl |
Identifica o tipo da mensagem Protobuf serializada com uma referência de URI que consiste em um prefixo que termina em uma barra e o nome de tipo totalmente qualificado. Exemplo: type.googleapis.com/google.protobuf.StringValue Essa string precisa conter pelo menos um caractere O prefixo é arbitrário, e as implementações do Protobuf devem remover tudo até o último Todas as strings de URL de tipo precisam ser referências de URI válidas com a restrição adicional (para o formato de texto) de que o conteúdo da referência deve consistir apenas em caracteres alfanuméricos, escapes codificados por porcentagem e caracteres no seguinte conjunto (sem incluir as crases externas): No design original do |
value |
Contém uma serialização Protobuf do tipo descrito por type_url. Uma string codificada em base64. |
MutationRecord
| Representação JSON |
|---|
{ "mutateTime": string, "mutatedBy": string } |
| Campos | |
|---|---|
mutateTime |
Quando a mudança ocorreu. Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: |
mutatedBy |
O endereço de e-mail do usuário que fez a mudança. |
Carimbo de data/hora
| Representação JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Campos | |
|---|---|
seconds |
Representa os segundos do horário UTC desde a época Unix 1970-01-01T00:00:00Z. Precisa estar entre -62135596800 e 253402300799 (o que corresponde a 0001-01-01T00:00:00Z a 9999-12-31T23:59:59Z). |
nanos |
Frações não negativas de um segundo com resolução de nanossegundos. Esse campo é a parte de nanossegundos da duração, não uma alternativa aos segundos. Os valores de segundos negativos com frações ainda precisam ter valores em nanossegundos não negativos que representam períodos posteriores. O valor precisa estar entre 0 e 999.999.999 (inclusive). |
AlertStrategy
| Representação JSON |
|---|
{ "notificationRateLimit": { object ( |
| Campos | |
|---|---|
notificationRateLimit |
Obrigatório para políticas de alertas com base em registros, ou seja, políticas com uma condição Esse limite não é implementado para políticas de alertas que não têm uma condição LogMatch. |
notificationPrompts[] |
Para políticas de alertas com base em registros, o tipo de notificação é sempre [OPENED]. Para políticas de alertas que não são baseadas em registros, os comandos de notificação podem ser [OPENED] ou [OPENED, CLOSED]. |
autoClose |
Se uma política de alertas ativa não tiver dados por esse período, todos os incidentes abertos serão encerrados. Duração em segundos com até nove dígitos fracionários, terminando em " |
notificationChannelStrategy[] |
Controlar como as notificações serão enviadas, canal por canal. |
NotificationRateLimit
| Representação JSON |
|---|
{ "period": string } |
| Campos | |
|---|---|
period |
Não mais de uma notificação por Duração em segundos com até nove dígitos fracionários, terminando em " |
NotificationChannelStrategy
| Representação JSON |
|---|
{ "notificationChannelNames": [ string ], "renotifyInterval": string } |
| Campos | |
|---|---|
notificationChannelNames[] |
O nome completo do recurso REST dos canais de notificação a que essas configurações se aplicam. Cada um deles corresponde ao campo "name" em um dos objetos "NotificationChannel" referenciados no campo "notification_channels" desta AlertPolicy. O formato é: |
renotifyInterval |
A frequência com que as notificações de lembrete para incidentes abertos são enviadas. O valor precisa estar entre 30 minutos e 24 horas. Duração em segundos com até nove dígitos fracionários, terminando em " |
Alinhador
O Aligner especifica a operação que será aplicada aos pontos de dados em cada período de alinhamento de uma série temporal. Exceto ALIGN_NONE, que especifica que nenhuma operação seja aplicada, cada operação de alinhamento substitui o conjunto de valores de dados em cada período de alinhamento por um único valor: o resultado da aplicação da operação aos valores de dados. Uma série temporal alinhada tem um único valor de dados no final de cada alignment_period.
Uma operação de alinhamento também pode mudar o tipo de dados dos valores. Por exemplo, se você aplicar uma operação de contagem a valores booleanos, os dados value_type na série temporal original serão BOOLEAN, mas o value_type no resultado alinhado será INT64.
| Tipos enumerados | |
|---|---|
ALIGN_NONE |
Nenhum alinhamento. Os dados brutos são retornados. Não é válido se a redução entre séries for solicitada. O value_type do resultado é o mesmo que o value_type da entrada. |
ALIGN_DELTA |
Alinhe e converta para Esse alinhamento é válido para as métricas |
ALIGN_RATE |
Alinhe e converta em uma taxa. O resultado é calculado como Esse alinhador é válido para métricas Se você se refere a "taxa" como "mudança percentual", use o |
ALIGN_INTERPOLATE |
Alinhe por interpolação entre pontos adjacentes em torno do limite do período de alinhamento. Esse alinhador é válido para métricas GAUGE com valores numéricos. O value_type do resultado alinhado é o mesmo que o value_type da entrada. |
ALIGN_NEXT_OLDER |
Alinhe movendo o ponto de dados mais recente antes do final do período de alinhamento para o limite no final do período de alinhamento. Esse alinhador é válido para GAUGE métricas. O value_type do resultado alinhado é o mesmo que o value_type da entrada. |
ALIGN_MIN |
Alinhe a série temporal retornando o valor mínimo em cada período de alinhamento. Esse alinhador é válido para métricas GAUGE e DELTA com valores numéricos. O value_type do resultado alinhado é o mesmo que o value_type da entrada. |
ALIGN_MAX |
Alinhe a série temporal retornando o valor máximo em cada período de alinhamento. Esse alinhador é válido para métricas GAUGE e DELTA com valores numéricos. O value_type do resultado alinhado é o mesmo que o value_type da entrada. |
ALIGN_MEAN |
Alinhe a série temporal retornando o valor médio em cada período de alinhamento. Esse alinhador é válido para métricas GAUGE e DELTA com valores numéricos. O value_type do resultado alinhado é DOUBLE. |
ALIGN_COUNT |
Alinhe a série temporal retornando o número de valores em cada período de alinhamento. Esse alinhador é válido para métricas GAUGE e DELTA com valores numéricos ou booleanos. O value_type do resultado alinhado é INT64. |
ALIGN_SUM |
Alinhe a série temporal retornando a soma dos valores em cada período de alinhamento. Esse alinhador é válido para métricas GAUGE e DELTA com valores numéricos e de distribuição. O value_type do resultado alinhado é o mesmo que o value_type da entrada. |
ALIGN_STDDEV |
Alinhe a série temporal retornando o desvio padrão dos valores em cada período de alinhamento. Esse alinhador é válido para métricas GAUGE e DELTA com valores numéricos. O value_type da saída é DOUBLE. |
ALIGN_COUNT_TRUE |
Alinhe a série temporal retornando o número de valores True em cada período de alinhamento. Esse alinhador é válido para métricas GAUGE com valores booleanos. O value_type da saída é INT64. |
ALIGN_COUNT_FALSE |
Alinhe a série temporal retornando o número de valores False em cada período de alinhamento. Esse alinhador é válido para métricas GAUGE com valores booleanos. O value_type da saída é INT64. |
ALIGN_FRACTION_TRUE |
Alinhe a série temporal retornando a proporção do número de valores True para o número total de valores em cada período de alinhamento. Esse alinhador é válido para métricas GAUGE com valores booleanos. O valor de saída está no intervalo [0,0, 1,0] e tem value_type DOUBLE. |
ALIGN_PERCENTILE_99 |
Alinhe as série temporal usando a agregação de percentil. O ponto de dados resultante em cada período de alinhamento é o 99º percentil de todos os pontos de dados no período. Esse alinhador é válido para métricas GAUGE e DELTA com valores de distribuição. A saída é uma métrica GAUGE com value_type DOUBLE. |
ALIGN_PERCENTILE_95 |
Alinhe as série temporal usando a agregação de percentil. O ponto de dados resultante em cada período de alinhamento é o 95º percentil de todos os pontos de dados no período. Esse alinhador é válido para métricas GAUGE e DELTA com valores de distribuição. A saída é uma métrica GAUGE com value_type DOUBLE. |
ALIGN_PERCENTILE_50 |
Alinhe as série temporal usando a agregação de percentil. O ponto de dados resultante em cada período de alinhamento é o 50º percentil de todos os pontos de dados no período. Esse alinhador é válido para métricas GAUGE e DELTA com valores de distribuição. A saída é uma métrica GAUGE com value_type DOUBLE. |
ALIGN_PERCENTILE_05 |
Alinhe as série temporal usando a agregação de percentil. O ponto de dados resultante em cada período de alinhamento é o 5º percentil de todos os pontos de dados no período. Esse alinhador é válido para métricas GAUGE e DELTA com valores de distribuição. A saída é uma métrica GAUGE com value_type DOUBLE. |
ALIGN_PERCENT_CHANGE |
Alinhe e converta para uma mudança percentual. Esse alinhador é válido para métricas Se os valores de Uma média móvel de 10 minutos é calculada em cada ponto do período de alinhamento antes do cálculo acima para suavizar a métrica e evitar falsos positivos de picos muito curtos. A média móvel só é aplicável a dados cujos valores são |
Redutor
Uma operação de redução descreve como agregar pontos de dados de várias série temporal em uma única série temporal, em que o valor de cada ponto de dados na série resultante é uma função de todos os valores já alinhados nas série temporal de entrada.
| Tipos enumerados | |
|---|---|
REDUCE_NONE |
Sem redução entre série temporal. A saída do Aligner é retornada. |
REDUCE_MEAN |
Reduza calculando o valor médio nas série temporal de cada período de alinhamento. Esse redutor é válido para métricas DELTA e GAUGE com valores numéricos ou de distribuição. O value_type da saída é DOUBLE. |
REDUCE_MIN |
Reduza calculando o valor mínimo nas série temporal para cada período de alinhamento. Esse redutor é válido para métricas DELTA e GAUGE com valores numéricos. O value_type da saída é igual ao value_type da entrada. |
REDUCE_MAX |
Reduza calculando o valor máximo em série temporal para cada período de alinhamento. Esse redutor é válido para métricas DELTA e GAUGE com valores numéricos. O value_type da saída é igual ao value_type da entrada. |
REDUCE_SUM |
Reduza calculando a soma em série temporal para cada período de alinhamento. Esse redutor é válido para métricas DELTA e GAUGE com valores numéricos e de distribuição. O value_type da saída é igual ao value_type da entrada. |
REDUCE_STDDEV |
Reduza calculando o desvio padrão nas série temporal de cada período de alinhamento. Esse redutor é válido para métricas DELTA e GAUGE com valores numéricos ou de distribuição. O value_type da saída é DOUBLE. |
REDUCE_COUNT |
Faça a redução calculando o número de pontos de dados em série temporal para cada período de alinhamento. Esse redutor é válido para métricas DELTA e GAUGE de value_type numéricos, booleanos, de distribuição e de string. O value_type da saída é INT64. |
REDUCE_COUNT_TRUE |
Faça a redução calculando o número de pontos de dados com valor True em série temporal para cada período de alinhamento. Esse redutor é válido para métricas DELTA e GAUGE do booleano value_type. O value_type da saída é INT64. |
REDUCE_COUNT_FALSE |
Faça a redução calculando o número de pontos de dados com valor False em série temporal para cada período de alinhamento. Esse redutor é válido para métricas DELTA e GAUGE do booleano value_type. O value_type da saída é INT64. |
REDUCE_FRACTION_TRUE |
Faça a redução calculando a proporção do número de pontos de dados com valor True para o número total de pontos de dados em cada período de alinhamento. Esse redutor é válido para métricas DELTA e GAUGE do booleano value_type. O valor de saída está no intervalo [0,0, 1,0] e tem value_type DOUBLE. |
REDUCE_PERCENTILE_99 |
Faça a redução calculando o 99º percentil de pontos de dados em série temporal para cada período de alinhamento. Esse redutor é válido para métricas GAUGE e DELTA de tipo numérico e de distribuição. O valor da saída é DOUBLE. |
REDUCE_PERCENTILE_95 |
Reduza calculando o 95º percentil dos pontos de dados em série temporal para cada período de alinhamento. Esse redutor é válido para métricas GAUGE e DELTA de tipo numérico e de distribuição. O valor da saída é DOUBLE. |
REDUCE_PERCENTILE_50 |
Faça a redução calculando o 50º percentil dos pontos de dados em série temporal para cada período de alinhamento. Esse redutor é válido para métricas GAUGE e DELTA de tipo numérico e de distribuição. O valor da saída é DOUBLE. |
REDUCE_PERCENTILE_05 |
Reduza calculando o 5º percentil dos pontos de dados em série temporal para cada período de alinhamento. Esse redutor é válido para métricas GAUGE e DELTA de tipo numérico e de distribuição. O valor da saída é DOUBLE. |
ComparisonType
Especifica uma relação de ordenação em dois argumentos, chamados left e right.
| Tipos enumerados | |
|---|---|
COMPARISON_UNSPECIFIED |
Nenhuma relação de ordenação é especificada. |
COMPARISON_GT |
Verdadeiro se o argumento à esquerda for maior que o argumento à direita. |
COMPARISON_GE |
Verdadeiro se o argumento à esquerda for maior ou igual ao argumento à direita. |
COMPARISON_LT |
True se o argumento à esquerda for menor que o argumento à direita. |
COMPARISON_LE |
Verdadeiro se o argumento à esquerda for menor ou igual ao argumento à direita. |
COMPARISON_EQ |
Verdadeiro se o argumento à esquerda for igual ao argumento à direita. |
COMPARISON_NE |
Verdadeiro se o argumento à esquerda não for igual ao argumento à direita. |
EvaluationMissingData
Um controle de condição que determina como as condições de limite de métrica são avaliadas quando os dados param de chegar. Esse controle não afeta as políticas de ausência de métricas.
| Tipos enumerados | |
|---|---|
EVALUATION_MISSING_DATA_UNSPECIFIED |
Uma opção de dados ausentes de avaliação não especificada. Equivalente a EVALUATION_MISSING_DATA_NO_OP. |
EVALUATION_MISSING_DATA_INACTIVE |
Se não houver dados para avaliar a condição, ela será considerada falsa. |
EVALUATION_MISSING_DATA_ACTIVE |
Se não houver dados para avaliar a condição, considere-a como verdadeira. |
EVALUATION_MISSING_DATA_NO_OP |
Não avalie a condição com nenhum valor se não houver dados. |
ConditionCombinerType
Operadores para combinar condições.
| Tipos enumerados | |
|---|---|
COMBINE_UNSPECIFIED |
Um combinador não especificado. |
AND |
Combine condições usando o operador lógico AND. Um incidente só será criado se todas as condições forem atendidas simultaneamente. Esse combinador é atendido se todas as condições forem atendidas, mesmo que em recursos completamente diferentes. |
OR |
Combine condições usando o operador lógico OR. Um incidente será criado se alguma das condições listadas for atendida. |
AND_WITH_MATCHING_RESOURCE |
Combine condições usando o operador lógico AND, mas, ao contrário da opção regular AND, um incidente será criado somente se todas as condições forem atendidas simultaneamente em pelo menos um recurso. |
NotificationPrompt
Controle quando as notificações serão enviadas.
| Tipos enumerados | |
|---|---|
NOTIFICATION_PROMPT_UNSPECIFIED |
Nenhuma estratégia especificada. Tratado como erro. |
OPENED |
Notificar quando um incidente for aberto. |
CLOSED |
Notificar quando um incidente for fechado. |
Gravidade
Uma enumeração de possíveis níveis de gravidade para uma política de alertas.
| Tipos enumerados | |
|---|---|
SEVERITY_UNSPECIFIED |
Nenhuma gravidade é especificada. Esse é o valor padrão. |
CRITICAL |
Esse é o nível de gravidade mais alto. Use essa opção se o problema puder causar danos ou inatividade significativos. |
ERROR |
Esse é o nível de gravidade média. Use essa opção se o problema puder causar pequenos danos ou tempo de inatividade. |
WARNING |
Esse é o nível de gravidade mais baixo. Use essa opção se o problema não estiver causando danos ou tempo de inatividade, mas puder levar a um problema no futuro. |
Anotações de ferramentas
Dica destrutiva: ❌ | Dica idempotente: ✅ | Dica somente leitura: ✅ | Dica de mundo aberto: ❌