Tutoriel NerdGraph : afficher les données d'entité

entité chez New Relic fait référence à tout ce que nous monitorons et qui génère ou contient de la télémétrie. Entité vous aide à trouver les données que vous souhaitez suivre dans New Relic, et si vous comprenez leurs relations avec d'autres entités, vous pouvez obtenir encore plus d'informations détaillées sur vos données. Voici quelques exemples d'entité :

moniteur d'application par APM.
intégration cloud, services et hôtes moniteur par notre monitoring d'infrastructure.

Vous pouvez travailler avec l'entité directement dans notre UI (voir En savoir plus sur l'entité New Relic ), ou vous pouvez suivre les étapes ici pour travailler avec l'entité via notre API NerdGraph. Si vous avez besoin d’aide pour démarrer avec NerdGraph, consultez notre Introduction à New Relic NerdGraph.

Important

Pour travailler avec les métriques dorées et la balise d'une entité, consultez le didacticiel API métriques dorées.

Avant de commencer

Avant de travailler avec entité, nous vous recommandons de lire En savoir plus sur entité.

Lorsque vous travaillez avec Entité, voici quelques points importants à garder à l'esprit :

Un GUID unique identifie une entité (entity.guid ou entityGuid).
Une entité existe dans New Relic pendant une période spécifique.
Une entité fournit un point d'entrée utile pour explorer des données sur des métriques et des événements spécifiques ou pour contextualiser des données liées à d'autres entités.

Recherche d'entité

New Relic recherche une entité par son attribut, principalement son nom, mais aussi par type d'entité et d'autres valeurs. La recherche renvoie des données de base sur l'entité correspondant aux critères de recherche. Ensuite, à partir des résultats de la requête de base, vous pouvez interroger une entité spécifique par son GUID.

Outre domainType, les autres attributs d'entité courants sont :

id
accountId
name
domainId
alertSeverity
reporting

Vous pouvez filtrer par l’un des attributs ci-dessus. De plus, vous pouvez utiliser des balises pour le filtrage.

Prudence

Vous ne pouvez pas filtrer par propriétés d’entité personnalisées au niveau racine. Les propriétés personnalisées ne sont récupérées que dans le cadre des métadonnées de l'entité dans la réponse de recherche réelle. Pour filtrer par un champ personnalisé, transformez-le en tag d'entité.

Vous pouvez créer une requête de deux manières :

Utilisez l’argument queryBuilder pour vous aider à créer une requête.
Utilisez l'argument libre query pour créer votre propre recherche.

Pour utiliser NerdGraph pour interroger une ou plusieurs entités, vous pouvez rechercher par attribut ou GUID.

Conseil

NerdGraph définit le nombre total d'entités pouvant être renvoyées dans une requête à 200. Si vous devez récupérer toutes les entités d'une requête, utilisez la pagination du curseur comme expliqué dans les exemples.

En plus des exemples ci-dessous, nous vous recommandons d'expérimenter l'API à l'aide de l'explorateur NerdGraph. Il dispose d'une documentation en ligne qui vous aidera à construire votre requête et vos mutations.

Rechercher avec `queryBuilder`

L'argument queryBuilder est utile pour construire une requête simple. Il vous permet d'ajouter des filtres à votre requête à partir d'une liste prédéfinie d'attributs et de leurs valeurs typiques. Pour une requête plus avancée, utilisez plutôt l'argument query .

Accédez à l'explorateur NerdGraph GraphiQL.
Exécutez une requête de base pour trouver les entités qui correspondent à vos critères de recherche. Par exemple:
```
{
  actor {
    entitySearch(queryBuilder: { domain: APM, type: APPLICATION }) {
      query
      results {
        entities {
          name
          entityType
          guid
        }
      }
    }
  }
}
```

Recherche avec forme libre `query`

Ceci est utile pour créer des requêtes plus complexes.

Accédez à l'explorateur NerdGraph GraphiQL.

Exécutez une requête de base pour trouver les entités qui correspondent à vos critères de recherche. Par exemple:

query($query: String!) {
  actor {
    entitySearch(query: $query) {
      count
      results {
        entities {
          name
          entityType
          guid
        }
      }
    }
  }
}

