Node.js 에이전트 구성

구성 파일( newrelic.js )에는 모든 Node.js 에이전트 설정이 포함되어 있습니다. Node.js 에이전트를 설치할 때 newrelic.js 을 앱의 루트 디렉토리에 복사해야 합니다. 대부분의 설정은 기본적으로 비어 있습니다. config/default.js 에서 값을 상속합니다.

newrelic.js 의 대부분의 구성 설정에는 동등한 환경 변수가 있습니다. 예를 들어 에이전트가 Heroku 또는 Microsoft Azure와 같은 PaaS 환경에서 실행되는 경우에 유용합니다. Node.js 에이전트 환경 변수는 항상 NEW_RELIC_ 로 시작합니다.

사용 가능한 경우 이러한 환경 변수는 개별 구성 옵션 아래에 Environ 변수 로 설명되어 있습니다. 또한 환경 변수를 통해서만 구성 할 수 있는 거의 사용되지 않는 두 가지 설정이 있습니다.

New Relic APM 및 CodeStream을 사용하는 경우 리포지토리를 연결 하는 방법과 빌드 SHA 또는 릴리스 태그 를 오류 받은 편지함에 연결하는 방법을 참조하십시오.

소유자와 관리자는 New Relic에서 직접 몇 가지 설정을 보고 구성할 수 있습니다. 사용 가능한 경우 서버 측 구성에 대한 UI 레이블은 이 문서의 개별 구성 옵션 아래에 서버 측 레이블 로 나열됩니다.

New Relic이 앱을 식별하는 데 사용하는 이름 입니다. 예: app_name: ['MyNodeApp'] . 앱에 여러 이름을 사용 하려면 쉼표로 구분된 이름 목록을 지정하십시오.

동일한 이름을 가진 모든 애플리케이션의 데이터는 New Relic UI에서 병합되므로 신중하게 설정하십시오. 혼동과 의도하지 않은 데이터 집계를 방지하려면 기본 이름을 설명이 포함된 이름으로 바꾸는 것이 좋습니다 .

이 설정은 필수입니다. 귀하의 New Relic 라이센스 키 . 예: license_key: '40HexadecimalCharacters' .

에이전트 시작을 중지하려면 false 으로 설정합니다. 이는 코드를 디버깅하기 위해 에이전트를 일시적으로 비활성화해야 할 때 유용합니다. 에이전트가 계측을 부트스트랩하거나 모든 부분을 설정하는 것을 방지하여 에이전트가 New Relic의 서버를 시작하고 연결하는 것을 방지합니다.

true 인 경우 exclude 규칙으로 필터링된 헤더를 제외한 모든 HTTP 헤더의 캡처를 활성화합니다. false 인 경우 수집된 헤더는 Node.js 에이전트 속성 에 정의된 헤더로 제한됩니다.

New Relic UI를 통해 Apdex T를 설정하십시오.

SSL 연결을 위해 신뢰할 추가 인증서로, PEM 형식의 문자열 배열로 지정됩니다. 이는 HTTPS 프록시에 대한 연결과 New Relic에 대한 연결 모두에 영향을 줍니다.

certificates: [ fs.readFileSync('myca.crt', {encoding: 'utf8'}) ]

true 으로 설정하면 높은 보안 v2 를 활성화합니다. 또한 ssl 설정을 활성화하고 UI에서 높은 보안을 활성화 해야 합니다.

New Relic 수집기 가 인터넷에 연결할 호스트 이름. 예: host: 'collector.newrelic.com' .

태그 를 추가합니다. 태그를 개체로 지정하거나 콜론으로 구분된 쌍의 세미콜론으로 구분된 문자열(예: Server:One;Data Center:Primary )을 지정합니다.

New Relic 수집기에 연결할 포트 번호입니다. 예: port: 443 .

인터넷에 연결할 프록시 서버를 지정하는 URL입니다. 예: proxy: 'http://user:pass@10.0.0.1:8000/' . 중요 고려 사항:

• proxy 구성 파일 설정이 사용되는 경우 다른 구성 파일 프록시 설정( proxy_host , proxy_port , proxy_user , proxy_pass )을 재정의합니다. 마찬가지로 NEW_RELIC_PROXY_URL 환경 변수는 사용되는 경우 다른 환경 변수 프록시 설정( NEW_RELIC_PROXY_HOST , NEW_RELIC_PROXY_PORT , NEW_RELIC_PROXY_USER 및 NEW_RELIC_PROXY_PASS )을 재정의합니다.
• Infinite Tracing 을 사용하는 경우: Infinite Tracing용 프록시를 구성하는 방법을 참조하십시오 .

