Grabar y ver despliegue

The REST API for deployments is reaching end of life

The REST API v2 deployment endpoints (/v2/applications/{app_id}/deployments.json) documented on this page, along with the legacy Deployments v0 API, reach end of life on July 31, 2027. After that date, they won't be available.

Record deployments with the change tracking feature instead, using the NerdGraph changeTrackingCreateEvent mutation. For endpoint-by-endpoint mappings, see the Migrate from REST API v2 to NerdGraph guide. The REST instructions below remain as reference for existing integrations you're migrating.

Sugerencia

Change tracking is available for , , and .

Implementar una aplicación puede ser un evento riesgoso: cuando la aplicación falla y la causa suele ser un mal despliegue. New Relic le permite realizar un seguimiento del despliegue para que pueda correlacionarlo con los cambios en el rendimiento de su aplicación. El seguimiento desplegable crea marcadores de despliegue que aparecen en los gráficos y el dashboard de APM.

Vea cómo funciona el marcador de despliegue en este breve video (4:30 minutos):

Opciones de seguimiento desplegado

You can record new deployments and retrieve a list of past deployments with either the New Relic REST API v2 or NerdGraph. Use NerdGraph: the REST API v2 deployment endpoints reach end of life on July 31, 2027. Additionally, some APM agents offer agent-specific methods to automatically record deployments.

Puede utilizar su integración de Slack con New Relic, o un simple webhook, para notificar a su equipo en tiempo real sobre el despliegue de la aplicación monitor por APM. Slack proporciona una URL de webhook que le permite publicar JSON genérico que aparecerá formateado en un canal de Slack elegido.

Hay algunos lugares donde puedes ver el despliegue en la UI de New Relic después de que se hayan grabado:

En la fuente de actividad en las páginas Resumen de APM, Resumen de servicio y Resumen de entidad.
En gráficos de rendimiento de APM como marcadores de gráficos (líneas verticales con cabezas de alfiler).
En gráficos dashboard como marcadores de gráficos.
En la página desplegable para ver el resumen del rendimiento.

Sugerencia

El marcador de despliegue no está disponible para la aplicación browser , pero puedes probar estas alternativas:

Cambie del marcador de despliegue a la característica de seguimiento de cambios que le permite realizar un seguimiento de los cambios en la aplicación browser .
Consulte las versiones del navegador para conocer una forma de etiquetar errores con las versiones de lanzamiento.

Registro de implementación con la API REST

These REST endpoints reach end of life July 31, 2027

The REST API v2 deployment endpoints shown below reach end of life on July 31, 2027 and will stop working after that date. Migrate to the NerdGraph changeTrackingCreateEvent mutation, see the Migrate from REST API v2 to NerdGraph guide. These instructions remain for reference while you migrate existing integrations.

Puede utilizar la API REST v2 de New Relic para registrar el despliegue y obtener una lista del despliegue anterior.

Los ejemplos en este documento usan curl como herramienta de línea de comando. Sin embargo, puede usar cualquier método para realizar sus requests REST. También puede crear y ver despliegues con el API Explorer.
JSON utiliza comillas dobles " para los nombres de elementos y el contenido. El uso de comillas simples ' provocará errores.
Los ejemplos emplean X-Api-Key , que puede usar para una clave de usuario o una clave de API REST. Las claves de usuario son ahora la forma preferida de acceder a nuestras API REST, y puede emplear encabezados Api-Key al emplearlas.

Para grabar un nuevo despliegue, envíe una solicitud POST que incluya su clave de API al extremo de despliegue. Adjunte la carga útil en formato JSON (consulte Límites de caracteres y parámetro JSON). Todos los parámetros de carga útil son opcionales excepto revision.

Por ejemplo:

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"
$    }
$}'

Para grabar un despliegue con PowerShell, envíe una solicitud POST que incluya su clave de API al extremo de despliegue. Adjunte la carga útil en formato JSON (consulte Límites de caracteres y parámetro JSON). Todos los parámetros de carga útil son opcionales excepto revision.

Este ejemplo utiliza PowerShell versión 3 o superior:

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"
    }
}'

Este ejemplo utiliza PowerShell versión 2 (requiere .NET framework 3.5 o superior):

$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()

