Enregistrer et visualiser le déploiement

L’API REST pour les déploiements arrive en fin de vie

Les points de terminaison de déploiement de l'API REST v2 (/v2/applications/{app_id}/deployments.json) documentés sur cette page, ainsi que l'API legacy de déploiement v0, atteignent leur fin de vie le 31 juillet 2027. Après cette date, ils ne seront pas disponibles.

Enregistrez les déploiements avec la fonctionnalité de suivi des changements à la place, en utilisant la mutation NerdGraph changeTrackingCreateEvent. Pour les modélisations point de terminaison par point de terminaison, consultez le guide Migrate from REST API v2 to NerdGraph. Les instructions REST ci-dessous restent à titre de référence pour les intégrations existantes que vous migrez.

Conseil

Le suivi des changements est disponible pour , , et .

Le déploiement d'une application peut être un événement risqué : votre application tombe en panne et un mauvais déploiement en est souvent la cause. New Relic vous permet de suivre le déploiement afin que vous puissiez corréler le déploiement avec les changements dans les performances de votre application. Le suivi déployé crée des marqueurs de déploiement qui apparaissent dans les graphiques et le dashboard APM.

Découvrez comment fonctionne le marqueur de déploiement dans cette courte vidéo (4:30 minutes) :

Options de suivi déployé

Vous pouvez enregistrer de nouveaux déploiements et récupérer une liste des déploiements passés avec l'API REST v2 de New Relic ou NerdGraph. Utilisez NerdGraph : les points de terminaison de déploiement de l'API REST v2 atteignent leur fin de vie le 31 juillet 2027. De plus, certains agents APM offrent des méthodes spécifiques à l'agent pour enregistrer automatiquement les déploiements.

Vous pouvez utiliser votre intégration Slack avec New Relic, ou un simple webhook, pour notifier votre équipe en temps réel du déploiement du moniteur d'applications par APM. Slack fournit une URL de webhook qui vous permet de publier du JSON générique qui apparaîtra formaté dans un canal Slack choisi.

Il existe quelques endroits où vous pouvez visualiser le déploiement dans l'UI de New Relic après leur enregistrement :

Dans le flux d'activité des pages Résumé APM, Résumé du service et Résumé de l'entité.
Sur les graphiques de performances APM sous forme de marqueurs de graphique (lignes verticales avec des têtes d'épingle).
Sur les graphiques dashboard comme marqueurs de graphique.
Sur la page déploiement pour un résumé des performances.

Conseil

Les marqueurs de déploiement ne sont pas disponibles pour les applications de navigateur, mais vous pouvez essayer ces alternatives :

Passez du marqueur de déploiement à la fonctionnalité de suivi des changements qui vous permet de suivre les modifications apportées à l'application du navigateur.
Consultez le navigateur sortie pour savoir comment tag les erreurs avec les versions sortie.

Déploiement d'enregistrement avec l'API REST

Ces points de terminaison REST atteignent leur fin de vie le 31 juillet 2027

Les points de terminaison de déploiement de l’API REST v2 présentés ci-dessous arrivent en fin de vie le 31 juillet 2027 et cesseront de fonctionner après cette date. Migrez vers la mutation NerdGraph changeTrackingCreateEvent, consultez le guide Migrer de l’API REST v2 vers NerdGraph. Ces instructions restent à titre de référence pendant que vous migrez les intégrations existantes.

Vous pouvez utiliser l'API New Relic REST v2 pour enregistrer le déploiement et obtenir une liste des déploiements passés.

Les exemples de ce document utilisent curl comme outil de ligne de commande. Cependant, vous pouvez utiliser n'importe quelle méthode pour effectuer vos requests REST. Vous pouvez également créer et visualiser le déploiement avec l'API Explorer.
JSON utilise des guillemets doubles " pour les noms et le contenu des éléments. L'utilisation de guillemets simples ' provoquera des erreurs.
Les exemples utilisent X-Api-Key qui peut être utilisé soit pour une clé utilisateur , soit pour une clé API REST. Les clés utilisateur sont désormais le moyen privilégié d’accéder à nos API REST, et vous pouvez utiliser les en-têtes Api-Key lorsque vous les utilisez.

Pour enregistrer une nouvelle déploiement, envoyez une requête POST incluant votre clé API au point de terminaison du déploiement. Attachez la charge utile au format JSON (voir Limites de caractères et paramètres JSON). Tous les paramètres de charge utile sont facultatifs, à l'exception de revision.

Par exemple:

bash

$curl -X POST "https://api.newrelic.com/v2/applications/$APP_ID/deployments.json" \
>     -H "X-Api-Key:$API_KEY" \
>     -i \
>     -H "Content-Type: application/json" \
>     -d \
>'{
$    "deployment": {
$        "revision": "REVISION",
$        "changelog": "Added: /v2/deployments.rb, Removed: None",
$        "description": "Added a deployments resource to the v2 API",
$        "user": "datanerd@example.com",
$        "timestamp": "2019-10-08T00:15:36Z"
$    }
$}'

