Actions de niveau de service New Relic

Cette page fournit une référence pour toutes les actions de niveau de service New Relic disponibles dans le catalogue des actions d’automatisation de workflow. Ces actions vous permettent de créer, de mettre à jour, de supprimer et de lister des SLI et leurs objectifs de niveau de service (SLO) directement depuis un workflow, permettant ainsi l’intégration automatisée des services, la remédiation des SLO et les workflow de conformité.

Prérequis

Avant d’utiliser les actions de niveau de service New Relic dans l’automatisation workflow, assurez-vous de disposer des éléments suivants :

Un compte New Relic avec les autorisations appropriées pour gérer les niveaux de service.

Créer un niveau de service

L’identifiant de l’action est newrelic.serviceLevel.create.

Crée un nouveau SLI (SLI) avec ses objectifs de niveau de service (SLO) pour une entité.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir	Type	Description	Exemple
entityGuid	Chaîne	Obligatoire. L’entité pour laquelle ce SLI est défini.	`"MjXzMzQ2fEFQTXxBUFBMSUNBVElPTnwyMzU5MzAzOTU"`
name	Chaîne	Obligatoire. Nom du SLI.	`"Checkout API availability"`
description	Chaîne	Facultatif. Description du SLI.	`"Auto-provisioned on service onboarding"`
accountId	Int	Obligatoire. Le compte New Relic qui possède le SLI.	`1234567`
validEventsFrom	Chaîne	Obligatoire. Type d’événement NRDB pour le pool d’événements valides.	`"Transaction"`
validEventsWhere	Chaîne	Facultatif. Condition booléenne NRQL pour filtrer le pool d'événements valides.	`"appName = 'checkout-api'"`
validEventsSelectFunction	Chaîne	Facultatif. Fonction d’agrégation pour le pool d’événements valides. L’un de `COUNT` , `SUM` , `GET_FIELD` , `GET_CDF_COUNT` .	`"COUNT"`
validEventsSelectAttribute	Chaîne	Facultatif. Attribut à agréger pour le pool d'événements valides. Requis lorsque `validEventsSelectFunction` est `SUM` , `GET_FIELD` , ou `GET_CDF_COUNT` .	`"duration"`
validEventsSelectThreshold	Virgule flottante	Facultatif. Valeur de seuil pour le pool d’événements valides. Utilisé uniquement lorsque `validEventsSelectFunction` est `GET_CDF_COUNT` .	`500`
eventCategory	Chaîne	Obligatoire. Classification du bucket d’événements de condition comme bons ou mauvais événements. Un de `GOOD` , `BAD` .	`"GOOD"`
conditionEventsFrom	Chaîne	Obligatoire. Type d’événement NRDB pour le bucket d’événements bons/mauvais.	`"Transaction"`
conditionEventsWhere	Chaîne	Facultatif. Condition booléenne NRQL pour filtrer le bucket d’événements bons/mauvais.	`"appName = 'checkout-api' AND error IS FALSE"`
conditionEventsSelectFunction	Chaîne	Facultatif. Fonction d’agrégation pour le compartiment des événements bons/mauvais. L’un de `COUNT` , `SUM` , `GET_FIELD` , `GET_CDF_COUNT` .	`"COUNT"`
conditionEventsSelectAttribute	Chaîne	Facultatif. Attribut à agréger pour le bucket bon/mauvais. Requis lorsque `conditionEventsSelectFunction` est `SUM` , `GET_FIELD` , ou `GET_CDF_COUNT` .	`"duration"`
conditionEventsSelectThreshold	Virgule flottante	Facultatif. Valeur de seuil pour le bucket bon/mauvais. Utilisé uniquement lorsque `conditionEventsSelectFunction` est `GET_CDF_COUNT` .	`500`
facettes	List	Facultatif. Attributs permettant de regrouper les résultats de SLI.	`["appName"]`
cible	Virgule flottante	Obligatoire. Cible de SLO en pourcentage.	`99.9`
windowDays	Int	Obligatoire. Fenêtre glissante en jours. Doit être `1` , `7` , ou `28` .	`28`
selectors	List	Facultatif. Sélecteurs JQ pour extraire des valeurs spécifiques de la réponse. Utilisez `.data.serviceLevelCreate.guid` pour capturer le GUID du nouveau SLI afin de l’utiliser dans les étapes suivantes.	`selectors: - name: sliGuid expression: ".data.serviceLevelCreate.guid"`

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir	Type	Description
success	Booléen	`true` / `false` , hérité de l’appel `newrelic.nerdgraph.execute` sous-jacent, couvre à la fois les défaillances de transport et les erreurs de logique métier de NerdGraph.
errorMessage	Chaîne	Message d’erreur en cas d’échec, qu’il s’agisse d’une erreur au niveau du transport ou d’une erreur de logique métier NerdGraph. `null` en cas de succès.
données	Carte	Réponse NerdGraph : `{ "data": { "serviceLevelCreate": { "guid": "MXxFWFR8U0VSVklDRV9MRVZFTHwzMjk5NjE", "name": "Checkout API availability" } } }` Utilisez `selectors` pour extraire `guid` ou `name` de `data`.

