API REST d'événement incident

Vous pouvez utiliser l' API événement pour signaler un événement déclencheur d'alerte d' incident personnalisé à New Relic. Cet événement ne crée pas directement un incident, mais il déclenche la création de l'incident.

L'API est un point de terminaison asynchrone. Cela signifie que vous pouvez envoyer un grand volume de messages, de manière fiable, avec une faible latence de réponse.

Utilisation de l'API : aperçu

Voici le processus général pour envoyer un événement incident personnalisé à New Relic via l'API d'événement incident :

Générez un pour le compte auquel vous souhaitez signaler des données.
Avant de commencer à créer un attribut personnalisé, examinez les limites et les caractères restreints de l'API d'événement.
Générez le JSON pour votre événement d'incident qui suit nos directives de format JSON.
Soumettez une charge utile JSON compressée (par exemple, gzip ou deflate) au point de terminaison HTTPS à l'aide de curl dans une requête POST.

Une fois que vous avez commencé à envoyer des données d'événements incident à New Relic, nous vous recommandons de configurer la condition d'alerte NRQL pour recevoir une notification sur les erreurs d'analyse.

Exemple JSON

Votre charge utile JSON peut ressembler à cet exemple.

[
  {
    "eventType": "NrAiIncidentExternal",
    "title": "Test",
    "description": "The latency is above threshold of 500000 MS",
    "state": "trigger",
    "source": "luna",
    "entityName": "testEntity",
    "entity.guid": "testEntity123",
    "aggregationTag.serviceId": 5,
    "aggregationTag.environment": "testing",
    "aggregationTag.errorId": 10543,
    "tag.stackTrace": "some stack trace...",
    "version": 1
  }
]

Le champ eventType doit utiliser NrAiIncidentExternal.

Envoyez votre événement d'incident depuis la ligne de commande

Voici un exemple d'utilisation de curl pour envoyer votre charge utile JSON.

bash

$gzip -c example_incidents.json | curl --data-binary @-  \
>-X POST -H "Content-Type: application/json"  \
>-H "Api-Key: YOUR_LICENSE_KEY" -H "Content-Encoding: gzip" \
>https://insights-collector.newrelic.com/v1/accounts/YOUR_ACCOUNT/events

Response
{"success":true, "uuid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}%

Une fois que vous avez envoyé avec succès vos données d'événement incident, vous pouvez les voir dans l'UI des alertes ou en interrogeant ces données.

Spécification de l'API d'événement incident

L'API incident événement utilise les types de valeur de l'API événement. Pour obtenir des descriptions de ces types de valeurs et des instructions sur leur utilisation, consultez nos directives JSON pour l'API événement.

Prudence

Si vous créez deux événements déclencheurs avec exactement le même aggregationTag, ils seront agrégés dans le même incident. Cela signifie qu'un seul incident est créé à partir de plusieurs déclencheurs.

Champ	Description
`aggregationTag.` chaîne, nombre* ou horodatage	REQUIRED Tout attribut préfixé par `aggregationTag` sera utilisé pour regrouper les événements déclencheurs. En d'autres termes, deux événements déclencheurs avec la même balise d'agrégation sont agrégés au même incident. (En supposant qu'aucun des événements déclencheurs ne soit un événement résolu). Lors de la résolution d'un incident, il est important que l'événement de résolution inclue la même balise d'agrégation. Les balises d'agrégation avec des mots-clés réservés sont filtrées. Par exemple, dans une charge JSON avec `aggregationTag.priority: 2` cette paire valeur clé sera omise dans l'événement incident avec ces mots-clés réservés : `reserved_key: {"priority", "accountId", "originalAccountId", "policyId", "conditionId", "aggregationKey", "entityType", "entityName", "entityId", "violationUuid", "violationId", "nrIncidentId" }`
`state` énumération : (`trigger`, `resolve`)	REQUIRED Si l'événement doit déclencher un nouvel incident ou résoudre un incident existant. Les mises à jour de l'incident peuvent également être envoyées à l'aide d'un déclencheur.
`priority` énumération : (`low`, `medium`, `high`, `critical`)	La priorité de l'incident. Par défaut : `high`. La priorité la plus élevée sera utilisée lorsque des priorités différentes sont envoyées.
`title` chaîne	REQUIRED, when `state` is `trigger` Le titre de l'événement déclencheur.
`source` chaîne	REQUIRED, when `state` is `trigger` L'origine de l' incident, ou le système monitoring qui l'a déclenché (et non l'entité fautive).
`description` chaîne	La description de l'événement déclencheur.
`deepLinkUrl` chaîne	Un lien profond vers une page liée à l'incident.
`runbookUrl` chaîne	Une URL runbook .
`externalId` chaîne	Un identifiant externe que vous pouvez attacher à l'événement. Par exemple, il peut être utilisé pour interroger les erreurs liées à l'ingestion de cet événement.
`entityName` chaîne	Le nom de l'entité qui a généré l'incident.
`entity.guid` chaîne	L'ID de l'entité qui a généré l'incident.
`version` virgule flottante	La version actuelle du format.

Champ

Description

aggregationTag.*

chaîne, nombre ou horodatage

REQUIRED

Tout attribut préfixé par aggregationTag sera utilisé pour regrouper les événements déclencheurs.

En d'autres termes, deux événements déclencheurs avec la même balise d'agrégation sont agrégés au même incident. (En supposant qu'aucun des événements déclencheurs ne soit un événement résolu).

Lors de la résolution d'un incident, il est important que l'événement de résolution inclue la même balise d'agrégation.

Les balises d'agrégation avec des mots-clés réservés sont filtrées. Par exemple, dans une charge JSON avec aggregationTag.priority: 2 cette paire valeur clé sera omise dans l'événement incident avec ces mots-clés réservés :

reserved_key: {"priority",  "accountId", "originalAccountId", "policyId", "conditionId", "aggregationKey", "entityType", "entityName", "entityId", "violationUuid", "violationId", "nrIncidentId" }

state

énumération : (trigger, resolve)

REQUIRED

Si l'événement doit déclencher un nouvel incident ou résoudre un incident existant. Les mises à jour de l'incident peuvent également être envoyées à l'aide d'un déclencheur.

priority

énumération : (low, medium, high, critical)

La priorité de l'incident. Par défaut : high.

La priorité la plus élevée sera utilisée lorsque des priorités différentes sont envoyées.

title

chaîne

REQUIRED, when state is trigger

Le titre de l'événement déclencheur.

source

chaîne

REQUIRED, when state is trigger

L'origine de l' incident, ou le système monitoring qui l'a déclenché (et non l'entité fautive).

description

chaîne

La description de l'événement déclencheur.

deepLinkUrl

chaîne

Un lien profond vers une page liée à l'incident.

runbookUrl

chaîne

Une URL runbook .

externalId

chaîne

Un identifiant externe que vous pouvez attacher à l'événement.

Par exemple, il peut être utilisé pour interroger les erreurs liées à l'ingestion de cet événement.

entityName

chaîne

Le nom de l'entité qui a généré l'incident.

entity.guid

chaîne

L'ID de l'entité qui a généré l'incident.

version

virgule flottante

La version actuelle du format.

Cette traduction automatique est fournie pour votre commodité.

Utilisation de l'API : aperçu .css-21sua1{background:none;border:none;width:0;padding:0;}

Exemple JSON

Envoyez votre événement d'incident depuis la ligne de commande

Spécification de l'API d'événement incident

Prudence

Utilisation de l'API : aperçu