Modèle de description de la condition d'alerte

Pour certains types de conditions, vous pouvez définir un modèle de description qui transmet des informations utiles en aval pour une meilleure réponse aux incidentou pour une utilisation par d'autres systèmes. Vous pouvez créer un modèle de description dans l'UI ou avec GraphQL.

Exigences

La fonctionnalité de modèle de description est disponible pour :

• État d'alerte NRQL
• monitoring de l'état d'alerte des infrastructures

Le champ du modèle de description a une taille de caractères maximale de 4000.

Qu'est-ce qu'un modèle de description ?

Pour certains types de conditions, vous pouvez créer un modèle de description qui transmet des informations sur une condition et son incident en aval. À l’aide d’une description, vous pouvez :

• Capturez la raison de la condition
• Définir le signal monitoré
• Définir les prochaines étapes
• Ajouter des métadonnées au système aval

Le champ Description template vous permet d'utiliser une structure de modèle générale qui, lorsqu'un incident est généré, remplace les sections génériques par des valeurs spécifiques. Par exemple, disons que vous avez utilisé ceci dans une description :

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

Un incident résultant de cette condition compléterait les détails et vous recevriez une notification comme celle-ci :

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

Créer un modèle de description

Vous pouvez créer un modèle de description en utilisant le champ dédié aux alertes NRQL ou la section Décrire cette condition pour les alertes d'infrastructure.

Exemple de modèle de description

Voici un exemple de modèle de description :

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

Comment utiliser l'attribut

Les attributs que vous pouvez utiliser dans un modèle de description sont un sous-ensemble d'attributs attachés à l'événementincident . Voici quelques détails sur les attributs disponibles et comment les utiliser :

• incident événement attribut : Pour tout attribut standard disponible pour une utilisation dans un modèle de description, utilisez le format {{AN_ATTRIBUTE}}. Par exemple:

  The target name is : {{targetName}}

  Copier

• attribut de balise : pour la balise, vous utiliseriez le format {{tags.TAG_NAME}}. Il existe deux types de balises :

  • Balise liée à l'entité : For infrastructure conditions only. Vous pouvez trouver la balise liée à l'entité disponible en accédant à l'explorateur d'entités et en recherchant sous le Metadata and tags d'un service, ou en affichant les détails incident . Voici un exemple d'utilisation d'une balise dans un modèle de description :

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

    Copier

  • Balise de clause de facette : For NRQL conditions only. Si une condition NRQL utilise une clause FACET, vous pouvez utiliser la mise en forme tags pour utiliser ces valeurs dans votre modèle de description. Par exemple, si la requête NRQL incluait FACET hostName, cluster, vous pourriez alors utiliser ceci :

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

    Copier

Veuillez noter que les noms tag ne peuvent pas inclure d'espaces. Les valeurs développées peuvent inclure des espaces, mais pas les noms des balises elles-mêmes.

Créer un modèle de description avec GraphQL

Vous pouvez créer un modèle de description sur une condition d'alerte NRQL via une mutation GraphQL avec cette description.

Voici un modèle de mutation vide :

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

Voici un exemple de mutation avec un modèle de description :

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 : {{tags.commandLine}} \n entityGuid : {{tags.entityGuid}} \n entityName : {{tags.entityName}} \n fullHostname : {{tags.fullHostname}} \n instanceType : {{tags.instanceType}} \n processDisplayName : {{tags.processDisplayName}}"
    }
  ) {
    description
  }
}

• Pour plus d'informations sur les conditions NRQL et l'utilisation de l'API NerdGraph, accédez à API NerdGraph : alertes de condition NRQL.
• Pour monitoring des conditions infrastructure , vous pouvez créer le modèle de description lors de la création d'une alerte de monitoring des conditions d'infrastructure.
• Pour savoir comment structurer un modèle de description, consultez l'exemple de modèle et les instructions relatives aux attributs/tag .

Mentionner un utilisateur ou notifier un canal dans Slack

Lorsque vous créez une description dont vous savez qu'elle sera envoyée à Slack, vous souhaiterez peut-être @mention un utilisateur ou générer une notification à l'échelle du canal (par exemple, @here ou @channel). Pour ce faire, incluez simplement l'ID utilisateur ou une notification à l'échelle du canal dans la description entourée des caractères < et > .

Voici un exemple pour mentionner un utilisateur :

Attention <@LewCirne>

Voici un exemple de génération d'une notification à l'échelle d'un canal :

Attention <!channel>