Sortir

Type

Description

success

Booléen

true

false

, hérité de l’appel

newrelic.nerdgraph.execute

sous-jacent, couvre à la fois les défaillances de transport et les erreurs de logique métier de NerdGraph.

errorMessage

Chaîne

Message d’erreur en cas d’échec, qu’il s’agisse d’une erreur au niveau du transport ou d’une erreur de logique métier NerdGraph.

null

en cas de succès.

données

Carte

Réponse NerdGraph :

{
  "data": {
    "serviceLevelCreate": {
      "guid": "MXxFWFR8U0VSVklDRV9MRVZFTHwzMjk5NjE",
      "name": "Checkout API availability"
    }
  }
}

Utilisez selectors pour extraire guid ou name de data.

L’exemple suivant crée un SLI/SLO et capture le GUID du nouveau SLI à l’aide de selectors pour une utilisation dans une étape ultérieure.

Exemple de workflow
name: newrelic_service_level_create_workflow description: Create an SLI/SLO for a service entity steps: - name: createSlo type: action action: newrelic.serviceLevel.create version: 1 inputs: entityGuid: ${{ .workflowInputs.entityGuid }} name: "Checkout API availability" accountId: ${{ .workflowInputs.accountId }} validEventsFrom: "Transaction" eventCategory: "GOOD" conditionEventsFrom: "Transaction" conditionEventsWhere: "appName = 'checkout-api' AND error IS FALSE" target: 99.9 windowDays: 28 selectors: - name: sliGuid expression: ".data.serviceLevelCreate.guid" next: end

Exemple de workflow

name: newrelic_service_level_create_workflow
description: Create an SLI/SLO for a service entity
steps:
  - name: createSlo
    type: action
    action: newrelic.serviceLevel.create
    version: 1
    inputs:
      entityGuid: ${{ .workflowInputs.entityGuid }}
      name: "Checkout API availability"
      accountId: ${{ .workflowInputs.accountId }}
      validEventsFrom: "Transaction"
      eventCategory: "GOOD"
      conditionEventsFrom: "Transaction"
      conditionEventsWhere: "appName = 'checkout-api' AND error IS FALSE"
      target: 99.9
      windowDays: 28
      selectors:
        - name: sliGuid
          expression: ".data.serviceLevelCreate.guid"
    next: end

Mettre à jour un niveau de service

L’identifiant de l’action est newrelic.serviceLevel.update.

Met à jour la configuration d’un SLI existant ou ses objectifs de niveau de service. Utilise newrelic.nerdgraph.execute.

Les champs name et description sont individuellement facultatifs : omettre l’un ou l’autre préserve la valeur existante. Les champs target et windowDays sont indissociables : fournissez les deux pour modifier la cible de SLO, ou omettez les deux pour conserver le SLO existant inchangé.

