Aperçu
Nous travaillons toujours sur cette fonctionnalité, mais nous aimerions que vous l'essayiez !
Cette fonctionnalité est actuellement fournie dans le cadre d'un programme d'aperçu conformément à nos politiques de pré-sortie.
New Relic vous permet d'utiliser les mutations GraphQL des cartes de score NerdGraph pour gérer les cartes de score et les règles. Ces mutations vous permettent de créer, mettre à jour, supprimer et récupérer des dashboards et leurs règles associées dans votre workflow et votre intégration existants.
Ce didacticiel fournit des exemples d'utilisation de NerdGraph pour gérer les dashboards et les règles. Vous pouvez utiliser ces exemples pour automatiser les tâches de gestion des cartes de score, telles que la création de cartes de score, l'ajout de règles et la mise à jour des détails des cartes de score.
Mutations
New Relic fournit diverses mutations NerdGraph pour créer et gérer des dashboards et des règles associées.
Pour gérer les tableaux de bord et les règles, vous devez fournir l'ID de votre organisation. Vous pouvez récupérer l'ID de votre organisation à l'aide de la requête actor
.
Demande d'échantillon
query FetchYourOrgId { actor { organization { id } }}
Vous pouvez créer votre propre Scorecard en utilisant la mutation entityManagementCreateScorecard
.
Paramètres d'entrée
paramètres | Type de données | Est-ce obligatoire ? | Description |
---|---|---|---|
| Chaîne | Oui | Le nom du dashboard. |
| Chaîne | Non | Une brève description du dashboard. |
| Chaîne | Oui | Votre identifiant d'organisation. |
Demande d'échantillon
mutation CreateScorecard($name: String!, $desc: String, $organizationId: ID!) { entityManagementCreateScorecard( scorecardEntity: {description: $desc, name: $name, scope: {type: ORGANIZATION, id: $organizationId}} ) { entity { id rules { id } } } } // PARAMETERS { "description": "Test test Best Practices", "name": "Test Engineering Best Practices", "organizationId": "xxxxxxxx-yyyy-0000-aaaa-0123456789qwe" }
Vous pouvez créer une nouvelle règle pour une carte de score en utilisant la mutation entityManagementCreateScorecardRule
.
Paramètres d'entrée
paramètres | Type de données | Est-ce obligatoire ? | Description |
---|---|---|---|
| Chaîne | Oui | Le nom de la règle. |
| Chaîne | Non | Une brève description de la règle. |
| Chaîne | Oui | Une requête NRQL pour évaluer la conformité. |
| Int | Oui | Liste des ID de compte où la règle doit exécuter la requête. |
| Chaîne (ID) | Oui | Votre identifiant d'organisation, voir Récupérer l'identifiant de votre organisation ci-dessus pour savoir comment le récupérer |
Demande d'échantillon
mutation CreateRule($name: String!, $description: String, $query: String!, $accounts: [Int!]!, $organizationId: ID!) { entityManagementCreateScorecardRule( scorecardRuleEntity: { name: $name, description: $description enabled: true, nrqlEngine: { accounts: $accounts, query: $query }, scope: {id: $organizationId, type: ORGANIZATION}} ) { entity { id // RULE Id } } } // PARAMETERS { "name": "APM Services Have Alerts Defined", "description": "Check that APM services have alerts associated with them", "query": "SELECT if(latest(alertSeverity) != 'NOT_CONFIGURED', 1, 0) as 'score' FROM Entity WHERE type = 'APM-APPLICATION' AND tags.nr.team IS NOT NULL AND tags.environment IS NOT NULL FACET id as 'entityGuid', tags.nr.team as 'team', tags.environment as 'environment' LIMIT MAX SINCE 1 day ago", "organizationId": "xxxxxxxx-yyyy-0000-aaaa-0123456789qwe" }
Vous pouvez associer une règle à une Scorecard à l'aide de la mutation entityManagementAddCollectionMembers
.
Paramètres d'entrée
paramètres | Type de données | Est-ce obligatoire ? | Description |
---|---|---|---|
| Chaîne | Oui | L'ID de la carte de score pour ajouter les règles. |
| Chaîne | Oui | Liste des identifiants de règles à ajouter à la fiche d’évaluation. |
Demande d'échantillon
mutation AddRuleToCollection($collectionId: ID!, $rules: [ID!]!) { entityManagementAddCollectionMembers( collectionId: $collectionId ids: $rules ) } // PARAMETERS { "collectionId": "", // Collection ID is from the rule.id from scorecard entity "rules": [] // Provide list of all rule ids which are generated during rule creation. }
Vous pouvez mettre à jour les détails d'une carte de score existante à l'aide de la mutation entityManagementUpdateScorecard
.
Paramètres d'entrée
paramètres | Type de données | Est-ce obligatoire ? | Description |
---|---|---|---|
| Chaîne | Oui | L'identifiant unique de la Scorecard. |
| Chaîne | Non | Description mise à jour du dashboard. |
| Chaîne | Oui | Nom mis à jour du dashboard. |
Demande d'échantillon
mutation UpdateScorecard($id: ID!, $description: String, $name: String!) { entityManagementUpdateScorecard( id: $id scorecardEntity: { description: $description, name: $name } ) { entity { name id rules { id } } }}
Vous pouvez mettre à jour une règle pour la carte de score à l'aide de la mutation entityManagementUpdateScorecardRule
.
Paramètres d'entrée
paramètres | Type de données | Est-ce obligatoire ? | Description |
---|---|---|---|
| IDENTIFIANT | Oui | L'identifiant unique de la règle. |
| Chaîne | Oui | Le nom de la règle. |
| Chaîne | Non | Une brève description de la règle. |
| Chaîne | Oui | Une requête NRQL pour évaluer la conformité. |
| Int | Oui | Liste des ID de compte où la règle doit exécuter la requête. |
| Booléen | Non | Activer ou désactiver la règle. |
Demande d'échantillon
mutation UpdateRule( $ruleId: ID! $name: String! $description: String $query: String! $queryAccounts: [Int!]! $enabled: Boolean) { entityManagementUpdateScorecardRule( id: $ruleId scorecardRuleEntity: { description: $description name: $name enabled: $enabled nrqlEngine: { accounts: $queryAccounts, query: $query } } ) { entity { id name description nrqlEngine { accounts query } } }}
Vous pouvez supprimer une carte de score ou une règle existante à l'aide de la mutation entityManagementDelete
.
Paramètres d'entrée
paramètres | Type de données | Est-ce obligatoire ? | Description |
---|---|---|---|
| IDENTIFIANT | Oui | L'ID de la carte de score ou de la règle cible à supprimer. |
Demande d'échantillon
mutation DeleteEntity($id: ID!) { entityManagementDelete(id: $id) { id }}
Requête NerdGraph pour les cartes de pointage
Vous pouvez récupérer toutes les règles associées à une fiche d'évaluation spécifique à l'aide de la requête FetchScorecardDetails
.
Paramètres d'entrée
paramètres | Type de données | Est-ce obligatoire ? | Description |
---|---|---|---|
| Chaîne | Oui | L'ID du Scorecard pour récupérer les règles. |
Demande d'échantillon
query FetchScorecardDetails($scorecardId: ID!) { actor { entityManagement { entity(id: $scorecardId) { ... on EntityManagementScorecardEntity { name description rules { id } } } } }}
FetchRulesCollection
requête
Vous pouvez récupérer les détails de la collecte à l'aide de la requête FetchRulesCollection
, qui nécessite l'ID de règles obtenu à partir de la réponse FetchScorecardDetails
.
Paramètres d'entrée
paramètres | Type de données | Est-ce obligatoire ? | Description |
---|---|---|---|
| Chaîne | Oui | L'ID obtenu à partir de la réponse . |
Demande d'échantillon
query FetchRulesCollection($rulesId: ID!) { actor { entityManagement { collectionElements(filter: { collectionId: { eq: $rulesId } }) { items { ... on EntityManagementScorecardRuleEntity { id name nrqlEngine { accounts query } } } nextCursor } } }}