NerdGraph チュートリアル: 集計ワークフローの作成と管理

New Relic アラートの場合、NerdGraph API を使用してワークフローを作成および管理できます。

ワークフローの一覧表示とフィルタリング

workflowsクエリを使用すると、アカウントごとにすべてのワークフローをページ分割できます。また、アカウントワークフローでいくつかのフィルタリング機能を使用できます。ユースケースの例を次に示します。

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

ワークフローをページ分割するには、最初のクエリでnextCursorフィールドをリクエストする必要があります。

カーソルページネーションを使用すると、応答から返されたnextCursorが空に戻るまで、結果セットを介して要求を続けます。これは、結果の最後に到達したことを示します。

最初の呼び出し：

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

応答：

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

特定のタイプの宛先構成が少なくとも1つあるすべてのワークフローを検索します。

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

ワークフローを作成する

ワークフローを作成するには、最初に宛先とチャネルを作成する必要があります。

重要

チャネルIDは一意であるため、複数のワークフローで使用したり、同じワークフローで複数回使用したりすることはできません。

issuesFilter属性は、ワークフローによってキャッチされる発行イベントを決定します。

predicates属性の値を空のリストとして保持することにより、ワークフローは発生する可能性のあるすべての問題イベントをキャッチします。属性値を選択すると、発行イベントをフィルタリングできます。

たとえば、特定のチームに関連する問題のみをフィルタリングする属性を選択できます。

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

ワークフローを更新する

ワークフローを更新する場合、指定する必要がある必須属性は、 aiWorkflowsUpdateWorkflowの下のaccountIdと、 updateWorkflowDataの下のワークフローのidのみであることに注意してください。残りはオプションです。たとえば、名前を更新するだけの場合は、名前のみを指定する必要があります。

ワークフロー ID を取得するには、ワークフローテーブルに移動し、行の末尾にあるアイコンをクリックします。次に、 Copy workflow id to clipboardを選択します。

ワークフローの名前と 2 つのチャネルを更新する例を次に示します。

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

ワークフローを削除する

ワークフローを削除する例を次に示します。

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

ワークフローをテストする

テストでは、入力に一致する以前の問題を検索し、それに基づいて偽の通知を作成します。入力に一致する以前の問題が見つからなかった場合は、エラーが返されます。

例えば：

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

この機械翻訳は、参考として提供されています。

NerdGraph チュートリアル: 集計ワークフローの作成と管理

ワークフローの一覧表示とフィルタリング

アカウントのすべてのワークフローを一覧表示する

IDでワークフローを検索

名前でワークフローを検索

宛先タイプでワークフローを検索

ワークフローチャネルのペイロードの一覧表示

ワークフローを作成する

重要

すべての問題をキャッチするワークフローを作成する

ワークフローを更新する

ワークフローを削除する

ワークフローをテストする

この機械翻訳は、参考として提供されています。

NerdGraph チュートリアル: 集計ワークフローの作成と管理

ワークフローの一覧表示とフィルタリング .css-21sua1{background:none;border:none;width:0;padding:0;}

カーソルページ付けを使用したポリシーのページ付け：

IDでワークフローを検索

名前でワークフローを検索

宛先タイプでワークフローを検索

ワークフロー チャネルのペイロードの一覧表示

ワークフローを作成する

重要

すべての問題をキャッチするワークフローを作成する

ワークフローを更新する

ワークフローを削除する

ワークフローをテストする

ワークフローの一覧表示とフィルタリング

ワークフローチャネルのペイロードの一覧表示