Node.js 에이전트 API

New Relic은 Node.js 애플리케이션에 대한 유용한 메트릭을 제공하는 데 필요한 정보를 얻는 데 도움이 되는 여러 도구를 제공합니다. 여기에는 다음이 포함됩니다.

• Express 및 Restify 라우터에서 경로 이름(사용된 경우) 읽기
• API를 사용하여 간단한 이름 또는 작업이 있는 컨트롤러 그룹으로 현재 요청의 이름 지정
• 요청의 원시 URL(API 호출로도 사용 가능)과 일치하는 정규식을 기반으로 이름을 바꾸거나 무시하도록 요청을 표시할 수 있는 에이전트 구성에 저장된 지원 규칙

New Relic이 추적하는 이름의 수는 사용자 경험이 강력하도록 충분히 작아야 합니다. 또한 애플리케이션의 문제 지점을 더 쉽게 식별할 수 있도록 적절한 양의 정보를 제공할 수 있을 만큼(데이터에 부담을 주지 않으면서) 충분히 커야 합니다.

자세한 내용은 Node.js 에이전트 설정 문서, Github의 Node.js 에이전트 API 문서 및 Node.js 에이전트 예제를 참조하세요.

요청 이름

Node.js 에이전트는 잠재적으로 매개변수화된 경로(예: /user/:id ) 또는 정규식(예: /^/user/([-0-9a-f]+)$/ )과 함께 HTTP 메서드를 캡처합니다. 이러한 정보는 요청 이름의 일부가 됩니다.

느린 트랜잭션 추적을 지원하고 구성 파일의 attributes.include 에 'request.parameters.*' 를 추가한 경우 트랜잭션 추적에도 요청의 매개변수와 해당 값이 연결됩니다. Node.js 에이전트가 사용하는 요청 이름이 마음에 들지 않으면 API 호출을 사용하여 더 설명적인 이름을 만들 수 있습니다.

요구 사항

New Relic은 요청 이름을 사용하여 많은 차트와 테이블에 대한 요청을 그룹화합니다. 이러한 시각화의 값은 다른 요청 이름의 수가 증가함에 따라 떨어집니다.

예를 들어, 생성하는 요청 이름에 GUID, 숫자 ID 또는 타임스탬프와 같은 잠재적인 동적 데이터를 포함하지 마십시오. 요청이 트랜잭션 추적을 생성할 만큼 느린 경우 해당 추적에는 원래 URL이 포함됩니다. 매개변수 캡처를 활성화하면 매개변수도 추적에 첨부됩니다.

측정항목 그룹화 문제 방지

요청 명명 API는 New Relic이 때때로 "메트릭 폭발"이라고 하는 너무 많은 메트릭을 처리하려는 문제를 피하는 데 도움이 됩니다. New Relic에는 이러한 문제를 처리하기 위한 몇 가지 전략이 있습니다. 가장 심각한 것은 단순히 거부 목록에 문제가 되는 애플리케이션을 추가하는 것입니다.

이러한 요청 이름 지정 도구를 사용할 때 주의해야 하는 주된 이유는 응용 프로그램에서 이러한 일이 발생하지 않도록 방지하는 것입니다. 자세한 내용은 측정항목 그룹화 문제 를 참조하세요.

지침

가장 구체적인 것부터 가장 일반적인 것까지 구성 규칙을 정의하십시오. 구성 파일에 나열되거나 Node.js 트랜잭션 이름 지정 API 로 추가된 첫 번째 규칙이 먼저 적용되며 좁은 대상을 지정해야 합니다. 보다 일반적인 "폴스루" 규칙은 Node.js 트랜잭션 명명 API를 사용하여 구성되거나 추가된 순서대로 평가되기 때문에 목록의 끝에 추가해야 합니다.

/user/customers/all/prospects
/user/customers/all/current
/user/customers/all/returning
/user/customers/John
/user/customers/Jane

// newrelic.js
exports.config={
  //other configuration
  rules:{
    name:[
      { pattern: "/user/customers/all/prospects/", name: "/user/customers/all/prospects" },
      { pattern: "/user/customers/all/.*", name: "/user/customers/all" },
      { pattern: "/user/customers/.*", name: "/user/customers/:customer" }
    ]
  }
};

API 로드

나머지 애플리케이션이 로드되기 전에 스스로 부트스트랩해야 하므로 New Relic 모듈을 로드하는 것이 애플리케이션에서 가장 먼저 하는 일인지 확인하세요.

const newrelic = require('newrelic');

이는 뉴렐릭 Node.js API 반환합니다. 모듈은 단 한 번만 초기화되므로 애플리케이션의 여러 모듈에서 안전하게 해당 모듈을 요구할 수 있습니다.

API 호출 요청

다음은 New Relic의 Node.js 에이전트에 대한 요청 API 호출 요약입니다.

• 거래 이름 설정
• 컨트롤러 이름 설정

사용자 정의 계측 API 호출

이러한 API 호출을 사용 하여 사용자 지정 계측으로 계측을 확장합니다 .

커스텀 메트릭 API 호출

추가 임의 지표를 기록 하려면 이러한 호출을 사용하십시오.API

사용자 정의 이벤트 API 호출

다음 API 호출을 사용하여 추가 이벤트를 기록합니다.

• recordCustomEvent
• 기록로그이벤트

트랜잭션 핸들 메소드

현재 프로세서와 상호 작용하려면 이러한 API 호출을 사용하십시오.

요청 이름 지정 및 무시 규칙

New Relic 모듈에 대한 호출을 애플리케이션 코드에 직접 넣지 않으려면 패턴 기반 규칙을 사용하여 요청의 이름을 지정할 수 있습니다. 두 가지 규칙 세트가 있습니다. 하나는 요청 이름 변경을 위한 것이고 다른 하나는 New Relic의 계측에서 무시하도록 요청을 표시하는 것입니다.

다음은 New Relic의 Node.js 에이전트의 규칙 구조입니다.

NEW_RELIC_NAMING_RULES='{"pattern":"^t","name":"u"},{"pattern":"^u","name":"t"}'

pattern:     '[0-9]+',
replace_all: true

$
node node_modules/.bin/newrelic-naming-rules

pattern: '^/items/[0-9]+$',
name:    '/items/:id'

/items/123   =>  /items/:id
/orders/123  =>  /orders/123   (not replaced since the rule is a full match)

pattern: '[0-9]+',
name:    ':id'

/orders/123            =>  /orders/:id
/items/123             =>  /items/:id
/orders/123/items/123  =>  /orders/:id/items/123

pattern:     '[0-9]+',
name:        ':id',
replace_all: true

/orders/123/items/123  =>  /orders/:id/items/:id

pattern: '^/(items|orders)/[0-9]+$',
name:    '/\\1/:id'

/orders/123  =>  /orders/:id
/items/123   =>  /items/:id

NEW_RELIC_IGNORING_RULES='^/socket\.io/\*/xhr-polling,ignore_me'

다음은 구성 파일에 규칙이 포함되는 방법에 대한 전체 예입니다.

// newrelic.js
exports.config = {
  // other configuration
  rules : {
    name : [
      { pattern: "/tables/name-here", name: "/name-hererule1" }
    ]
  }
};

// newrelic.js
exports.config = {
  // other configuration
  rules : {
    ignore : [
      '^\/socket\.io\/.*\/xhr-polling'
    ]
  }
};

규칙에 대한 API 호출

New Relic의 Node.js 에이전트를 사용하여 규칙을 명명하고 무시하기 위한 API 호출은 다음과 같습니다.

• addNamingRule
• addIgnoringRule