Ajoutez les variables suivantes à la section Query variables dans NerdGraph :
```
{ "query": "name LIKE 'nerd-graph' AND domainType IN ('APM-APPLICATION')" }
```

Récupérer l'entité par GUID

Lorsque vous connaissez le GUID de l'entité que vous souhaitez récupérer, vous pouvez simplement utiliser l'attribut entity :

{
  actor {
    entity(guid: "ENTITY_GUID") {
      name
      entityType
    }
  }
}

Cela peut également être écrit sous forme de requête de recherche :

{
  actor {
    entitySearch(query: "id = 'ENTITY_GUID'") {
      query
      results {
        entities {
          name
          entityType
        }
      }
    }
  }
}

Ou, pour récupérer plusieurs entités en même temps, vous pouvez utiliser l'attribut entities :

{
  actor {
    entities(guids: ["ENTITY_GUID_1", "ENTITY_GUID_2"]) {
      name
      entityType
    }
  }
}

Sinon, utilisez une requête de recherche :

{
  actor {
    entitySearch(query: "id IN ('ENTITY_GUID_1', 'ENTITY_GUID_2')") {
      query
      results {
        entities {
          name
          entityType
        }
      }
    }
  }
}

Exemple de requête

Les requêtes sont requests qui visent uniquement à récupérer des données (et n'ont aucun autre effet). Les requêtes NerdGraph ne sont pas statiques, ce qui signifie que vous pouvez demander plus ou moins de données en fonction de vos besoins. Pour chaque requête, vous pouvez spécifier exactement les données que vous souhaitez récupérer, à condition qu'elles soient prises en charge par le schéma.

Les entités dans NerdGraph s'appuient sur les interfacesGraphQL , un concept qui permet aux objets de partager des champs communs. Les interfaces sont utilisées pour fournir des données pour des types d'entités spécifiques, comme vous le verrez dans plusieurs de ces exemples de requêtes NerdGraph.

Si vous ne savez pas comment commencer à créer une requête de recherche d'entité, utilisez NerdGraph pour vous aider à en créer une. Ensuite, récupérez les données de l’entité et la chaîne de requête qui a été créée.

Demandez le champ de requête dans vos résultats pour voir la chaîne de requête construite par l'argument queryBuilder .
Vous ne pouvez pas utiliser les arguments query et queryBuilder en même temps.

Nous vous recommandons vivement d'explorer l'API à l'aide de l'explorateur NerdGraph GraphiQL et d'utiliser sa documentation en ligne pour voir les options de requête qui s'offrent à vous.

{
  actor {
    entitySearch(queryBuilder: { domain: APM, type: APPLICATION }) {
      query
      results {
        entities {
          reporting
          ... on AlertableEntityOutline {
            alertSeverity
          }
        }
      }
    }
  }
}

Il existe de nombreux types différents d’entités d’intégration infrastructure et elles sont répertoriées séparément des autres types d’entités. Utilisez l’argument d’entrée infrastructureIntegrationType pour les explorer.

Vous ne pouvez pas utiliser les arguments query et queryBuilder en même temps.
Utilisez infrastructureIntegrationType à la place de l’argument d’entrée type .

Nous vous recommandons vivement d'explorer l'API à l'aide de l'explorateur NerdGraph GraphiQL et d'utiliser sa documentation en ligne pour voir les options de requête qui s'offrent à vous.

{
  actor {
    entitySearch(queryBuilder: { infrastructureIntegrationType: F5_NODE }) {
      query
      results {
        entities {
          entityType
          domain
        }
      }
    }
  }
}

Récupère la gravité de l'alerte de toute entité qui peut être monitorée par les alertes de New Relic. Cette requête NerdGraph vous indiquera si nous recevons actuellement des données de votre application (en utilisant le champ reporting ).

Si l'entité est de type alertable, les résultats incluront la gravité de l'alerte de l'entité.

Si les résultats incluent des entités qui ne sont pas alertables, ils n'incluront pas les champs AlertableEntityOutline .

{
  actor {
    entitySearch(query: "name like 'nerdgraph' and alertSeverity is not null") {
      results {
        entities {
          reporting
          ... on AlertableEntityOutline {
            alertSeverity
          }
        }
      }
    }
  }
}

Différents types d’entités ont des données spécifiques qui leur sont associées. L'exemple de requête NerdGraph suivant montre une sélection de champs disponibles pour l'entitéapplication :

Des données récapitulatives supplémentaires peuvent être demandées dans votre requête.

Si des entités d’autres types sont renvoyées dans vos résultats de recherche, elles n’incluront pas ces champs.

{
  actor {
    entitySearch(
      query: "name like 'nerdgraph' and domainType = 'APM-APPLICATION'"
    ) {
      results {
        entities {
          name
          ... on ApmApplicationEntityOutline {
            apmSummary {
              errorRate
              apdexScore
              webResponseTimeAverage
              responseTimeAverage
            }
          }
        }
      }
    }
  }
}

Différents types d’entités ont des données spécifiques qui leur sont associées. Cet exemple de requête NerdGraph requests le nom de toutes les entités, quel que soit leur type, ainsi que le taux d'erreur pour les entités APM, et .

Si des entités d'autres types sont renvoyées dans vos résultats de recherche, elles n'incluront pas de champ taux d'erreur.

{
  actor {
    entitySearch(query: "name like 'nerdgraph'") {
      results {
        entities {
          name
          ... on ApmApplicationEntityOutline {
            apmSummary {
              errorRate
            }
          }
          ... on BrowserApplicationEntityOutline {
            browserSummary {
              jsErrorRate
            }
          }
          ... on MobileApplicationEntityOutline {
            mobileSummary {
              httpErrorRate
            }
          }
        }
      }
    }
  }
}

Cet exemple de requête NerdGraph récupère la balise pour chaque entité renvoyée dans les résultats de recherche. Pour plus d'informations, consultez le didacticiel sur les balises NerdGraph GraphiQL.

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

Cet exemple de requête NerdGraph filtre les entités qui appartiennent au domaine INFRA et appartiennent à awsRegion us-east-1, et renvoie leur nom dans les résultats de recherche.

{
  actor {
    entitySearch(
      query: "domain = 'INFRA' and tags.aws.awsRegion = 'us-east-1'"
    ) {
      results {
        entities {
          name
        }
      }
    }
  }
}

De plus, le filtrage peut être effectué en fonction de la présence ou non d'une tag donnée. La requête suivante filtre l'entité du type de domaine BROWSER-APPLICATION et a la tag clusterAgentId définie.

{
  actor {
    entitySearch(
      query: "domainType = 'BROWSER-APPLICATION' and tags.clusterAgentId is not null"
    ) {
      results {
        entities {
          name
        }
      }
    }
  }
}

Pour plus d'informations, consultez le didacticiel sur les balises NerdGraph GraphiQL.

Cet exemple de requête NerdGraph filtre les entités de domaine domainType APM-APPLICATION qui appartiennent à awsRegion us-east-1 et renvoie leur nom dans les résultats de recherche. Ensuite, les résultats sont agrégés pour obtenir le nombre total d'entités regroupées par identifiant de compte New Relic .

{
  actor {
    entitySearch(query: "domainType = 'APM-APPLICATION'") {
      facetedCounts(facets: { facetCriterion: { facet: ACCOUNT_ID } }) {
        counts {
          count
          facet
        }
      }
    }
  }
}

De plus, l'agrégation peut également être effectuée par balise ; la requête suivante filtre les entités de domaine domainType APM-APPLICATION qui appartiennent à awsRegion us-east-1, puis agrège les résultats pour obtenir le nombre total d'entités regroupées par langue agent .

{
  actor {
    entitySearch(
      query: "domainType = 'APM-APPLICATION' and tags.aws.awsRegion = 'us-east-1'"
    ) {
      facetedCounts(facets: { facetCriterion: { tag: "language" } }) {
        counts {
          count
          facet
        }
      }
    }
  }
}

Pour plus d'informations, consultez le didacticiel sur les balises NerdGraph GraphiQL.

L'explorateur NerdGraph GraphiQL pagine les résultats d'une recherche d'entité.

Si vos critères de recherche génèrent plus que la limite API de 200 entités dans une seule réponse et que vous souhaitez afficher le reste des résultats, vous pouvez demander nextCursor dans votre requête initiale et utiliser sa valeur dans une autre requête pour récupérer la « page » de résultats suivante.

S'il n'y a plus de résultats, nextCursor sera nul.

{
  actor {
    entitySearch(query: "name like 'nerd-graph'") {
      results {
        nextCursor
        entities {
          name
        }
      }
    }
  }
}

Utilisez la valeur de nextCursor dans votre prochaine recherche :

{
  actor {
    entitySearch(query: "name like 'nerd-graph'") {
      results(cursor: "next_cursor_value") {
        nextCursor
        entities {
          name
        }
      }
    }
  }
}

L'explorateur NerdGraph GraphiQL permet de filtrer les entités avec alertable est vrai|faux pour afficher quand une entité a la propriété alertable. Voir les définitions d'entité

Vous pouvez filtrer par l’un des attributs ci-dessus. De plus, vous pouvez également utiliser des balises pour le filtrage.

Alertable est une configuration de type entité, c'est pourquoi elle n'est pas présente dans les résultats.

{
  actor {
    entitySearch(query: "alertable is TRUE") {
      results {
        entities {
          name
        }
      }
    }
  }
}

Vous pouvez également combiner avec d'autres filtres dans la requête :

{
  actor {
    entitySearch(query: "domain='APM' and alertable is TRUE") {
      results {
        entities {
          name
        }
      }
    }
  }
}

L'explorateur NerdGraph GraphiQL permet de filtrer les entités avec un champ de date de reporting true|false et lastReportingChangeAt.

Vous pouvez récupérer les entités qui ont cessé de signaler (quelque chose leur est arrivé) au cours des dernières heures

{
  actor {
    entitySearch(
      query: "reporting is false and lastReportingChangeAt > 1651708800000"
    ) {
      results {
        entities {
          name
        }
      }
    }
  }
}

Créer ou supprimer des relations d'entité

Une entité peut avoir une relation avec une autre entité. Certaines relations sont créées automatiquement par New Relic, mais vous pouvez également utiliser des mutations pour créer ou supprimer des relations personnalisées. Nous avons quelques explications ci-dessous sur la façon de procéder, mais si vous avez besoin d'aide pour comprendre les différents types de relations dans New Relic, jetez un œil aux relations d'entité.

Avant de créer manuellement des relations supplémentaires ou de les supprimer, gardez à l'esprit les points suivants :

Deux entités peuvent avoir plusieurs relations, une pour chaque type de relation.
Deux entités peuvent entretenir une relation SI elles appartiennent au même compte de confiance.
Pour chaque entité, vous pouvez définir manuellement jusqu'à 2000 relations. Lorsque la limite est atteinte, l'API renvoie une erreur LIMIT_EXCEEDED .
Chaque mutation peut échouer si vous n'avez pas accès à l'une des deux entités (source/cible).

Lister les relations d'une entité

Vous pouvez utiliser le champ relatedEntities pour voir comment les paires d'entités interagissent et comment elles sont liées. Cela peut vous aider à résoudre les problèmes des services en amont et en aval et à comprendre comment des problèmes mineurs peuvent avoir des répercussions plus importantes, de la même manière que les cartes de service peuvent être utilisées.

L'exemple suivant montre comment interroger une entité par son GUID spécifique :

query {
  actor {
    entity(guid: "ENTITY_GUID") {
      name
      relatedEntities {
        results {
          source {
            entity {
              guid
              name
            }
          }
          target {
            entity {
              guid
              name
            }
          }
          type
        }
      }
    }
  }
}

Créer ou remplacer des relations

Créez ou remplacez des relations d’entité à l’aide de la mutation entityRelationshipUserDefinedCreateOrReplace. Comme son nom l'indique, il permet de créer une relation entre deux entités ayant un type donné. Si la relation existe déjà entre les deux entités, elle sera à nouveau ajoutée avec les valeurs données mises à jour (l'heure de création et l'identifiant de l'utilisateur créateur) :