Para recuperar una lista de todo el despliegue anterior de su aplicación, envíe una solicitud GET que incluya su clave de API al extremo de despliegue. solicitud GET no utiliza una carga útil JSON.

Por ejemplo:

bash

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

Este ejemplo solicita una lista de implementación para el ID de aplicación 9999999:

bash

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

La API devuelve esta lista de implementación:

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 carga útil JSON puede incluir el siguiente parámetro.

Importante

Los caracteres UTF-8 de 4 bytes, como emojis y algunos glifos de idiomas no latinos, no se pueden utilizar en el texto desplegable.

Parámetro	Tipo de datos	Descripción
`revision`	Cadena, 127 caracteres máximo	Required. Un ID único para este despliegue, visible en la página Resumen y en la página de despliegue . Puede ser cualquier cadena, pero suele ser un número de versión o una suma de comprobación de Git.
`changelog`	Cadena, 65535 caracteres máximo	Optional. Un resumen de lo que cambió en este despliegue, visible en la página de despliegue cuando seleccionas (selected deployment) > Change log.
`description`	Cadena, 65535 caracteres máximo	Optional. Una descripción de alto nivel de este despliegue, visible en la página Resumen y en la página de despliegue cuando selecciona un despliegue individual.
`user`	Cadena, máximo 31 caracteres	Optional. Un nombre de usuario para asociar con el despliegue, visible en la página Resumen y en la página de despliegue .
`timestamp`	ISO 8601	Optional. Cuando se produjo el despliegue, hasta el segundo. Si no se especifica, el despliegue se registrará en el momento en que se recibió la llamada API. requisitos timestamp : Debe estar en hora UTC. Debe ser posterior a la timestamp de implementación más reciente. No puede ser en el futuro. Debe estar en formato ISO8601; por ejemplo, `"2019-10-08T00:15:36Z"`.

Grabar despliegue usando el agente New Relic

Importante

The REST API v2 methods referenced below reach end of life on July 31, 2027. Record deployments with the NerdGraph changeTrackingCreateEvent mutation instead, see the migration guide.

Algunos agentes tienen métodos adicionales para grabar el despliegue:

All agents: Use the New Relic REST API v2.
C: No SDK-specific methods. Use the REST API.
Go: No agent-specific methods. Use the REST API.
Java: Llame al agente de Java jar.
.NET: Utilice PowerShell y la API REST.
Node.js: No agent-specific methods. Use the REST API.
PHP: Utilice un script PHP.
Python: utilice el subcomando record-deploy del script newrelic-admin .
Ruby:Emplee una receta de Capistrano o el comando newrelic deployments . Más detalles aquí.

Ver detalles del despliegue

Después de configurar la información de despliegue, puede ver y profundizar en los detalles en la UI. Para obtener sugerencias, consulte nuestro documento de seguimiento de cambios Cómo ver y analizar sus cambios en New Relic.

Notifique a su equipo sobre el despliegue

Ya sea que esté realizando un seguimiento con la API REST o la API GraphQL más nueva, puede notificar a los miembros de su equipo mediante un webhook. Para obtener más información, consulte las instrucciones del webhook de seguimiento de cambios.

Te ofrecemos esta traducción automática para facilitar la lectura.

The REST API for deployments is reaching end of life

Sugerencia

Opciones de seguimiento desplegado

Sugerencia

Registro de implementación con la API REST

These REST endpoints reach end of life July 31, 2027

Grabar un despliegue con POST

Grabar un despliegue con PowerShell

Ver una lista de despliegue con GET

Salida de muestra de GET

Límites de caracteres y parámetro JSON

Importante

Grabar despliegue usando el agente New Relic

Importante

Ver detalles del despliegue

Notifique a su equipo sobre el despliegue

Te ofrecemos esta traducción automática para facilitar la lectura.

Grabar y ver despliegue

The REST API for deployments is reaching end of life

Sugerencia

Opciones de seguimiento desplegado .css-21sua1{background:none;border:none;width:0;padding:0;}

Sugerencia

Registro de implementación con la API REST

These REST endpoints reach end of life July 31, 2027

Grabar un despliegue con PowerShell

Ver una lista de despliegue con GET

Límites de caracteres y parámetro JSON

Grabar despliegue usando el agente New Relic

Importante

Ver detalles del despliegue

Notifique a su equipo sobre el despliegue

Opciones de seguimiento desplegado