Tutorial de NerdGraph: Crear y gestionar alerta flujo de trabajo

Para las alertas New Relic , puede crear y gestionar el flujo de trabajo empleando nuestra API NerdGraph.

Listar y filtrar flujo de trabajo

La consulta workflows le permite paginar todo su flujo de trabajo por cuenta. También permite algunas funciones de filtrado en la cuenta flujo de trabajo. A continuación se muestran algunos casos de uso de ejemplo:

{
  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 su flujo de trabajo, debe solicitar el campo nextCursor en su consulta inicial.

Con la paginación del cursor, continúa realizando una solicitud a través del conjunto de resultados hasta que el nextCursor que se devuelve de la respuesta vuelve vacío. Esto indica que has llegado al final de tus resultados.

Primera llamada:

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

Respuesta:

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

Encuentra todos los flujos de trabajo que tienen al menos una única configuración de destino de un determinado tipo.

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

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        channels(filters: { name: "YOUR_CHANNEL_NAME" }) {
          entities {
            active
            id
            name
            properties {
              key
              value
            }
          }
        }
      }
    }
  }
}

Crear un flujo de trabajo

Para crear un flujo de trabajo, primero debe crear destinos y canales.

Importante

Un ID de canal es único y, por lo tanto, no se puede utilizar en múltiples flujos de trabajo ni varias veces en el mismo flujo de trabajo.

El atributo issuesFilter decide qué evento de problema será detectado por el flujo de trabajo.

Al mantener el valor del atributo predicates como una lista vacía, el flujo de trabajo detectará todos los eventos de problemas posibles. Cuando selecciona un valor de atributo, puede filtrar el evento de problema.

Por ejemplo, podemos elegir un atributo que solo filtre los problemas que sean relevantes para un equipo específico:

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

Actualizar un flujo de trabajo

Cuando actualiza un flujo de trabajo, tenga en cuenta que el único atributo obligatorio que debe proporcionar es el accountId en aiWorkflowsUpdateWorkflow y el id del flujo de trabajo en updateWorkflowData. El resto son opcionales. Por ejemplo, solo necesita proporcionar el nombre si solo desea actualizarlo.

Para obtener el ID del flujo de trabajo, vaya a la tabla del flujo de trabajo y haga clic en el icono al final de la fila. Luego, elija Copy workflow id to clipboard.

A continuación se muestra un ejemplo de cómo actualizar el nombre de un flujo de trabajo y dos canales:

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

Eliminar un flujo de trabajo

A continuación se muestra un ejemplo de eliminación de un flujo de trabajo:

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

Probar un flujo de trabajo

La prueba busca problemas anteriores que coincidan con sus entradas y crea una notificación falsa basada en eso. Si no se ha encontrado ningún problema anterior que coincida con sus entradas, se devolverá un error.

Por ejemplo:

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

Te ofrecemos esta traducción automática para facilitar la lectura.

Tutorial de NerdGraph: Crear y gestionar alerta flujo de trabajo

Listar y filtrar flujo de trabajo

Listado de todos los flujos de trabajo de una cuenta

Buscar flujo de trabajo por ID

Buscar flujo de trabajo por nombre

Encuentra flujo de trabajo por tipo de destino

Listado de la carga útil del canal de flujo de trabajo

Crear un flujo de trabajo

Importante

Cree un flujo de trabajo para detectar todos los problemas

Actualizar un flujo de trabajo

Eliminar un flujo de trabajo

Probar un flujo de trabajo

Te ofrecemos esta traducción automática para facilitar la lectura.

Tutorial de NerdGraph: Crear y gestionar alerta flujo de trabajo

Listar y filtrar flujo de trabajo .css-21sua1{background:none;border:none;width:0;padding:0;}

Paginar a través de políticas con paginación del cursor:

Buscar flujo de trabajo por ID

Buscar flujo de trabajo por nombre

Encuentra flujo de trabajo por tipo de destino

Listado de la carga útil del canal de flujo de trabajo

Crear un flujo de trabajo

Importante

Cree un flujo de trabajo para detectar todos los problemas

Actualizar un flujo de trabajo

Eliminar un flujo de trabajo

Probar un flujo de trabajo

Listar y filtrar flujo de trabajo