Alerta descripciones personalizadas de incidentes

Para algunos tipos de condiciones, puede definir una descripción de incidente personalizada que transmita información útil para responder mejor a los incidentes o para que la utilicen otros sistemas. Puede crear una descripción de incidente personalizada en la UI o con GraphQL.

Requisitos

La característica de descripción de incidente personalizada está disponible para:

• NRQL condición de alerta
• Monitoreo de infraestructura condición de alerta

El campo personalizado de descripción del incidente tiene un tamaño máximo de 4000 caracteres.

¿Qué es una descripción de incidente personalizada?

Para algunos tipos de condiciones, puede crear una descripción de incidente personalizada que transmita información sobre una condición y sus incidentes en sentido posterior. Usando una descripción, puedes:

• Capture el motivo de la condición.
• Definir la señal que se monitorea
• Definir los próximos pasos
• Agregar metadatos a sistemas posteriores

El campo Custom incident description permite utilizar una estructura de plantilla general que, cuando se genera un incidente, sustituye las secciones genéricas por valores específicos. Por ejemplo, digamos que usaste esto en una descripción:

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

Un incidente resultante de esta condición completaría los detalles y recibirías una notificación como esta:

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

Crear una descripción de incidente personalizada

Puede crear una descripción de incidente personalizada utilizando el campo dedicado para alerta NRQL o la sección Describe esta condición para alerta de infraestructura.

Ejemplo de plantilla de descripción de incidente personalizada

A continuación se muestra un ejemplo de plantilla de descripción de incidente personalizada:

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}}

Cómo utilizar el atributo

El atributo que puede utilizar en una descripción de incidente personalizada es un subconjunto de atributos adjuntos al evento de incidente. Aquí hay algunos detalles sobre los atributos disponibles y cómo usarlos:

• Atributo de evento de incidente: para cualquiera de los atributos estándar disponibles para usar en una descripción de incidente personalizada, use el formato {{AN_ATTRIBUTE}}. Por ejemplo:

  The target name is : {{targetName}}

  Copia

• Atributo etiqueta: Para etiquetas, usarías el formato {{tag.TAG_NAME}}. Hay dos tipos de etiqueta:

  • Etiqueta relacionada con la entidad: For infrastructure conditions only. Puede encontrar la etiqueta relacionada con la entidad disponible yendo al explorador de entidades y buscando en Metadata and tags de un servicio, o viendo los detalles del incidente. A continuación se muestra un ejemplo del uso de una etiqueta en una descripción de incidente personalizada:

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

    Copia

  • Etiqueta de cláusula de faceta: For NRQL conditions only. Si una condición NRQL usa una cláusula FACET , puede usar el formato tag para usar esos valores en su descripción de incidente personalizada. Por ejemplo, si la consulta NRQL incluyera FACET hostName, cluster, podría usar esto:

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

    Copia

Tenga en cuenta que los nombres de las etiquetas no pueden incluir espacios en blanco. Los valores expandidos pueden incluir espacios en blanco, pero no los nombres de la etiqueta en sí.

Cree una descripción de incidente personalizada con GraphQL

Puede crear una descripción de incidente personalizada en una condición de alerta NRQL mediante una mutación GraphQL con esa descripción.

Aquí hay una plantilla de mutación vacía:

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

Aquí hay un ejemplo de mutación con una descripción 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 obtener más información sobre las condiciones NRQL y el uso de la API NerdGraph, vaya a API NerdGraph: alerta de condición NRQL.
• Para las condiciones de monitoreo de infraestructura, puede crear la descripción de incidente personalizada al crear una condición de alerta de monitoreo de infraestructura.
• Para obtener información sobre cómo estructurar una descripción de incidente personalizada, consulte la plantilla de ejemplo y las instrucciones de atributo/etiqueta.

Mencionar usuario o canal de notificación en Slack

Al crear una descripción que sabes que se enviará a Slack, es posible que desees @mention un usuario o generar una notificación para todo el canal (por ejemplo, @here o @channel). Para lograr esto, simplemente incluya el ID de usuario o una notificación para todo el canal en la descripción rodeada de caracteres < y > .

A continuación se muestra un ejemplo para mencionar a un usuario:

Attention <@LewCirne>

A continuación se muestra un ejemplo para generar una notificación para todo el canal:

Attention <!channel>