이벤트 API로 맞춤 이벤트 보내기

Event API를 사용하면 사용자 지정 이벤트 데이터 를 New Relic에 보낼 수 있습니다. 그런 다음 이러한 이벤트를 쿼리하고 차트로 작성할 수 있습니다.

이벤트 API를 사용해 보고 싶으십니까? 무료 로 New Relic 계정을 만드 십시오! 신용 카드가 필요하지 않습니다.

관련된 컨텐츠:

• 맞춤 이벤트 보고를 위한 모든 옵션에 대해 알아보세요.
• 기존 이벤트에 속성을 추가하는 방법은 사용자 정의 속성 추가 를 참조하십시오.

이벤트 API를 사용하는 이유는 무엇입니까?

이벤트 API는 사용자 지정 데이터를 보고하기 위한 한 가지 옵션입니다. 또 다른 옵션은 사용자 정의 속성을 보고하는 것입니다. Event API와 다른 옵션을 사용하는 이유에 대한 개요는 사용자 지정 이벤트 및 속성 을 참조하세요.

요구 사항

이벤트 API 제한 및 제한된 속성은 제한 을 참조하십시오.

지역 과 일치하는 CIDR 범위 에 대해 TCP 포트 443의 아웃바운드 연결이 허용되는지 확인합니다. 기본 구성 방법은 DNS 이름 insights-collector.newrelic.com 또는 insights-collector.eu01.nr-data.net 을 사용하는 것입니다.

사용자 지정 이벤트 제출 및 쿼리의 예

다음은 작동 중인 Event API의 예입니다.

# 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

이벤트 API 사용 방법

이벤트 API는 비동기 엔드포인트입니다. 이를 통해 매우 낮은 응답 대기 시간으로 매우 많은 양의 POSTS를 안정적으로 보낼 수 있습니다.

New Relic 계정에 맞춤 이벤트를 보내려면:

1. 데이터를 보고하려는 계정에 대해 라이선스 키를 가져옵니다.
2. 맞춤형 대시보드 또는 속성을 생성하기 전에 NRQL에서 사용하는 예약어 목록을 검토하세요.
3. 애플리케이션을 계측하거나 API를 쿼리하거나 다른 방법을 사용하여 이벤트에 대한 JSON을 생성 합니다.
4. POST 요청에서 컬을 사용하여 압축된 JSON 페이로드 (예: gzip 또는 deflate)를 HTTPS 엔드포인트에 제출합니다.
5. 권장 사항: 구문 분석 오류가 발생할 때 알림을 받을 NRQL 수 있도록 공지 조건을 설정하세요.

이벤트 API는 사용자 정의 이벤트에 허용되는 크기, 비율 및 문자를 제한 합니다. 또한 NRQL에서 사용할 수 있는 다른 데이터와 마찬가지로 사용자 지정 이벤트는 생성된 후에 업데이트하거나 삭제할 수 없습니다. 사용자 지정 이벤트에 문제가 있는 경우 문제 해결 절차 를 따르거나 새 사용자 지정 이벤트를 만드십시오.

JSON 형식 지정

이벤트 API는 페이로드에 포함된 속성에 대한 특정 형식을 허용합니다. float 또는 string 값만 허용됩니다.

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

맞춤 이벤트 제출

이벤트 API에 제출된 데이터는 간단한 HTTPS POST 요청에서 압축된 JSON 형식을 사용합니다. 이 예에서는 gzip 을 사용하지만 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"

HTTP 요청을 생성하기 전에 다음을 포함하여 형식 이 올바른지 확인하십시오.

• Api-Key 에는 올바른 라이선스 키이 포함되어 있습니다.
• Content-Type 은(는) application/json 입니다.
• 요청은 POST만 사용합니다. API는 PUT 및 GET 요청을 허용하지 않습니다.

API는 HTTP/1.1 영구 연결 을 지원합니다. 이는 이벤트 로드가 많은 경우 클라이언트 측 성능을 관리하는 데 유용합니다.

요청 응답 확인 또는 문제 해결

이벤트 API는 요청을 처리하기 위해 2단계 프로세스를 따릅니다.

1. 이벤트 API는 헤더 및 페이로드 크기의 유효성 검사를 기반으로 요청을 동기적으로 승인하거나 거부합니다.
2. Event API는 성공적인 HTTP 응답이 클라이언트에 제공된 후 페이로드를 비동기식으로 구문 분석합니다. 데이터가 누락되거나 형식이 잘못되어 오류가 발생할 수 있습니다. 제출 오류 또는 구문 분석 오류로 분류됩니다.

모든 성공적인 제출은 페이로드 내에 존재할 수 있는 데이터 오류에 관계없이 200 응답을 받습니다. 응답에는 각 요청에 대해 생성된 고유 ID인 uuid 이 포함됩니다. uuid 는 요청에 대해 생성된 모든 오류 이벤트에도 나타납니다.

기타 잠재적인 문제:

• 10초 시간 초과: 10초를 초과하는 API 호출은 시간 초과됩니다.
• 대용량 페이로드: 100KB를 초과하는 페이로드는 응답 시간이 증가할 수 있습니다.

권장 사항: 성공 메시지를 확인하는 것 외에도 데이터에 대한 NRQL 쿼리를 만들어 사용 가능한지 확인하세요.

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

NrIntegrationError를 사용한 쿼리 및 경고

NrIntegrationError 이벤트를 사용하면 뉴렐릭 계정으로 전송되는 맞춤 데이터에 대해 쿼리하고 알림을 설정할 수 있습니다. 권장 사항: 구문 분석 오류에 대한 알림을 받으려면 NrIntegrationError에 대한 NRQL 공지 조건을 만드세요 . 다음 예제 NRQL 쿼리를 사용하세요.

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

데이터 찾기

Event API(및 이 API를 사용하는 통합)를 통해 전송된 데이터를 찾으려면 쿼리할 수 있습니다. 예를 들어 NRQL 을 사용하여 사용자 지정 이벤트를 쿼리하려면 다음을 실행합니다.

SELECT * FROM YOUR_CUSTOM_EVENT

쿼리 방법에 대한 자세한 내용은 데이터 쿼리를 참조하세요.

HTTP 요청 제한

이벤트 API의 속도 제한은 계정당 분당 100,000개의 HTTP 요청(POST)입니다. (이것은 분당 이벤트 수에 대한 제한이 아니라 분당 POST 수에 대한 제한이라는 점에 유의하십시오.)

이 제한은 다중 테넌트 플랫폼에서 계정의 대규모 트래픽 급증이 서비스 수행 방식에 부정적인 영향을 미치지 않도록 하는 데 도움이 됩니다.

API 사용량이 1분 창에서 100k POST를 초과하는 경우 나머지 1분 창에서 429 응답 코드와 함께 후속 API 요청을 거부합니다. 1분이 지나면 카운터가 재설정되고 트래픽이 재개됩니다.

이 제한은 일반적인 시나리오에서 도달해서는 안 되는 상한 임계값을 위한 것입니다. 429개의 응답이 많은 경우 API를 덜 사용하는 것이 좋습니다. 가까운 장래에 정상보다 높은 활동 수준이 예상되고 이에 대비하려면 기술 지원에 문의 하십시오.