Tutoriel NerdGraph : créer et gérer un flux de travail d'alerte

Pour les alertes New Relic , vous pouvez créer et gérer un flux de travail à l'aide de notre API NerdGraph.

Flux de travail de liste et de filtrage

La requête workflows vous permet de parcourir l'ensemble de votre flux de travail par compte. Il permet également certaines fonctionnalités de filtrage sur le flux de travail du compte. Voici quelques exemples de cas d’utilisation :

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiWorkflows {
        workflows(filters: {}) {
          entities {
            id
            name
            workflowEnabled
            destinationConfigurations {
              channelId
              name
              type
              notificationTriggers
            }
            enrichments {
              configurations {
                ... on AiWorkflowsNrqlConfiguration {
                  query
                }
              }
              id
              name
            }
          }
          nextCursor
          totalCount
        }
      }
    }
  }
}

Afin de paginer votre flux de travail, vous devez demander le champ nextCursor lors de votre requête initiale.

Avec la pagination du curseur, vous continuez à effectuer une requête via l'ensemble de résultats jusqu'à ce que le nextCursor renvoyé par la réponse revienne vide. Cela indique que vous avez atteint la fin de vos résultats.

Premier appel :

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiWorkflows {
        workflows(filters: {}) {
          entities {
            id
            name
          }
          nextCursor
          totalCount
        }
      }
    }
  }
}

Réponse:

{
  "data": {
    "actor": {
      "account": {
        "aiWorkflows": {
          "workflows": {
            "entities": [
              {
                "id": <WORKFLOW ID>, 
                "name": <WORKFLOW NAME>
              },
              {
                "id": <WORKFLOW ID>, 
                "name": <WORKFLOW NAME>
              },
              // ... more workflows would be here 
            ]
          }
          "nextCursor": "/8o0y2qiR54m6thkdgHgwg==:jZTXDFKbTkhKwvMx+CtsPVM="
          "totalCount": 157
        }
      }
    }
  }
}

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiWorkflows {
        workflows(filters: { id: WORKFLOW_ID }) {
          entities {
            id
            name
          }
          nextCursor
          totalCount
        }
      }
    }
  }
}

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiWorkflows {
        workflows(filters: { name: WORKFLOW_NAME }) {
          entities {
            id
            name
          }
          nextCursor
          totalCount
        }
      }
    }
  }
}

Recherche tous les flux de travail qui ont au moins une seule configuration de destination d'un certain type.

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiWorkflows {
        workflows(filters: { destinationType: DESTINATION_TYPE }) {
          entities {
            id
            name
            destinationConfigurations {
              type
            }
          }
          nextCursor
          totalCount
        }
      }
    }
  }
}

Créer un workflow

Afin de créer un workflow vous devez d'abord créer des destinations et des canaux.

Important

Un ID de canal est unique et ne peut donc pas être utilisé dans plusieurs flux de travail ni utilisé plusieurs fois dans le même workflow.

L'attribut issuesFilter détermine quel événement de problème sera détecté par le workflow.

En conservant la valeur de l'attribut predicates sous forme de liste vide, le workflow détectera tous les événements de problème possibles. Lorsque vous sélectionnez une valeur d'attribut, vous pouvez ensuite filtrer l'événement du problème.

Par exemple, nous pouvons choisir un attribut qui filtre uniquement les problèmes pertinents pour une équipe spécifique :

mutation {
  aiWorkflowsCreateWorkflow(
    accountId: YOUR_ACCOUNT_ID
    createWorkflowData: {
      destinationsEnabled: true
      workflowEnabled: true
      name: "API Demo Workflow"
      issuesFilter: {
        name: "team specific issues"
        predicates: [
          {
            attribute: "accumulations.tag.team"
            operator: EXACTLY_MATCHES
            values: ["security"]
          }
        ]
        type: FILTER
      }
      destinationConfigurations: {
        channelId: "CHANNEL_ID"
        notificationTriggers: [ACTIVATED, ACKNOWLEDGED, CLOSED]
      }
      enrichmentsEnabled: true
      enrichments: { nrql: [] }
      mutingRulesHandling: DONT_NOTIFY_FULLY_MUTED_ISSUES
    }
  ) {
    workflow {
      id
      name
      destinationConfigurations {
        channelId
        name
        type
        notificationTriggers
      }
      enrichmentsEnabled
      destinationsEnabled
      issuesFilter {
        accountId
        id
        name
        predicates {
          attribute
          operator
          values
        }
        type
      }
      lastRun
      workflowEnabled
      mutingRulesHandling
    }
    errors {
      description
      type
    }
  }
}