인터넷에 연결할 프록시 서버의 호스트 이름 또는 IP 주소입니다.

프록시 서버에 인증하기 위한 비밀번호입니다. 에이전트는 기본 HTTP 인증만 지원합니다.

인터넷에 연결할 프록시 서버의 포트 번호입니다.

프록시 서버에 인증하기 위한 사용자 이름입니다. 에이전트는 기본 HTTP 인증만 지원합니다.

에이전트별 로깅을 활성화하거나 비활성화합니다.

에이전트 로그에 기록되는 세부 정보 수준을 정의합니다. 가장 작은 것부터 가장 큰 것까지 가능한 값은 fatal , error , warn , info , debug 또는 trace 입니다.

파일 이름을 포함하여 New Relic 에이전트 로그의 전체 경로입니다. 기본값은 filepath: require('path').join(process.cwd(), 'newrelic_agent.log') 입니다. 에이전트는 이 파일을 생성할 수 없는 경우 프로세스를 종료합니다. 에이전트는 상위 Node.js 에이전트 프로세스와 동일한 권한으로 로그 파일을 생성합니다.

• 모든 로깅을 stdout 에 쓰려면 이것을 stdout 으로 설정하십시오.
• 모든 로깅을 stderr 에 기록하려면 이를 stderr 으로 설정합니다.

활성화되면 에이전트는 수집기에 보내는 페이로드를 기록합니다. 이 데이터는 로깅 수준이 가장 낮은 수준으로 설정되어 있어도 기본 로그 파일에 포함됩니다.

에이전트는 여러 유형의 데이터를 별도의 페이로드로 수집기에 보냅니다. 기본적으로 모두 로그 파일에 포함됩니다. 이 옵션을 사용하면 특정 유형의 데이터로만 로깅을 제한할 수 있습니다.

유효한 값은 다음과 같습니다.

• agent_settings
• analytic_event_data
• connect
• custom_event_data
• error_data
• error_event_data
• metric_data
• preconnect
• shutdown
• span_event_data
• sql_trace_data
• transaction_sample_data

이 옵션은 newrelic.addCustomAttribute 및 newrelic.addCustomAttributes 을 활성화합니다.

이 옵션은 recordCustomEvent 을 활성화합니다.

이 옵션은 newrelic.noticeError 을 활성화합니다.

true 인 경우 모든 대상에 대한 속성 캡처를 활성화합니다.

모든 대상에서 제외할 속성의 접두사. 끝에 와일드카드로 * 을 허용합니다.

모든 대상에서 포함할 속성의 접두사입니다. 끝에 와일드카드로 * 을 허용합니다.

true 일 때 패턴이 attributes.include 목록에 추가될 수 있습니다.

활성화되면 에이전트는 앱에서 오류 추적 을 수집합니다.

오류 수집기가 무시할 HTTP 상태 코드의 쉼표로 구분된 목록입니다.

오류 수집기가 무시할 자바스크립트 오류 유형/클래스의 쉼표로 구분된 목록입니다.

다음 구성

/* ... */
    error_collector: {
        ignore_classes: ["ReferenceError"]
    }
    /* ... */

모든 참조 오류를 무시합니다.

수집기가 무시할 자바스크립트 오류 메시지에 연결된 자바스크립트 클래스 목록을 설명하는 자바스크립트 객체입니다. 다음 구성.

/* ... */
    error_collector: {
        /* ... */
        ignore_messages: {"Error":["Undefined", "Out of time"]}
        /* ... */
    }
    /* ... */

Undefined 및 Out of time 의 정확한(대소문자 구분) 메시지 문자열을 사용하여 Error 유형의 모든 오류를 무시합니다.

오류 수집기가 예상대로 표시할 HTTP 상태 코드의 쉼표로 구분된 목록입니다.

다음 구성

/* ... */
    error_collector: {
        expected_classes: ["ReferenceError"]
    }
    /* ... */

모든 참조 오류를 예상대로 표시합니다.

