Envía evento personalizado con nuestra API de eventos

La API de eventos le permite enviar datos de eventos personalizados a New Relic. Estos eventos pueden luego consultarse y trazarse.

¿Quieres probar nuestra API de eventos? ¡ Crea una cuenta New Relic gratis! No se requiere tarjeta de crédito.

Contenido relacionado:

• Conozca todas las opciones para reportar eventos personalizados.
• Para saber cómo agregar un atributo a un evento existente, consulte Agregar atributo personalizado.

¿Por qué utilizar la API de eventos?

Nuestra API de eventos es una opción para informar datos personalizados. Otra opción es informar el atributo personalizado. Para obtener una descripción general de por qué usaría la API de eventos frente a otras opciones, consulte evento personalizado y atributo.

Requisitos

Para conocer los límites de la API de eventos y el atributo restringido, consulte Límites.

Asegúrese de que la conectividad saliente en el puerto TCP 443 esté permitida en el rango CIDR que coincida con su región. El método de configuración preferido es utilizar el nombre DNS insights-collector.newrelic.com o insights-collector.eu01.nr-data.net.

Ejemplo de envío y consulta de un evento personalizado

A continuación se muestra un ejemplo de la API de eventos en acción:

# 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

Cómo utilizar la API de eventos

La API de eventos es un extremo asíncrono. Esto le permite enviar un volumen muy grande de POSTS, de manera confiable, con una latencia de respuesta muy baja.

Para enviar un evento personalizado a una cuenta de New Relic:

1. Obtenga un

   clave de licencia

   para la cuenta a la que desea informar datos.

2. Antes de crear un evento personalizado o atributo, revise nuestra lista de términos reservados utilizados por NRQL.

3. Genere JSON para el evento instrumentando su aplicación, consultando una API o algún otro método.

4. Envíe una carga útil JSON comprimida (por ejemplo, gzip o deflate) al extremo HTTPS usando curl en una solicitud

   POST

   .

5. Recommendation:

   Configure la condición de alerta NRQL para que le notifique cuando se produzcan errores de análisis .

La API de eventos limita el tamaño, la velocidad y los caracteres permitidos en un evento personalizado. Además, al igual que otros datos disponibles en NRQL, los eventos personalizados no se pueden actualizar ni eliminar después de su creación. Si tiene problemas con su evento personalizado, siga los procedimientos de resolución de problemas o cree un nuevo evento personalizado.

Formatear el JSON

La API de eventos acepta formatos específicos para atributos incluidos en la carga útil. Sólo se permiten valores flotantes o de cadena.

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

Enviar el evento personalizado

Los datos enviados a la API de eventos utilizan un formato JSON comprimido en una solicitud POST HTTPS simple. Este ejemplo usa gzip, pero también puedes 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 generar su solicitud HTTP, asegúrese de que esté formateada correctamente, incluyendo:

• El Api-Key contiene el

  clave de licencia

  correcto.

• El Content-Type es application/json.

• La solicitud utiliza POST únicamente. La API no acepta PUT y solicitud GET.

La API admite conexiones persistentes HTTP/1.1. Esto es útil para gestionar el rendimiento del lado del cliente bajo cargas pesadas de eventos.

Verificar o solucionar problemas de respuesta a la solicitud

La API de eventos sigue un proceso de dos pasos para procesar solicitudes:

1. La API de eventos reconoce o rechaza sincrónicamente la solicitud según la validación de los encabezados y el tamaño de la carga útil.
2. La API de eventos analiza de forma asincrónica la carga útil después de que se proporciona una respuesta HTTP exitosa al cliente. Esto puede generar un error debido a datos faltantes o mal formados. Estos se clasifican como errores de envío o errores de análisis.

Todos los envíos exitosos reciben una respuesta 200 , independientemente de los errores de datos que puedan existir dentro de la carga útil. La respuesta incluye un uuid, que es un ID único creado para cada solicitud. El uuid también aparece en cualquier evento de error creado para la solicitud.

Otros problemas potenciales:

• Tiempo de espera de 10 segundos: la llamada API que exceda los 10 segundos expirará.
• Carga grande: una carga que supere los 100 KB puede ver aumentado el tiempo de respuesta.

Recommendation: Además de verificar si hay un mensaje de éxito, cree una consulta NRQL de sus datos para verificar que estén disponibles.

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

Consulta y alerta con NrIntegrationError

El eventoNrIntegrationError le permite consultar y configurar alertassobre los datos personalizados que se envían a su cuenta de New Relic. Recommendation: Para recibir alertas de errores de análisis, cree una condición de alerta NRQL para NrIntegrationError. Utilice esta consulta NRQL de ejemplo:

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

Encuentra tus datos

Para encontrar datos enviados a través de la API del evento (y de integración que utilizan esta API), puedes consultarlo. Por ejemplo, para consultar un evento personalizado usando NRQL, ejecutaría:

SELECT * FROM YOUR_CUSTOM_EVENT

Para obtener más información sobre cómo realizar una consulta, consulte datos de consulta.

Límite de solicitudes HTTP

La API de eventos tiene un límite de velocidad de 100.000 solicitudes HTTP (POST) por minuto, por cuenta. (Tenga en cuenta que esto no es un límite en la cantidad de eventos por minuto; solo en la cantidad de POST por minuto).

Este límite ayuda a garantizar que los grandes picos de tráfico en las cuentas de nuestra plataforma multiinquilino no afecten negativamente el rendimiento del servicio para usted.

Si su uso de API excede los 100 000 POST en un período de 1 minuto, rechazaremos las solicitudes de API posteriores con un código de respuesta 429 durante el resto del período de 1 minuto. Al final del período de 1 minuto, el contador se restablecerá y permitirá que se reanude el tráfico.

Este límite pretende ser un umbral superior que no debería alcanzar en escenarios normales. Si tiene una gran cantidad de 429 respuestas, considere usar menos la API. Si espera un nivel de actividad superior a lo normal en un futuro próximo y desea prepararse para ello, comuníquese con el soporte técnico.