Mettre à jour un workflow

Lorsque vous mettez à jour un workflow, notez que le seul attribut obligatoire que vous devez fournir est le accountId sous aiWorkflowsUpdateWorkflow et le id du workflow sous updateWorkflowData. Le reste est facultatif. Par exemple, vous n'avez besoin de fournir le nom que si vous souhaitez uniquement le mettre à jour.

Pour obtenir l’ID du workflow, accédez au tableau du workflow et cliquez sur l’icône à la fin de la ligne. Ensuite, choisissez Copy workflow id to clipboard.

Voici un exemple de mise à jour du nom d'un workflow et de deux canaux :

mutation {
  aiWorkflowsUpdateWorkflow(
    accountId: YOUR_ACCOUNT_ID
    updateWorkflowData: {
      name: "UPDATED_WORKFLOW_NAME"
      id: WORKFLOW_ID
      destinationConfigurations: [
        {
          channelId: "12345abc-6de7-8f90-g123-4h56i78j9klm"
          notificationTriggers: [ACTIVATED]
        }
        {
          channelId: "zy0987xw-v65u-432t-10s9-r876qpo543n2"
          notificationTriggers: [ACTIVATED]
        }
      ]
    }
  ) {
    workflow {
      id
      name
      destinationConfigurations {
        channelId
        name
        type
        notificationTriggers
      }
      enrichmentsEnabled
      destinationsEnabled
      issuesFilter {
        accountId
        id
        name
        predicates {
          attribute
          operator
          values
        }
        type
      }
      lastRun
      workflowEnabled
      mutingRulesHandling
    }
    errors {
      description
      type
    }
  }
}

Supprimer un workflow

Voici un exemple de suppression d’un workflow :

mutation {
  aiWorkflowsDeleteWorkflow(id: WORKFLOW_ID, accountId: YOUR_ACCOUNT_ID) {
    id
    errors {
      description
      type
    }
  }
}

Tester un workflow

Le test recherche les problèmes précédents qui correspondent à vos entrées et crée une fausse notification sur cette base. Si aucun problème précédent correspondant à vos entrées n'a été trouvé, une erreur sera renvoyée.

Par exemple:

mutation {
  aiWorkflowsTestWorkflow(
    accountId: YOUR_ACCOUNT_ID
    testWorkflowData: {
      destinationConfigurations: { channelId: YOUR_CHANNEL_ID, type: SLACK }
      issuesFilter: { predicates: [], type: YOUR_FILTER }
    }
  ) {
    status
    notificationResponses {
      status
      evidence
      channelId
    }
    errors {
      description
      type
    }
  }
}

Cette traduction automatique est fournie pour votre commodité.

Tutoriel NerdGraph : créer et gérer un flux de travail d'alerte

Flux de travail de liste et de filtrage

Liste de tous les flux de travail pour un compte

Rechercher workflow par ID

Rechercher workflow par nom

Rechercher un flux de travail par type de destination

Créer un workflow

Important

Créer un workflow pour détecter tous les problèmes

Mettre à jour un workflow

Supprimer un workflow

Tester un workflow

Cette traduction automatique est fournie pour votre commodité.

Tutoriel NerdGraph : créer et gérer un flux de travail d'alerte

Flux de travail de liste et de filtrage .css-21sua1{background:none;border:none;width:0;padding:0;}

Pagination des politiques avec pagination du curseur :

Rechercher workflow par ID

Rechercher workflow par nom

Rechercher un flux de travail par type de destination

Créer un workflow

Important

Créer un workflow pour détecter tous les problèmes

Mettre à jour un workflow

Supprimer un workflow

Tester un workflow

Flux de travail de liste et de filtrage