수집기가 무시할 자바스크립트 오류 메시지에 연결된 자바스크립트 클래스 목록을 설명하는 자바스크립트 객체입니다. 다음 구성.

/* ... */
    error_collector: {
        /* ... */
        expected_messages: {"Error":["Undefined", "Out of time"]}
        /* ... */
    }
    /* ... */

Undefined 및 Out of time 의 정확한(대소문자 구분) 메시지 문자열을 사용하여 Error 유형의 모든 오류를 표시합니다.

true 인 경우 에이전트는 오류 수집에서 속성을 캡처합니다.

오류 수집에서 제외할 속성의 접두사. 끝에 와일드카드로 * 을 허용합니다.

오류 수집에 포함할 속성의 접두사. 끝에 와일드카드로 * 을 허용합니다.

에이전트가 분당 수집하는 최대 이벤트 수를 정의합니다. 이 수보다 많은 경우 에이전트는 통계적 샘플링을 수집합니다.

활성화되면 에이전트는 느린 트랜잭션 추적을 수집합니다.

트랜잭션 추적 에서 느린 쿼리 에 적합한 트랜잭션의 최소 쿼리 기간(밀리초)입니다.

이 옵션은 느린 쿼리 와 트랜잭션 추적의 record_sql 에 모두 영향을 줍니다. off , obfuscated 또는 raw 의 세 가지 값 중 하나를 가질 수 있습니다.

off 으로 설정하면 느린 쿼리가 캡처되지 않고 역추적 및 SQL이 트랜잭션 추적에 포함되지 않습니다. raw 또는 obfuscated 로 설정하면 에이전트는 원시 또는 난독화된 SQL과 느린 쿼리 샘플을 수집기 에 보냅니다. 에이전트는 slow_sql.enabled 이 설정된 경우와 같이 다른 기준이 충족되는 경우에도 SQL을 보낼 수 있습니다.

트랜잭션 추적 에 적합한 최대 요청 수를 정의합니다.

트랜잭션 이름은 요청에 따라 지정되며 top_n 은 이러한 이름으로 그룹화된 "가장 느린 트랜잭션 상위 n 개"를 나타냅니다. 모듈은 새 추적이 해당 이름의 가장 느린 이전 추적보다 느린 경우에만 기록된 추적을 새 추적으로 대체합니다. 이 설정의 기본값은 top_n: 20 입니다. 트랜잭션 페이지 도 기본적으로 20개의 가장 느린 트랜잭션으로 설정되기 때문입니다.

Node.js 에이전트는 시작 후 첫 번째 수확 주기에서 최소 5개의 서로 다른 느린 트랜잭션을 캡처합니다. 또한 지난 5번의 수확 주기 동안 느린 트랜잭션이 캡처되지 않은 경우 다른 트랜잭션을 재설정하고 캡처합니다. 이렇게 하면 해당 수집 주기에 대해 절대적으로 가장 느린 요청에 초점을 맞추지 않는 대신 앱의 요청 경로에 대해 더 많은 정보를 볼 수 있습니다.

트랜잭션 이 트랜잭션 추적 에 적합한 시간을 초과하는 웹 트랜잭션 응답 시간의 임계값(초)입니다. 기본값은 apdex_f 입니다. 이렇게 하면 추적 임계값이 애플리케이션 Apdex T 의 4배로 설정됩니다. 특정 시간 값을 밀리초 단위로 입력할 수도 있습니다.

예: 임계값 설정 apdex_f

기본 apdex_t 은 100밀리초입니다. 트랜잭션 임계값이 apdex_f 으로 설정된 경우 "느린" 트랜잭션은 400밀리초입니다.

에이전트는 웹 애플리케이션에 연결된 내부 속성을 숨기기 위해 소량의 CPU를 사용합니다. 이 구성을 false 으로 변경하면 에이전트 오버헤드가 약간 줄어들 수 있지만 에이전트 성능에도 영향을 미칠 수 있습니다.

true 인 경우 에이전트는 트랜잭션 추적에서 속성을 캡처합니다.

트랜잭션 추적에서 제외할 속성의 접두사입니다. 끝에 와일드카드로 * 을 허용합니다.

트랜잭션 추적에 포함할 속성의 접두사입니다. 끝에 와일드카드로 * 을 허용합니다.

들어오는 요청 URL과 일치하고 연결된 New Relic 트랜잭션의 이름을 지정하는 쉼표로 구분된 규칙 목록입니다. 다음 형식을 사용합니다.