mutation {
  entityRelationshipUserDefinedCreateOrReplace(
    sourceEntityGuid: "SOURCE_ENTITY_GUID"
    targetEntityGuid: "TARGET_ENTITY_GUID"
    type: BUILT_FROM
  ) {
    errors {
      message
      type
    }
  }
}

Supprimer les relations

Supprimer les relations d’entité en utilisant la mutation entityRelationshipUserDefinedDelete. La source et la cible sont obligatoires, mais le type ne l'est pas. Si vous exécutez la mutation sans type, toutes les relations entre les deux entités sont supprimées.

mutation {
  entityRelationshipUserDefinedDelete(
    sourceEntityGuid: "SOURCE_ENTITY_GUID"
    targetEntityGuid: "TARGET_ENTITY_GUID"
    type: BUILT_FROM
  ) {
    errors {
      message
      type
    }
  }
}

Supprimer l'entité

Vous pouvez supprimer manuellement n'importe quelle entité de votre compte en utilisant l'API NerdGraph dans l'explorateur NerdGraph GraphiQL.

Pour supprimer l'entité EXT-SERVICE et REF-REPOSITORY, exécutez cette mutation avec le GUID de l'entité :

mutation {
  entityDelete(guids: ["ENTITY_GUID_1", "ENTITY_GUID_2"]) {
    deletedEntities
    failures {
      guid
      message
    }
  }
}