Pour enregistrer une déploiement avec PowerShell, envoyez une requête POST qui inclut votre clé API au point de terminaison du déploiement. Attachez la charge utile au format JSON (voir Limites de caractères et paramètres JSON). Tous les paramètres de charge utile sont facultatifs, à l'exception de revision.

Cet exemple utilise PowerShell version 3 ou supérieure :

Invoke-WebRequest -Uri https://api.newrelic.com/v2/applications/YOUR_APP_ID/deployments.json -Method POST -Headers @{'X-Api-Key'='$API_KEY'} -ContentType 'application/json' -Body '{
    "deployment": {
        "revision": "REVISION",
        "changelog": "Added: /v2/deployments.rb, Removed: None",
        "description": "Added a deployments resource to the v2 API",
        "user": "datanerd@example.com",
        "timestamp": "2019-10-08T00:15:36Z"
    }
}'

Cet exemple utilise PowerShell version 2 (nécessite .NET framework 3.5 ou supérieur) :

$encoding = [System.Text.Encoding]::GetEncoding("ASCII")
$data ='{
    "deployment": {
        "revision": "REVISION",
        "changelog": "Added: /v2/deployments.rb, Removed: None",
        "description": "Added a deployments resource to the v2 API",
        "user": "datanerd@example.com",
        "timestamp": "2019-10-08T00:15:36Z"
    }
}'
$postData = $encoding.GetBytes($data)
$request = [System.Net.WebRequest]::Create('https://api.newrelic.com/v2/applications/$APP_ID/deployments.json')
$request.Method = 'POST'
$request.Headers.add('X-Api-Key','$API_KEY')
$request.ContentType='application/json'
$stream = $request.GetRequestStream()
$stream.Write($postData,0,$postData.Length)
$request.GetResponse()

Pour récupérer une liste de tous les déploiements passés de votre application, envoyez une requête GET qui inclut votre clé API au point de terminaison de déploiement. la requête GET n'utilise pas de charge JSON.

Par exemple:

bash

$curl -X GET "https://api.newrelic.com/v2/applications/$APP_ID/deployments.json" \
>     -H "X-Api-Key:$API_KEY" \
>     -i

Cet exemple requests une liste de déploiement pour l'ID d'application 9999999:

bash

$curl -X GET "https://api.newrelic.com/v2/applications/9999999/deployments.json" \
>     -H "X-Api-Key:ABCDEFGHIJKLMNOPQRSTUVWXabcdefghijklmnopqrstuvwx" \
>     -i

L'API renvoie cette liste de déploiement :

HTTP/1.1 200 OK
ETag: "ABCDEFGHIJKabcdefghijk0123456789"
Cache-Control: max-age=0, private, must-revalidate
Content-Type: application/json
{
  "deployments": [
    {
      "id": 1234567,
      "revision": "1234123412341234123412341234123412341234",
      "changelog": "Fixed the bugs for real this time",
      "description": "Example description two",
      "user": "Data Nerd",
      "timestamp": "2016-02-24T10:09:27-08:00",
      "links": {
        "application": 9999999
      }
    },
    {
      "id": 2345678,
      "revision": "7890789078907890789078907890789078907890",
      "changelog": "Think I fixed all the bugs",
      "description": null,
      "user": "Dren Atad",
      "timestamp": "2014-10-22T12:23:47-07:00",
      "links": {
        "application": 9999999
      }
    }
  ],
  "links": {
    "deployment.agent": "/v2/applications/{application_id}"
  }
}

La charge utile JSON peut inclure les paramètres suivants.

Important

Les caractères UTF-8 de 4 octets, tels que les émojis et certains glyphes de langues non latines, ne peuvent pas être utilisés dans le texte de déploiement.

