New Relic이 API 통합 게시자를 올바르게 식별하도록 하려면 각 통합에 고유한 사용자 지정 사용자 에이전트 문자열이 필요합니다.
내부적으로만 통합을 사용하고 조직 외부와 공유할 계획이 없는 경우 고유한 사용자 지정 에이전트 문자열을 설정할 필요가 없습니다.
전제 조건
이 문서에서는 New Relic의 공개 RESTful API를 사용하는 통합을 공개적으로 배포할 계획이라고 가정합니다. 공개 배포의 예는 다음과 같습니다.
- Github에 통합 코드를 공개합니다.
- 통합을 플러그인, 확장 또는 기타 패키지로 패키징하고 WordPress Plugins 와 같은 디렉토리를 통해 배포합니다.
- Runscope의 통합 과 같은 통합 코드를 실제로 배포하지 않고 제품과 New Relic 간의 "서비스로" 통합을 제공합니다.
사용자 에이전트
New Relic의 RESTful API(이 문서에서는 통합 이라고 함)와 함께 작동하도록 애플리케이션을 작성할 때 애플리케이션과 New Relic 간의 정보 교환을 관리하기 위해 HTTP 에이전트를 생성하는 것입니다. 통합은 표준 식별 문자열을 제출하여 자신을 식별합니다. HTTP에서 이 문자열은 헤더 필드 User-Agent 에 포함됩니다.
New Relic의 RESTful API를 사용할 때 API 호출에서 통합을 식별하는 User-Agent 헤더를 설정하십시오. 이 사용자 지정 사용자 에이전트 문자열을 통해 New Relic은 New Relic의 API에 요청하는 통합을 식별할 수 있습니다.
사용자 지정 사용자 에이전트를 설정하여 New Relic은 다음을 추적할 수 있습니다.
- 통합에 대한 사용 통계입니다.
- 잠재적으로 버그가 있거나 악의적인 API 사용.
사용자 에이전트 설정
사용자 지정 사용자 에이전트를 설정하려면 HTTP 헤더 User-Agent 에 에이전트 문자열을 포함합니다.
예:
언어 | 예시 |
|---|---|
곱슬 곱슬하다 | |
자바 | |
PHP | |
최소 사용자 에이전트 문자열은 통합 이름 및 버전 name/version 입니다. 공백으로 구분된 목록에서 여러 값을 함께 묶을 수 있습니다. 전체 구문은 다음과 같습니다.
name/version [(comments)] [name/version [(comments)]] [...]통합 이름에는 통합을 명확하고 의미 있게 식별하는 문자열을 사용하십시오.
모호한 이름: New Relic Integration
명확하고 의미 있는 이름: SaaS XYZTools와 New Relic 통합
통합 버전의 경우 새 통합 버전을 출시할 때 업데이트되는 빌드 ID, 커밋 해시 또는 기타 식별자를 사용합니다.
() 괄호 안에 주석을 세미콜론으로 구분된 목록으로 묶습니다.
다음을 포함하는 유용한 의견:
- 공개적으로 액세스할 수 있는 통합 URL입니다. 예를 들어 Github URL 또는 통합을 설명하는 문서 사이트의 페이지입니다.
- New Relic이 통합 게시자에게 쉽게 연락할 수 있도록 연락처 정보를 제공합니다.
팁
사용자 에이전트 문자열의 정보는 게시자와의 통합에 대한 논의 이외의 다른 목적으로 New Relic에서 공유되거나 사용되지 않습니다.
사용자 에이전트 문자열 및 New Relic
New Relic은 API 호출에서 사용자 에이전트 문자열을 캡처하여 소스를 식별합니다.
공개적으로 사용 가능한 통합을 위해 사용자 지정 사용자 에이전트 문자열을 사용하는 것이 권장되는 모범 사례입니다. New Relic과의 비즈니스 관계에 따라 필요할 수 있습니다. 사용자 지정 사용자 에이전트 문자열로 통합에 레이블을 지정해도 New Relic의 API와의 상호 작용에는 영향을 미치지 않습니다.