Cadastre e visualize implantação

A API REST para implantações está chegando ao fim da vida útil

Os endpoints de implantação da API REST v2 (/v2/applications/{app_id}/deployments.json) documentados nesta página, junto com a API de implantações v0 legada, chegarão ao fim da vida útil em 31 de julho de 2027. Após essa data, eles não estarão disponíveis.

Em vez disso, registre implantações com o recurso de Monitoramento de Alterações, usando a mutação changeTrackingCreateEvent do NerdGraph. Para mapeamentos de endpoint por endpoint, consulte o guia Migrar da API REST v2 para o NerdGraph. As instruções REST abaixo permanecem como referência para integrações existentes que estão sendo migradas.

Dica

O Monitoramento de Alterações está disponível para , e .

Implantar um aplicativo pode ser um evento arriscado – quando seu aplicativo quebra e uma implantação incorreta costuma ser a causa. O New Relic permite que você rastreie a implantação para que você possa correlacionar a implantação com as mudanças no desempenho do seu aplicativo. O rastreamento de implantações cria um marcador de implantação que aparece nos gráficos e no painel do APM.

Veja como funciona o marcador de implantação neste pequeno vídeo (4:30 minutos):

Opções para rastreamento de implantação

Você pode registrar novas implantações e recuperar uma lista de implantações anteriores com a API REST v2 da New Relic ou com o NerdGraph. Use o NerdGraph: os endpoints de implantação da API REST v2 chegam ao fim da vida útil em 31 de julho de 2027. Além disso, alguns agentes APM oferecem métodos específicos do agente para registrar implantações automaticamente.

Você pode usar sua integração do Slack com o New Relic, ou um simples webhook, para notificar sua equipe em tempo real da implantação do aplicativo monitor pelo APM. O Slack fornece um URL de webhook que permite postar JSON genérico que aparecerá formatado em um canal escolhido do Slack.

Existem alguns lugares onde você pode visualizar a implantação na interface do New Relic depois de gravada:

No feed de atividades nas páginas Resumo do APM, Resumo do serviço e Resumo da entidade.
Em gráficos de desempenho APM como marcadores de gráfico (linhas verticais com cabeças de alfinete).
Em gráficos dashboard como marcadores de gráfico.
Na página de implantação para resumo do desempenho.

Dica

Marcador de implantação não estão disponíveis para aplicativo de browser, mas você pode tentar estas alternativas:

Mude do marcador de implantação para o recurso Monitoramento de Alterações que permite rastrear alterações no aplicativo do browser.
Consulte as versões do browser para saber como tag erros com as versões de lançamento.

Registrar implantação com a API REST

Esses endpoints REST chegam ao fim da vida útil em 31 de julho de 2027

Os endpoints de implantação da API REST v2 mostrados abaixo chegam ao fim da vida útil em 31 de julho de 2027 e deixarão de funcionar após essa data. Migre para a mutação changeTrackingCreateEvent do NerdGraph, consulte o guia Migrar da API REST v2 para o NerdGraph. Essas instruções permanecem para referência durante a migração de integrações existentes.

Você pode usar a API REST v2 do New Relic para registrar a implantação e obter uma lista de implantações anteriores.

Os exemplos neste documento usam curl como uma ferramenta de linha de comando. No entanto, você pode usar qualquer método para fazer suas requests REST. Você também pode criar e visualizar implantações com o API Explorer.
JSON usa aspas duplas " para nomes de elementos e conteúdo. Usar aspas simples ' causará erros.
Os exemplos usam X-Api-Key que pode ser usado para uma chave de usuário ou uma chave de API REST. As chaves de usuário agora são a maneira preferida de acessar nossas APIs REST, e você pode usar cabeçalhos Api-Key ao utilizá-las.

Para registrar uma nova implantação, envie uma solicitação POST que inclua sua chave de API para o endpoint de implantações. Anexe o payload no formato JSON (consulte Limites de caracteres e parâmetro JSON). Todos os parâmetros de carga útil são opcionais, exceto revision.

Por exemplo:

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 registrar uma implantação com o PowerShell, envie uma solicitação POST que inclua sua chave de API para o endpoint de implantação. Anexe o payload no formato JSON (consulte Limites de caracteres e parâmetro JSON). Todos os parâmetros de carga útil são opcionais, exceto revision.

