NerdGraphチュートリアル。タグの表示と追加

NerdGraph API を使用して、タグをデータに追加することで、データの整理や検索性を向上させることができます。

概要

このドキュメントでは、NerdGraph APIを使ってタグを追加・管理する方法を説明しています。これはタグを追加するための一つの方法に過ぎないことに注意してください。他の方法については、 How tags are added をご覧ください。CLIツールを使ってタグを自動化する方法については、 developer site をご覧ください。

エンティティのタグを読む

これらのクエリを構築し、応答を参照してください。

api.newrelic.com/graphiql の NerdGraph GraphiQL エクスプローラーにアクセスします。
entitySearch() を使ってエンティティを見つけ、そのタグを取得します。
NerdGraphのタグAPIを使って、既存のタグとその値を読み取る。

この例では、エンティティは Cookie Checkout というブラウザアプリです。

{
  actor {
    entitySearch(query: "name like 'Cookie Checkout'") {
      results {
        entities {
          tags {
            key
            values
          }
        }
      }
    }
  }
}

実際の値は、お客様のデータによって異なります。 New Relic GraphiQL explorer を使って、クエリを試してみてください。

エンティティのタグを追加

エンティティに新しいタグを追加するには

api.newrelic.com/graphiql の NerdGraph GraphiQL エクスプローラーにアクセスします。
entitySearch() を使って、タグ付けしたいエンティティのGUIDを探します。
taggingAddTagsToEntity 変異を使用して、値を持つタグをエンティティに追加します。
APMエージェントの場合、新しいタグを追加すると再起動が必要になります。

この例では、 Cookie Checkout というブラウザアプリケーションを UI チームが所有しています。このインスタンスに team タグと ui の値を追加したいと思います。タグが追加されると、 team:ui というタグでフィルタリングし、New Relic One UI で Cookie Checkout というアプリを見つけることができます。

mutation {
    taggingAddTagsToEntity(
        guid: "ENTITY_GUID",
        tags: { key: "team", values: ["ui"]}) {
            errors {
                message
            }
        }
}

エンティティからのタグの削除

エンティティからタグとそれに関連するすべての値を削除するには

api.newrelic.com/graphiql の NerdGraph GraphiQL エクスプローラーにアクセスします。
entitySearch() を使って、削除したいタグを持つエンティティのGUIDを探します。
taggingDeleteTagFromEntity のミューテーションを使用する。
APMエージェントの場合、タグを変更すると再起動が必要になります。

以下のミューテーション例では、 チーム タグをエンティティから削除しています。

mutation {
    taggingDeleteTagFromEntity(
        guid: "ENTITY_GUID",
        tagKeys: ["team"]) {
            errors {
                message
            }
        }
}

エンティティの特定のタグ値を削除

タグ全体とそのすべての値を削除するのではなく、1つのタグの値を削除することができます。

api.newrelic.com/graphiql の NerdGraph GraphiQL エクスプローラーにアクセスします。
entitySearch() を使って、削除したいタグを持つエンティティのGUIDを探します。
taggingDeleteTagValuesFromEntity のミューテーションを使用します。

次のミューテーションの例では、 ui の値を tag のキーから削除しています。

mutation {
    taggingDeleteTagValuesFromEntity(
        guid: "ENTITY_GUID",
        tagValues: [{key: "team" value: "ui"}]) {
            errors {
                message
            }
        }
}

tagValues は配列なので、1回の変異で複数の特定の値を1つのエンティティから削除することができます。

エンティティのすべてのタグの値を置き換える

エンティティのタグセット全体を、提供されたタグセットで置き換えること。

api.newrelic.com/graphiql の NerdGraph GraphiQL エクスプローラーにアクセスします。
entitySearch() を使って、削除したいタグを持つエンティティのGUIDを探します。
taggingReplaceTagsOnEntity のミューテーションを使用します。

この例では、 Cookie Checkout ブラウザアプリケーションが、 ui チームから cookie-dev チームに移管されました。 チーム のタグの値を次のような変異で置き換えることができます。

mutation {
    taggingReplaceTagsOnEntity(
        guid: "ENTITY_GUID",
        tags: {key: "team" values: ["cookie-dev"]}) {
            errors {
                message
            }
        }
}