Envie evento personalizado com nossa API de eventos

A API de eventos permite enviar dados de eventos personalizados para o New Relic. Estes eventos podem então ser consultados e mapeados.

Quer experimentar nossa API de eventos? Crie uma conta New Relic gratuitamente! Não é necessário cartão de crédito.

Conteúdo Relacionado:

• Conheça todas as opções de reporte de evento personalizado.
• Para saber como adicionar atributo a um evento existente, consulte Adicionar atributo personalizado.

Por que usar a API de eventos?

Nossa API de eventos é uma opção para relatar dados personalizados. Outra opção é reportar atributo personalizado. Para uma visão geral de por que você usaria a API de evento em vez de outras opções, consulte evento personalizado e atributo.

Requisitos

Para limites de API de eventos e atributo restrito, consulte Limites.

Certifique-se de que a conectividade de saída na porta TCP 443 seja permitida para o intervalo CIDR que corresponde à sua região. O método de configuração preferencial é usar o nome DNS insights-collector.newrelic.com ou insights-collector.eu01.nr-data.net.

Exemplo de envio e consulta de um evento personalizado

Aqui está um exemplo da API de evento em ação:

# Hook into the runtime 'at_exit' event
at_exit do
  # Name the custom event
  payload = { 'eventType' => 'CLIRun' }

  # Check to see if the process is exiting due to an error
  if $!.nil? || $!.is_a?(SystemExit) && $!.success?
    payload[:status] = 0
  else
    # Gather any known errors
    errors = ""
    (Thread.current[:errors] ||= []).each do |err|
      errors += "#{err}\n"
    end
    payload[:errors] = errors
  end

  # Send the errors to New Relic as a custom event
  insights_url = URI.parse("https://insights-collector.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/events")
  headers = { "Api-Key" => "YOUR_LICENSE_KEY", "content-type" => "application/json" }

  http = Net::HTTP.new(insights_url.host, insights_url.port)
  http.use_ssl = true
  request = Net::HTTP::Post.new(insights_url.request_uri, headers)
  request.body = payload.to_json

  puts "Sending run summary to New Relic: #{payload.to_json}"
  begin
    response = http.request(request)
    puts "Response from New Relic: #{response.body}"
  rescue Exception => e
    puts "There was an error posting to New Relic. Error: #{e.inspect}"
  end
end

SELECT count(*) FROM CLIRun FACET errors SINCE 1 week ago

Como usar a API de eventos

A API do evento é um endpoint assíncrono. Isso permite enviar um volume muito grande de POSTS, de forma confiável, com latência de resposta muito baixa.

Para enviar um evento personalizado para uma conta New Relic:

1. Obtenha um

   chave de licença

   para a conta para a qual você deseja relatar dados.

2. Before creating custom events or attributes, review our list of reserved terms used by NRQL.

3. Gere JSON para o evento por instrumento de sua aplicação, consultando uma API, ou algum outro método.

4. Envie uma carga JSON compactada (por exemplo, gzip ou deflate) para o endpoint HTTPS usando curl em uma solicitação

   POST

   .

5. Recommendation:

   Configure a condição do alerta do NRQL para notificá-lo quando ocorrerem erros de análise .

A API do evento limita o tamanho, taxa e caracteres permitidos no evento personalizado. Além disso, assim como outros dados disponíveis no NRQL, os eventos personalizados não podem ser atualizados ou excluídos após serem criados. Se você tiver problemas com seu evento personalizado, siga os procedimentos de resolução de problemas ou crie um novo evento personalizado.

Formate o JSON

A API do evento aceita formatos específicos para atributos incluídos no payload. Somente valores float ou string são permitidos.

[
  {
    "eventType": "Purchase",
    "account": 3,
    "amount": 259.54
  },
  {
    "eventType": "Purchase",
    "account": 5,
    "amount": 12309,
    "product": "Item"
  }
]

Envie o evento personalizado

Os dados enviados à API do evento usam um formato JSON compactado em uma solicitação HTTPS POST simples. Este exemplo usa gzip, mas você também pode usar deflate.

$
gzip -c example_events.json | curl -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_ID/events --data-binary @-