name: [
    {pattern: 'STRING_OR_REGEX', name: 'NAME'},

    {pattern: 'STRING_OR_REGEX', name: 'NAME'}

    ],

두 매개변수가 모두 필요합니다. 문자열의 경우 제어 문자를 이스케이프해야 합니다. 정규식에서 제어 문자를 이스케이프할 필요가 없습니다. 추가 속성은 무시됩니다.

정규식은 JavaScript 스타일 캡처 그룹을 지원하고 이름은 $1 스타일 대체 문자열을 사용합니다. 정규식은 일치하는 첫 번째 결과만 찾습니다. 후속 일치는 무시됩니다. 자세한 내용은 Node.js 트랜잭션 명명 API 를 참조하세요.

NEW_RELIC_NAMING_RULES 환경 변수의 경우 규칙을 쉼표로 구분된 JSON 객체 리터럴로 전달합니다.

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

에이전트가 무시할 요청 URL 목록을 정의하십시오. 문자열 또는 정규식일 수 있는 패턴으로 목록을 지정합니다.

활성화되면 에이전트는 다른 이름 지정 논리(예: API, 규칙 또는 측정항목 정규화 규칙)의 영향을 받지 않는 트랜잭션의 이름을 NormalizedUri/* 으로 바꿉니다. 이것을 false 로 설정하면 에이전트는 트랜잭션 이름을 Uri/path/to/resource 로 설정합니다.

활성화되면 에이전트는 트랜잭션 이벤트를 New Relic으로 보냅니다. 이 이벤트 데이터에는 트랜잭션 타이밍, 트랜잭션 이름 및 사용자 정의 매개변수가 포함됩니다. 비활성화된 경우 에이전트는 이 데이터를 수집하거나 New Relic으로 보내지 않습니다.

에이전트가 분당 수집하는 최대 이벤트 수를 정의합니다. 이 수보다 많은 경우 에이전트는 통계적 샘플링을 수집합니다.

10,000을 초과하여 구성하지 않는 것이 좋습니다. 서버는 데이터를 분당 10,000개로 제한합니다.

New Relic 수집기 와 통신할 수 없는 경우 에이전트가 저장하는 최대 이벤트 수를 정의합니다. 이전 수확 주기 의 값은 다음 수확 주기로 병합되며 이 옵션은 최대 수를 제한합니다. 이 숫자가 max_samples_per_minute 보다 큰지 확인하십시오. 예를 들어 2배로 설정합니다. 이 값을 늘리기 전에 메모리 오버헤드를 고려하십시오.

에이전트가 분당 수집하는 최대 이벤트 수를 정의합니다. 이 수보다 많은 경우 에이전트는 통계적 샘플링을 수집합니다.

true 인 경우 에이전트는 트랜잭션 이벤트에서 속성을 캡처합니다.

트랜잭션 이벤트에서 제외할 속성의 접두사. 끝에 와일드카드로 * 을 허용합니다.

트랜잭션 이벤트에 포함할 속성의 접두사. 끝에 와일드카드로 * 을 허용합니다.

브라우저 계측을 위한 JavaScript 헤더를 생성합니다. 기본값은 true 이지만 브라우저 모니터링을 활성화 하지 않는 한 에이전트는 브라우저 JS 코드를 삽입하지 않습니다. 활성화 하고 브라우저 타이밍 헤더를 추가한 경우에도 이를 false 로 설정 하여 앱에 대한 브라우저 모니터링을 비활성화 할 수 있습니다.

true 인 경우 서버에서 축소되지 않은 소스를 요청합니다.

true 인 경우 에이전트는 브라우저 모니터링에 사용자 정의 속성을 보냅니다.

브라우저 모니터링에서 제외할 속성의 접두사. 끝에 와일드카드로 * 을 허용합니다.

브라우저 모니터링에 포함할 속성의 접두사. 끝에 와일드카드로 * 을 허용합니다.

활성화되면 에이전트는 recordCustomEvent() 으로 기록된 사용자 지정 이벤트를 New Relic 으로 보냅니다. 비활성화된 경우 에이전트는 이 데이터를 수집하거나 New Relic으로 보내지 않습니다.

에이전트가 분당 수집하는 최대 사용자 지정 이벤트 수를 정의합니다. 사용자 지정 이벤트 수가 이 제한을 초과하면 에이전트는 통계적 샘플링을 수집합니다.

활성화되면 에이전트는 느린 쿼리 세부정보 를 수집합니다.

에이전트가 분당 수집하는 느린 쿼리의 최대 수를 정의합니다. 에이전트는 제한에 도달한 후 추가 쿼리를 삭제합니다.

New Relic 에 표시 할 사용자 지정 호스트 이름을 지정합니다. 이 필드를 설정하지 않으면 New Relic은 os.hostname() 을(를) 호출하여 찾은 기본 호스트 이름을 계속 사용합니다.

• 기본 호스트 이름 설정을 사용하는 경우 New Relic은 os.hostname() 을 통해 호스트 이름을 찾습니다.
• 이 호출이 실패하면 New Relic은 호스트의 IP를 이름으로 사용합니다.
• ipv_preference: 4 또는 ipv_preference: 6 을 설정하면 New Relic UI에 표시되는 IP 주소 유형(IPv4 또는 IPv6)을 선택할 수 있습니다.

newrelic.js 이 포함된 디렉토리 경로입니다. 이것은 환경 변수로만 사용할 수 있습니다. 구성 파일에서 설정할 수 없습니다.

사용하는 경우 에이전트가 newrelic.js 에서 구성 설정을 읽는 것을 방지합니다. 환경 변수의 기본값과 값은 계속 설정됩니다.

이것은 환경 변수로만 사용할 수 있습니다. 구성 파일에서 설정할 수 없습니다.

활성화되면 에이전트는 일부 데이터베이스 드라이버 에 대한 데이터 저장소 인스턴스 메트릭(예: 호스트 및 포트)을 수집합니다. 이는 느린 쿼리 추적 및 트랜잭션 추적에 대해 보고됩니다.

활성화되면 에이전트는 일부 데이터베이스 드라이버 에 대한 느린 쿼리 추적 및 트랜잭션 추적에서 데이터베이스 이름을 수집합니다.

true 으로 설정하면 둘 이상의 New Relic 모니터링 애플리케이션에서 트랜잭션을 추적할 수 있습니다.

false 일 때 에이전트는 캡처된 오류의 메시지를 수정합니다.

분산 추적을 활성화하려면 이것을 true 으로 설정하십시오.

예를 들어 구성 파일에서 이를 활성화하려면 다음을 사용합니다.

distributed_tracing: {
   enabled: true
}

아웃바운드 요청에 첨부된 New Relic 헤더를 제외하고 대신 분산 추적을 위해 W3C 추적 컨텍스트 헤더에만 의존하려면 이것을 true 으로 설정합니다. 이것이 false 이면 두 가지 유형의 헤더가 모두 사용됩니다.

예를 들어 구성 파일에서 이를 활성화하려면 다음을 사용합니다.

distributed_tracing:{
   enabled: true,
   exclude_newrelic_header: true
}

스팬 이벤트 보고를 켜거나 끕니다.

이 설정을 사용하여 범위에 대한 속성 보고를 켜거나 끌 수 있습니다. 루트 수준의 attributes.enabled 이 false 이면 설정 방법에 관계없이 스팬과 함께 속성이 전송되지 않습니다.

스팬에 대해 속성이 활성화된 경우 이 목록에 있는 모든 속성 키가 스팬에 연결됩니다. 자세한 내용은 에이전트 속성 규칙 을 참조하십시오.

이 목록에 있는 모든 속성 키는 범위와 함께 전송되지 않습니다. 자세한 내용은 에이전트 속성 규칙 을 참조하십시오.

유효한 무한 추적 추적 관찰자 호스트 항목을 가져오는 데 도움이 필요 하면 추적 관찰자 끝점 찾기 또는 만들기 를 참조하세요.

컨텍스트에서 자동으로 로그를 생성할 수 있습니다.

에이전트가 APM 요약 페이지의 로그 차트에 사용된 로깅 메트릭을 수집할지 여부를 토글합니다.

에이전트가 New Relic에 보낼 로그 레코드를 수집할지 여부를 토글합니다.

New Relic에 분당 보낼 로그 레코드 수입니다. 로그 전달을 사용할 때 전체 메모리 소비를 제어합니다.

에이전트가 표준 로그 출력에서 로컬 로그 장식을 수행할지 여부를 토글합니다.