Pour la configuration des événements (validEvents*, conditionEvents*, eventCategory, facets), l'omission d'un champ le supprime au lieu de le conserver. Pour modifier un champ dans la section des événements, fournissez à nouveau la définition complète des événements actuels avec la modification.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir	Type	Description	Exemple
sliGuid	Chaîne	Obligatoire. Le GUID du SLI. Utilisez la sortie du sélecteur `sliGuid` de `newrelic.serviceLevel.create` .	`"MXxFWFR8U0VSVklDRV9MRVZFTHwzMjk5NjE"`
name	Chaîne	Facultatif. Nouveau nom du SLI. L’omission préserve le nom existant.	`"Checkout API availability (v2)"`
description	Chaîne	Facultatif. Nouvelle description du SLI. L'omission préserve la description existante.	`"Tightened after Q3 reliability review"`
validEventsFrom	Chaîne	Facultatif. Type d’événement NRDB pour le pool d’événements valides. Requis si tout autre champ `validEvents` , `conditionEvents` , ou `eventCategory` est défini.	`"Transaction"`
validEventsWhere	Chaîne	Facultatif. Condition booléenne NRQL pour filtrer le pool d'événements valides.	`"appName = 'checkout-api'"`
validEventsSelectFunction	Chaîne	Facultatif. Fonction d’agrégation pour le pool d’événements valides. L’un de `COUNT` , `SUM` , `GET_FIELD` , `GET_CDF_COUNT` .	`"COUNT"`
validEventsSelectAttribute	Chaîne	Facultatif. Attribut à agréger pour le pool d'événements valides. Requis lorsque `validEventsSelectFunction` est `SUM` , `GET_FIELD` , ou `GET_CDF_COUNT` .	`"duration"`
validEventsSelectThreshold	Virgule flottante	Facultatif. Valeur de seuil pour le pool d’événements valides. Utilisé uniquement lorsque `validEventsSelectFunction` est `GET_CDF_COUNT` .	`500`
eventCategory	Chaîne	Facultatif. Classification du bucket d’événements de condition comme bons ou mauvais événements. Un de `GOOD` , `BAD` . Requis avec `conditionEventsFrom` lors de la définition de la configuration des événements.	`"GOOD"`
conditionEventsFrom	Chaîne	Facultatif. Type d’événement NRDB pour le bucket d’événements bons/mauvais.	`"Transaction"`
conditionEventsWhere	Chaîne	Facultatif. Condition booléenne NRQL pour filtrer le bucket d’événements bons/mauvais.	`"appName = 'checkout-api' AND error IS FALSE"`
conditionEventsSelectFunction	Chaîne	Facultatif. Fonction d’agrégation pour le compartiment des événements bons/mauvais. L’un de `COUNT` , `SUM` , `GET_FIELD` , `GET_CDF_COUNT` .	`"COUNT"`
conditionEventsSelectAttribute	Chaîne	Facultatif. Attribut à agréger pour le bucket bon/mauvais. Requis lorsque `conditionEventsSelectFunction` est `SUM` , `GET_FIELD` , ou `GET_CDF_COUNT` .	`"duration"`
conditionEventsSelectThreshold	Virgule flottante	Facultatif. Valeur de seuil pour le bucket bon/mauvais. Utilisé uniquement lorsque `conditionEventsSelectFunction` est `GET_CDF_COUNT` .	`500`
facettes	List	Facultatif. Attributs permettant de regrouper les résultats de SLI.	`["appName"]`
cible	Virgule flottante	Facultatif. Nouvelle cible de SLO en pourcentage. Tout ou rien avec `windowDays` : fournissez les deux ensemble ou omettez les deux.	`99.95`
windowDays	Int	Facultatif. Fenêtre glissante en jours. Doit être `1` , `7` , ou `28` lorsqu’il est défini. Tout-ou-rien avec `target` : fournissez les deux ensemble, ou omettez les deux.	`28`
selectors	List	Facultatif. Sélecteurs JQ pour extraire des valeurs spécifiques de la réponse.	`selectors: - name: sliGuid expression: ".data.serviceLevelUpdate.guid"`

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir	Type	Description
success	Booléen	`true` / `false` , hérité de l’appel `newrelic.nerdgraph.execute` sous-jacent, couvre à la fois les défaillances de transport et les erreurs de logique métier de NerdGraph.
errorMessage	Chaîne	Message d’erreur en cas d’échec, qu’il s’agisse d’une erreur au niveau du transport ou d’une erreur de logique métier NerdGraph. `null` en cas de succès.
données	Carte	Réponse NerdGraph : `{ "data": { "serviceLevelUpdate": { "guid": "MXxFWFR8U0VSVklDRV9MRVZFTHwzMjk5NjE", "name": "Checkout API availability (v2)" } } }` Utilisez `selectors` pour extraire `guid` ou `name` de `data`.

Sortir

Type

Description

success

Booléen

true

false

, hérité de l’appel

newrelic.nerdgraph.execute

sous-jacent, couvre à la fois les défaillances de transport et les erreurs de logique métier de NerdGraph.

errorMessage

Chaîne

Message d’erreur en cas d’échec, qu’il s’agisse d’une erreur au niveau du transport ou d’une erreur de logique métier NerdGraph.

null

en cas de succès.

données

Carte

Réponse NerdGraph :

{
  "data": {
    "serviceLevelUpdate": {
      "guid": "MXxFWFR8U0VSVklDRV9MRVZFTHwzMjk5NjE",
      "name": "Checkout API availability (v2)"
    }
  }
}