$accountId = "YOUR_ACCOUNT_ID"
$insertkey = "YOUR_LICENSE_KEY"
# Replace with your custom event for the body
$body = '[{"eventType": "powershell", "account": 4, "amount": 123, "fileLocation": "c:\\temp2", "zipped": "true" }]'

$headers = @{}
$headers.Add("Api-Key", "$insertkey")
$headers.Add("Content-Encoding", "gzip")


$encoding = [System.Text.Encoding]::UTF8
$enc_data = $encoding.GetBytes($body)

$output = [System.IO.MemoryStream]::new()
$gzipStream = New-Object System.IO.Compression.GzipStream $output, ([IO.Compression.CompressionMode]::Compress)

$gzipStream.Write($enc_data, 0, $enc_data.Length)
$gzipStream.Close()
$gzipBody = $output.ToArray()

Invoke-WebRequest -Headers $headers -Method Post -Body $gzipBody  "https://insights-collector.newrelic.com/v1/accounts/$accountId/events"

Antes de gerar sua solicitação HTTP, certifique-se de que ela esteja formatada corretamente, incluindo:

• O Api-Key contém o

  chave de licença

  correto.

• O Content-Type é application/json.

• A solicitação usa apenas POST. A API não aceita PUT e solicitação GET.

A API oferece suporte a conexões persistentes HTTP/1.1. Isso é útil para gerenciar o desempenho do lado do cliente sob cargas pesadas de eventos.

Verifique ou solucione problemas de resposta à solicitação

A API do evento segue um processo de duas etapas para processar solicitações:

1. A API do evento reconhece ou rejeita de forma síncrona a solicitação com base na validação dos cabeçalhos e no tamanho da carga útil.
2. A API do evento analisa de forma assíncrona a carga depois que uma resposta HTTP bem-sucedida é fornecida ao cliente. Isso pode gerar um erro devido a dados ausentes ou malformados. Eles são classificados como erros de envio ou erros de análise.

Todos os envios bem-sucedidos recebem uma resposta 200 , independentemente de quaisquer erros de dados que possam existir na carga útil. A resposta inclui um uuid, que é um ID único criado para cada solicitação. O uuid também aparece em qualquer evento de erro criado para a solicitação.

Outros problemas potenciais:

• Tempo limite de 10 segundos: a chamada de API que exceder 10 segundos irá expirar.
• Carga grande: carga superior a 100 KB pode aumentar o tempo de resposta.

Recommendation: Além de verificar uma mensagem de sucesso, crie uma consulta NRQL dos seus dados para verificar se estão disponíveis.

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

Consulta e alerta com NrIntegrationError

O eventoNrIntegrationError permite consultar e definir alertassobre dados personalizados enviados para sua conta New Relic. Recommendation: Para receber alertas sobre erros de análise, crie uma condição do alerta NRQL para NrIntegrationError. Use este exemplo de consulta NRQL:

SELECT message FROM NrIntegrationError WHERE newRelicFeature = 'Event API' AND category = 'EventApiException'

Encontre seus dados

Para encontrar dados enviados via API de eventos (e de integrações que utilizam esta API), você pode consultá-los. Por exemplo, para consultar um evento personalizado usando NRQL, você executaria:

SELECT * FROM YOUR_CUSTOM_EVENT

Para mais informações sobre como consultar, consulte dados de consulta.

Limite de solicitações HTTP

A API de eventos tem um limite de taxa de 100.000 solicitações HTTP (POSTs) por minuto, por conta. (Observe que este não é um limite para o número de eventos por minuto; apenas para o número de POSTs por minuto.)

Esse limite ajuda a garantir que grandes picos de tráfego em contas em nossa plataforma multilocatário não afetem negativamente o desempenho do serviço para você.

Se o uso da sua API exceder 100 mil POSTs em uma janela de 1 minuto, rejeitaremos solicitações de API subsequentes com um código de resposta 429 para o restante da janela de 1 minuto. Ao final da janela de 1 minuto, o contador será zerado e permitirá que o tráfego seja retomado.

Este limite pretende ser um limite superior que você não deve atingir em cenários normais. Se você tiver um número alto de 429 respostas, considere usar menos a API. Se você espera um nível de atividade acima do normal em um futuro próximo e deseja se preparar para isso, entre em contato com o suporte técnico.