Este exemplo usa o PowerShell versão 3 ou 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 exemplo usa o PowerShell versão 2 (requer .NET framework 3.5 ou 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 uma lista de todas as implantações anteriores do seu aplicativo, envie uma solicitação GET que inclua sua chave de API para o endpoint de implantação. solicitação GET não usa uma carga JSON.

Por exemplo:

bash

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

Este exemplo solicita uma lista de implantação para o app ID 9999999:

bash

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

A API retorna esta lista de implantação:

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

A carga JSON pode incluir o seguinte parâmetro.

Importante

Caracteres UTF-8 de 4 bytes, como Emojis e alguns glifos de idiomas não latinos, não podem ser usados no texto de implantação.

Parâmetro	Tipo de dados	Descrição
`revision`	String, máximo de 127 caracteres	Required. Um ID único para esta implantação, visível na página Resumo e na página Implantações . Pode ser qualquer string, mas geralmente é um número de versão ou uma soma de verificação do Git.
`changelog`	String, máximo de 65.535 caracteres	Optional. Um resumo do que mudou nesta implantação, visível na página Implantações ao selecionar (selected deployment) > Change log.
`description`	String, máximo de 65.535 caracteres	Optional. Uma descrição resumida desta implantação, visível na página Resumo e na página Implantações quando você seleciona uma implantação individual.
`user`	String, máximo de 31 caracteres	Optional. Um nome de usuário para associar à implantação, visível na página Resumo e na página Implantações .
`timestamp`	ISO 8601	Optional. Quando a implantação ocorreu, até o segundo. Se não for especificado, a implantação será registrada no momento em que a chamada de API foi recebida. requisitos timestamp : Deve estar no horário UTC. Deve ser posterior ao timestamp de implantação mais recente. Não pode estar no futuro. Deve estar no formato ISO8601; por exemplo, `"2019-10-08T00:15:36Z"`.

Registrar implantação usando o agente New Relic

Importante

Os métodos da API REST v2 referenciados abaixo chegam ao fim da vida útil em 31 de julho de 2027. Registre as implantações com a mutação changeTrackingCreateEvent do NerdGraph em vez disso, consulte o guia de migração.

Alguns agentes possuem métodos adicionais para registrar a implantação:

All agents: use a API REST v2 da New Relic.
C: sem métodos específicos do SDK. Use a API REST.
Go: sem métodos específicos do agente. Use a API REST.
Java: Chame o agente Java jar.
.NET: Use o PowerShell e a API REST.
Node.js: sem métodos específicos do agente. Use a API REST.
PHP: Use um script PHP.
Python: use o subcomando record-deploy do script newrelic-admin .
Ruby: Use uma receita do Capistrano ou o comando newrelic deployments . Mais detalhes aqui.

Ver detalhes da implantação

Depois de configurar as informações de implantação, você poderá visualizar e detalhar os detalhes na interface do usuário. Para dicas, consulte nosso documento Monitoramento de Alterações Como visualizar e analisar suas alterações no New Relic.

Avise sua equipe sobre implantação

Esteja você rastreando a implantação com a API REST ou a API GraphQL mais recente, você pode notificar os membros da sua equipe usando um webhook. Para obter detalhes, consulte as instruções do webhook do Monitoramento de Alterações.

Esta tradução de máquina é fornecida para sua comodidade.

A API REST para implantações está chegando ao fim da vida útil

Dica

Opções para rastreamento de implantação

Dica

Registrar implantação com a API REST

Esses endpoints REST chegam ao fim da vida útil em 31 de julho de 2027

Grave uma implantação com POST

Grave uma implantação com PowerShell

Veja lista de implantação com GET

Exemplo de saída de GET

Limites de caracteres e parâmetro JSON

Importante

Registrar implantação usando o agente New Relic

Importante

Ver detalhes da implantação

Avise sua equipe sobre implantação

Esta tradução de máquina é fornecida para sua comodidade.

Cadastre e visualize implantação

A API REST para implantações está chegando ao fim da vida útil

Dica

Opções para rastreamento de implantação .css-21sua1{background:none;border:none;width:0;padding:0;}

Dica

Registrar implantação com a API REST

Esses endpoints REST chegam ao fim da vida útil em 31 de julho de 2027

Grave uma implantação com PowerShell

Veja lista de implantação com GET

Limites de caracteres e parâmetro JSON

Registrar implantação usando o agente New Relic

Importante

Ver detalhes da implantação

Avise sua equipe sobre implantação

Opções para rastreamento de implantação