Tutorial NerdGraph: Criar e gerenciar alertas de fluxo de trabalho

Para alertas New Relic , você pode criar e gerenciar fluxo de trabalho usando nossa API NerdGraph.

Listar e filtrar fluxo de trabalho

A consulta workflows permite paginar todo o seu fluxo de trabalho por conta. Também permite algumas funcionalidades de filtragem no fluxo de trabalho da conta. Aqui estão alguns exemplos de casos de uso:

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

Para paginar seu fluxo de trabalho, você deve solicitar o campo nextCursor na sua consulta inicial.

Com a paginação do cursor, você continua fazendo uma solicitação por meio do conjunto de resultados até que nextCursor retornado da resposta retorne vazio. Isso indica que você chegou ao fim dos seus resultados.

Primeira chamada:

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

Resposta:

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

Encontra todos os fluxos de trabalho que possuem pelo menos uma única configuração de destino de um determinado tipo.

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

Crie um fluxo de trabalho

Para criar um fluxo de trabalho você deve primeiro criar destinos e canais.

Importante

Um ID de canal é exclusivo e, portanto, não pode ser usado em vários fluxos de trabalho ou várias vezes no mesmo fluxo de trabalho.

O atributo issuesFilter decide qual evento de problema será capturado pelo fluxo de trabalho.

Ao manter o valor do atributo predicates como uma lista vazia, o fluxo de trabalho capturará todos os possíveis eventos de problema. Ao selecionar um valor de atributo, você pode filtrar o evento de problema.

Por exemplo, podemos escolher um atributo que filtre apenas questões relevantes para uma equipe específica:

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

Atualizar um fluxo de trabalho

Ao atualizar um fluxo de trabalho, observe que os únicos atributos obrigatórios que você precisa fornecer são o accountId em aiWorkflowsUpdateWorkflow e o id do fluxo de trabalho em updateWorkflowData. O resto é opcional. Por exemplo, você só precisará fornecer o nome se pretender apenas atualizá-lo.

Para obter o ID do fluxo de trabalho, acesse a tabela de fluxo de trabalho e clique no ícone no final da linha. Em seguida, escolha Copy workflow id to clipboard.

Aqui está um exemplo de atualização do nome de um fluxo de trabalho e de dois canais:

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

Excluir um fluxo de trabalho

Aqui está um exemplo de exclusão de um fluxo de trabalho:

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

Testar um fluxo de trabalho

O teste procura problemas anteriores que correspondam às suas entradas e cria uma notificação falsa com base nisso. Se nenhum problema anterior correspondente às suas entradas for encontrado, um erro será retornado.

Por exemplo:

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

Esta tradução de máquina é fornecida para sua comodidade.

Tutorial NerdGraph: Criar e gerenciar alertas de fluxo de trabalho

Listar e filtrar fluxo de trabalho

Listando todo o fluxo de trabalho de uma conta

Encontre fluxo de trabalho por ID

Encontre o fluxo de trabalho por nome

Encontre fluxo de trabalho por tipo de destino

Crie um fluxo de trabalho

Importante

Crie um fluxo de trabalho para capturar todos os problemas

Atualizar um fluxo de trabalho

Excluir um fluxo de trabalho

Testar um fluxo de trabalho

Esta tradução de máquina é fornecida para sua comodidade.

Tutorial NerdGraph: Criar e gerenciar alertas de fluxo de trabalho

Listar e filtrar fluxo de trabalho .css-21sua1{background:none;border:none;width:0;padding:0;}

Paginando por meio de políticas com paginação de cursor:

Encontre fluxo de trabalho por ID

Encontre o fluxo de trabalho por nome

Encontre fluxo de trabalho por tipo de destino

Crie um fluxo de trabalho

Importante

Crie um fluxo de trabalho para capturar todos os problemas

Atualizar um fluxo de trabalho

Excluir um fluxo de trabalho

Testar um fluxo de trabalho

Listar e filtrar fluxo de trabalho