Descrições de incidentes personalizados de alerta

Para alguns tipos de condições, você pode definir uma descrição de incidente personalizada que transmita informações úteis downstream para melhor resposta a incidentes ou para uso por outros sistemas. Você pode criar uma descrição de incidente personalizada na interface ou com GraphQL.

Requisitos

O recurso de descrição de incidente personalizado está disponível para:

• NRQL condição do alerta
• Monitoramento de infraestrutura condição do alerta

O campo de descrição do incidente personalizado tem um tamanho máximo de caracteres de 4.000.

O que é uma descrição de incidente personalizada?

Para alguns tipos de condições, você pode criar uma descrição de incidente personalizada que transmita informações sobre uma condição e seus incidentes downstream. Usando uma descrição, você pode:

• Capture o motivo da condição
• Defina o sinal que está sendo monitorado
• Defina os próximos passos
• Adicione metadados a sistemas downstream

O campo Custom incident description permite usar uma estrutura de modelo geral que, quando um incidente é gerado, substitui as seções genéricas por valores específicos. Por exemplo, digamos que você usou isso em uma descrição:

This is my condition name : {{conditionName}}
The hostname is : {{tag.fullHostname}}

Um incidente resultante desta condição preencheria os detalhes e você receberia uma notificação como esta:

This is my condition name : My Great Alert Condition
The hostname is : ip-123-45-67-89.us-west-1.compute.internal

Crie uma descrição de incidente personalizada

Você pode criar uma descrição de incidente personalizada usando o campo dedicado para alerta NRQL ou a seção Descrever esta condição para alerta de infraestrutura.

Exemplo de modelo de descrição de incidente personalizado

Aqui está um exemplo de modelo de descrição de incidente personalizado:

this is my condition name : {{conditionName}}
The hostname is : {{tag.fullHostname}}
Owning Team: {{tag.label.owning_team}}
Product: {{tag.label.product}}
ec2VpcId: {{tag.aws.ec2VpcId}}
Service name : {{tag.label.Name}}
AWS Region : {{tag.aws.awsRegion}}
AWS Availability Zone: {{tag.aws.awsAvailabilityZone}}
Department : {{tag.label.department}}
Environment: {{tag.label.environment}}
Cluster: {{tag.clusterName}}
Cluster Role: {{tag.clusterRole}}
EC2 Instance Type: {{tag.instanceType}}
EC2 InstanceID: {{tag.aws.ec2InstanceId}}
EC2 AmiId: {{tag.aws.ec2AmiId}}
EC2 Root Device Type: {{tag.aws.ec2RootDeviceType}}

Como usar o atributo

O atributo que você pode usar em uma descrição de incidente personalizada é um subconjunto de atributo anexado ao evento do incidente. Aqui estão alguns detalhes sobre os atributos disponíveis e como utilizá-los:

• Atributo de evento de incidente: para qualquer atributo padrão disponível para uso em uma descrição de incidente personalizada, use o formato {{AN_ATTRIBUTE}}. Por exemplo:

  The target name is : {{targetName}}

  Copiar

• Tag atributo: Para tags, você usaria o formato {{tag.TAG_NAME}}. Existem dois tipos de tags:

  • Tag relacionada à entidade: For infrastructure conditions only. Você pode encontrar a tag relacionada à entidade disponível acessando o explorador de entidade e procurando no Metadata and tags de um serviço ou visualizando os detalhes do incidente. Aqui está um exemplo de uso de tag em uma descrição de incidente personalizada:

    The AWS region is : {{tag.aws.awsRegion}}
    Responsible team : {{tag.label.owning_team}}

    Copiar

  • Tag de cláusula de faceta: For NRQL conditions only. se uma condição NRQL usar uma cláusula FACET , você poderá usar a formatação tag para usar esses valores em sua descrição de incidente personalizada. Por exemplo, se a consulta NRQL incluísse FACET hostName, cluster, você poderia usar isto:

    The host is : {{tag.hostName}}
    The cluster is : {{tag.cluster}}

    Copiar

Observe que os nomes tag não podem incluir espaços em branco. Os valores expandidos podem incluir espaços em branco, mas não os nomes da tag em si.

Crie uma descrição de incidente personalizada com GraphQL

Você pode criar uma descrição de incidente personalizada em uma condição do alerta NRQL por meio de uma mutação GraphQL com essa descrição.

Aqui está um modelo de mutação vazio:

mutation {
  alertsNrqlConditionStaticUpdate(accountId: YOUR_ACCOUNT_ID, id: "YOUR_CONDITION_ID", condition: {description: ""}) {
    YOUR_CUSTOM_INCIDENT_DESCRIPTION
  }
}

Aqui está um exemplo de mutação com uma descrição de incidente personalizada:

mutation {
  alertsNrqlConditionStaticUpdate(accountId: 123456, id: "123456", condition: {description: "timestamp : {{timestamp}} \n accountId : {{accountId}} \n type : {{type}} \n event : {{event}} \n description : {{description}} \n policyId : {{policyId}} \n policyName: {{policyName}} \n conditionName : {{conditionName}} \n conditionId : {{conditionId}} \n product : {{product}} \n conditionType : {{conditionType}} \n RunbookUrl : {{runbookUrl}} \n nrqlQuery : {{nrqlQuery}} \n nrqlEventType : {{nrqlEventType}} \n targetID : {{targetId}} \n targetName : {{targetName}} \n commandLine : {{tag.commandLine}} \n entityGuid : {{tag.entityGuid}} \n entityName : {{tag.entityName}} \n fullHostname : {{tag.fullHostname}} \n instanceType : {{tag.instanceType}} \n processDisplayName : {{tag.processDisplayName}}"}) {
    description
  }
}

• Para obter mais informações sobre as condições NRQL e como usar a API NerdGraph, acesse API NerdGraph: alerta de condição NRQL.
• Para condições de monitoramento de infraestrutura, você pode criar a descrição personalizada do incidente ao criar uma condição de alerta de monitoramento de infraestrutura.
• Para saber como estruturar uma descrição de incidente personalizada, consulte o modelo de exemplo e as instruções de atributo/tag .

Mencionando usuário ou canal de notificação no Slack

Ao criar uma descrição que você sabe que será enviada ao Slack, talvez você queira @mention um usuário ou gerar uma notificação para todo o canal (por exemplo, @here ou @channel). Para conseguir isso, basta incluir o ID do usuário ou uma notificação para todo o canal na descrição, cercada por < e > caracteres.

Aqui está um exemplo para mencionar um usuário:

Attention <@LewCirne>

Aqui está um exemplo para gerar uma notificação para todo o canal:

Attention <!channel>