Important

Après avoir exécuté la entityDelete mutation, vous pouvez voir une entité supprimée dans votre UI si un New Relic agent la réindexe à nouveau.

Pour supprimer l'entité APM, BROWSER et MOBILE, exécutez cette mutation avec le GUID de l'entité :

mutation {
  agentApplicationDelete(guid: "ENTITY_GUID") {
    success
  }
}

Important

La mutation agentApplicationDelete nécessite que l'agent New Relic ne dispose pas de données de rapport pendant 12 heures avant la suppression.
Actuellement, vous ne pouvez supprimer que les types d’entités suivants à l’aide de l’ API Nerdgraph : APM-APPLICATION, EXT-SERVICE et REF-REPOSITORY.
Vous pouvez voir une entité supprimée dans votre UI si un New Relic agent la réindexe à nouveau.

Cette traduction automatique est fournie pour votre commodité.

Tutoriel NerdGraph : afficher les données d'entité

Important

Avant de commencer

Recherche d'entité

Prudence

Conseil

Rechercher avec `queryBuilder`

Recherche avec forme libre `query`

Récupérer l'entité par GUID

Exemple de requête

Obtenir des données d'entité à l'aide de queryBuilder

Obtenez des données sur l'entité d'intégration infrastructure dans les résultats de recherche