Utilisez selectors pour extraire guid ou name de data.

L’exemple suivant resserre la cible de SLO sur un SLI existant en utilisant le GUID capturé lors d’une étape newrelic.serviceLevel.create précédente.

Exemple de workflow
`name: newrelic_service_level_update_workflow description: Tighten the SLO target on an existing SLI steps: - name: tightenSlo type: action action: newrelic.serviceLevel.update version: 1 inputs: sliGuid: ${{ .steps.createSlo.outputs.sliGuid }} target: 99.95 windowDays: 28 next: end`

Exemple de workflow

name: newrelic_service_level_update_workflow
description: Tighten the SLO target on an existing SLI
steps:
  - name: tightenSlo
    type: action
    action: newrelic.serviceLevel.update
    version: 1
    inputs:
      sliGuid: ${{ .steps.createSlo.outputs.sliGuid }}
      target: 99.95
      windowDays: 28
    next: end

Supprimer un niveau de service

L’identifiant de l’action est newrelic.serviceLevel.delete.

Supprime un SLI (SLI) existant et ses objectifs de niveau de service (SLO). Utilise newrelic.nerdgraph.execute.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

sliGuid

Chaîne

Obligatoire.

Le GUID du SLI. Utilisez la sortie du sélecteur

sliGuid

newrelic.serviceLevel.create

"MXxFWFR8U0VSVklDRV9MRVZFTHwzMjk5NjE"

selectors

List

Facultatif.

Sélecteurs JQ pour extraire des valeurs spécifiques de la réponse.

selectors:
  - name: deletedGuid
    expression: ".data.serviceLevelDelete.guid"

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir	Type	Description
success	Booléen	`true` / `false` , hérité de l’appel `newrelic.nerdgraph.execute` sous-jacent, couvre à la fois les échecs de transport (non-200, erreur réseau) et les erreurs de logique métier NerdGraph (éventail `errors` sur une réponse par ailleurs 200).
errorMessage	Chaîne	Message d’erreur en cas d’échec, qu’il s’agisse d’une erreur au niveau du transport ou d’une erreur de logique métier NerdGraph. `null` en cas de succès.
données	Carte	Réponse NerdGraph : `{ "data": { "serviceLevelDelete": { "guid": "MXxFWFR8U0VSVklDRV9MRVZFTHwzMjk5NjE", "name": "Checkout API availability" } } }` Utilisez `selectors` pour extraire `guid` ou `name` de `data`.

Sortir

Type

Description

success

Booléen

true

false

, hérité de l’appel

newrelic.nerdgraph.execute

sous-jacent, couvre à la fois les échecs de transport (non-200, erreur réseau) et les erreurs de logique métier NerdGraph (éventail

errors

sur une réponse par ailleurs 200).

errorMessage

Chaîne

Message d’erreur en cas d’échec, qu’il s’agisse d’une erreur au niveau du transport ou d’une erreur de logique métier NerdGraph.

null

en cas de succès.

données

Carte

Réponse NerdGraph :

{
  "data": {
    "serviceLevelDelete": {
      "guid": "MXxFWFR8U0VSVklDRV9MRVZFTHwzMjk5NjE",
      "name": "Checkout API availability"
    }
  }
}

Utilisez selectors pour extraire guid ou name de data.

L’exemple suivant supprime un SLI à l’aide d’un GUID transmis en tant qu’entrée de workflow.

Exemple de workflow
`name: newrelic_service_level_delete_workflow description: Delete an existing SLI/SLO steps: - name: retireSlo type: action action: newrelic.serviceLevel.delete version: 1 inputs: sliGuid: ${{ .workflowInputs.sliGuid }} next: end`

Exemple de workflow

name: newrelic_service_level_delete_workflow
description: Delete an existing SLI/SLO
steps:
  - name: retireSlo
    type: action
    action: newrelic.serviceLevel.delete
    version: 1
    inputs:
      sliGuid: ${{ .workflowInputs.sliGuid }}
    next: end

Lister les niveaux de service

L’identifiant de l’action est newrelic.serviceLevel.list.