paramètres	Type de données	Description
`revision`	Chaîne, 127 caractères maximum	Required. Un identifiant unique pour ce déploiement, visible dans la page Résumé et sur la page de déploiement . Peut être n'importe quelle chaîne, mais il s'agit généralement d'un numéro de version ou d'une somme de contrôle Git.
`changelog`	Chaîne, 65535 caractères maximum	Optional. Un résumé de ce qui a changé dans ce déploiement, visible dans la page de déploiement lorsque vous sélectionnez (selected deployment) > Change log.
`description`	Chaîne, 65535 caractères maximum	Optional. Une description de haut niveau de ce déploiement, visible dans la page Résumé et sur la page de déploiement lorsque vous sélectionnez un déploiement individuel.
`user`	Chaîne, 31 caractères maximum	Optional. Un nom d'utilisateur à associer au déploiement, visible dans la page Résumé et sur la page de déploiement .
`timestamp`	ISO 8601	Optional. Lorsque le déploiement a eu lieu, à la seconde près. Sauf précision, le déploiement sera enregistré au moment de la réception de l'appel d'API. Exigences en matière d’horodatage : Doit être en heure UTC. Doit être postérieur à l'horodatage de déploiement le plus récent. Cela ne peut pas être dans le futur. Doit être au format ISO8601 ; par exemple, `"2019-10-08T00:15:36Z"`.

Enregistrement du déploiement à l'aide de l'agent New Relic

Important

Les méthodes de l’API REST v2 référencées ci-dessous arrivent en fin de vie le 31 juillet 2027. Enregistrez plutôt les déploiements avec la mutation NerdGraph changeTrackingCreateEvent, consultez le guide de migration.

Certains agents disposent de méthodes supplémentaires pour enregistrer les déploiements :

All agents: utilisez l’ API REST New Relic v2.
C: aucune méthode spécifique au SDK. Utilisez l’ API REST.
Go: aucune méthode spécifique à l’agent. Utilisez l’ API REST.
Java: Appelez l'agent Java jar.
.NET:Utilisez PowerShell et l'API REST.
Node.js: aucune méthode spécifique à l’agent. Utilisez l’ API REST.
PHP:Utilisez un script PHP.
Python:Utilisez la sous-commande record-deploy du script newrelic-admin .
Ruby: Utilisez une recette Capistrano ou la commande newrelic deployments . Plus de détails ici.

Afficher les détails du déploiement

Après avoir configuré les informations de déploiement, vous pouvez afficher et explorer les détails dans l'UI. Pour obtenir des conseils, consultez notre document de suivi des changements Comment visualiser et analyser vos modifications dans New Relic.

Informez votre équipe de l'échec

Que vous suiviez le déploiement avec l'API REST ou la nouvelle APIGraphQL , vous pouvez informer les membres de votre équipe à l'aide d'un webhook. Pour plus de détails, consultez les instructions du webhook de suivi des changements .

Cette traduction automatique est fournie pour votre commodité.

Enregistrer et visualiser le déploiement

L’API REST pour les déploiements arrive en fin de vie

Conseil

Options de suivi déployé

Conseil

Déploiement d'enregistrement avec l'API REST

Ces points de terminaison REST atteignent leur fin de vie le 31 juillet 2027

Enregistrer un déploiement avec POST

Enregistrer un déploiement avec PowerShell

Afficher une liste de déploiement avec GET

Exemple de sortie de GET

Limites de caractères et paramètres JSON

Important

Enregistrement du déploiement à l'aide de l'agent New Relic

Important

Afficher les détails du déploiement

Informez votre équipe de l'échec

Cette traduction automatique est fournie pour votre commodité.

Enregistrer et visualiser le déploiement

L’API REST pour les déploiements arrive en fin de vie

Conseil

Options de suivi déployé .css-21sua1{background:none;border:none;width:0;padding:0;}

Conseil

Déploiement d'enregistrement avec l'API REST

Ces points de terminaison REST atteignent leur fin de vie le 31 juillet 2027

Enregistrer un déploiement avec PowerShell

Afficher une liste de déploiement avec GET

Limites de caractères et paramètres JSON

Enregistrement du déploiement à l'aide de l'agent New Relic

Important

Afficher les détails du déploiement

Informez votre équipe de l'échec

Options de suivi déployé