Obtenez des informations d'alerte sur les entités pouvant être alertées dans les résultats de recherche

Obtenir des données récapitulatives sur l'entité APM dans les résultats de recherche

Obtenez des données spécifiques à chaque type d'entité dans les résultats de recherche

Obtenir toutes les balises pour chaque entité dans les résultats de recherche

Utiliser une balise pour filtrer les résultats de l'entité

Agréger les résultats par un attribut ou une tag

Obtenez le nextCursor pour les résultats de recherche paginés

Obtenez une entité alertable

Obtenir l'entité qui a arrêté de signaler il y a plus d'un jour

Créer ou supprimer des relations d'entité

Lister les relations d'une entité

Créer ou remplacer des relations

Supprimer les relations

Supprimer l'entité

Important

Important

Cette traduction automatique est fournie pour votre commodité.

Tutoriel NerdGraph : afficher les données d'entité

Important

Avant de commencer .css-21sua1{background:none;border:none;width:0;padding:0;}

Recherche d'entité

Prudence

Conseil

Rechercher avec queryBuilder

Recherche avec forme libre query

Récupérer l'entité par GUID

Exemple de requête

Obtenez des données sur l'entité d'intégration infrastructure dans les résultats de recherche

Obtenez des informations d'alerte sur les entités pouvant être alertées dans les résultats de recherche

Obtenir des données récapitulatives sur l'entité APM dans les résultats de recherche

Obtenez des données spécifiques à chaque type d'entité dans les résultats de recherche

Obtenir toutes les balises pour chaque entité dans les résultats de recherche

Utiliser une balise pour filtrer les résultats de l'entité

Agréger les résultats par un attribut ou une tag

Obtenez le nextCursor pour les résultats de recherche paginés

Obtenez une entité alertable

Obtenir l'entité qui a arrêté de signaler il y a plus d'un jour

Créer ou supprimer des relations d'entité

Lister les relations d'une entité

Créer ou remplacer des relations

Supprimer les relations

Supprimer l'entité

Important

Important

Avant de commencer

Rechercher avec `queryBuilder`

Recherche avec forme libre `query`