Répertorie les entités SLI, éventuellement limitées à un compte ou à un statut de conformité. Utilise newrelic.nerdgraph.execute.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir	Type	Description	Exemple
accountId	Int	Facultatif. Limite les résultats à un compte New Relic. L’omettre renvoie les SLI de tous les comptes accessibles au demandeur.	`11933347`
onlyNonCompliant	Booléen	Facultatif. Filtre de statut de conformité. Lorsque `true` , restreint les résultats aux SLI avec le tag `Non-compliant` ou `At risk` — équivalent au bouton bascule "Show only at risk and non-compliant" de l’interface utilisateur de la Gestion des niveaux de service. `false` et l’omission de ce champ renvoient tous les SLI, quel que soit le statut de conformité.	`true`
filtre	Chaîne	Facultatif. Clause de filtre `entitySearch` brute supplémentaire ajoutée à la requête.	`"name LIKE '%checkout%'"`
limit	Int	Facultatif. Taille de page pour les résultats.	`50`
curseur	Chaîne	Facultatif. Jeton de pagination provenant de la sortie `nextCursor` d’un appel précédent. Laissez vide lors du premier appel.	`"oWUNlXQ65ke3hEVGplVS1UOWJFRstmVTZFMVhj..."`
selectors	List	Facultatif. Sélecteurs JQ pour extraire des valeurs spécifiques de la réponse. Utilisez `.data.actor.entitySearch.results.entities` pour obtenir la liste des SLI, et `.data.actor.entitySearch.results.nextCursor` pour le jeton de pagination.	`selectors: - name: entities expression: ".data.actor.entitySearch.results.entities" - name: nextCursor expression: ".data.actor.entitySearch.results.nextCursor"`

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir	Type	Description
success	Booléen	`true` / `false` , hérité de l’appel `newrelic.nerdgraph.execute` sous-jacent, couvre à la fois les défaillances de transport et les erreurs de logique métier de NerdGraph.
errorMessage	Chaîne	Message d’erreur en cas d’échec, qu’il s’agisse d’une erreur au niveau du transport ou d’une erreur de logique métier NerdGraph. `null` en cas de succès.
données	Carte	Réponse NerdGraph brute. Utilisez `selectors` pour extraire `entities`, `count`, ou `nextCursor` de `data`. `nextCursor` est `null` lorsqu'il n'y a plus de pages. `{ "data": { "actor": { "entitySearch": { "count": 2, "results": { "entities": [ { "guid": "MXxFWFR8U0VSVklDRV9MRVZFTHwzMjk5NjE", "name": "Checkout API availability" } ], "nextCursor": null } } } } }`

Sortir

Type

Description

success

Booléen

true

false

, hérité de l’appel

newrelic.nerdgraph.execute

sous-jacent, couvre à la fois les défaillances de transport et les erreurs de logique métier de NerdGraph.

errorMessage

Chaîne

Message d’erreur en cas d’échec, qu’il s’agisse d’une erreur au niveau du transport ou d’une erreur de logique métier NerdGraph.

null

en cas de succès.

données

Carte

Réponse NerdGraph brute. Utilisez selectors pour extraire entities, count, ou nextCursor de data. nextCursor est null lorsqu'il n'y a plus de pages.

{
  "data": {
    "actor": {
      "entitySearch": {
        "count": 2,
        "results": {
          "entities": [
            {
              "guid": "MXxFWFR8U0VSVklDRV9MRVZFTHwzMjk5NjE",
              "name": "Checkout API availability"
            }
          ],
          "nextCursor": null
        }
      }
    }
  }
}

L’exemple suivant répertorie tous les SLI non conformes pour un compte et extrait la liste des entités à l’aide de selectors.

Exemple de workflow
`name: newrelic_service_level_list_workflow description: List non-compliant SLIs for an account steps: - name: findNonCompliantSlis type: action action: newrelic.serviceLevel.list version: 1 inputs: accountId: ${{ .workflowInputs.accountId }} onlyNonCompliant: true limit: 50 selectors: - name: entities expression: ".data.actor.entitySearch.results.entities" next: end`

Exemple de workflow

name: newrelic_service_level_list_workflow
description: List non-compliant SLIs for an account
steps:
  - name: findNonCompliantSlis
    type: action
    action: newrelic.serviceLevel.list
    version: 1
    inputs:
      accountId: ${{ .workflowInputs.accountId }}
      onlyNonCompliant: true
      limit: 50
      selectors:
        - name: entities
          expression: ".data.actor.entitySearch.results.entities"
    next: end

Cette traduction automatique est fournie pour votre commodité.

Prérequis.css-21sua1{background:none;border:none;width:0;padding:0;}

Créer un niveau de service

Mettre à jour un niveau de service

Supprimer un niveau de service

Lister les niveaux de service

Prérequis