Blob Storage API 사용하여 에이전트 설정

기능 가용성

Fleet Control for Kubernetes 클러스터가 일반 출시되었습니다(GA). Linux and Windows hosts 에서 에이전트 관리 지원은 현재 공개 미리보기 중입니다.

지원되는 에이전트와 해당 환경의 전체 목록은 에이전트 유형 호환성 문서를 참조하세요.

공개 미리보기 기능은 출시 전 정책 에 따라 제공됩니다.

Blob Storage API 은 계정에 파일을 업로드하고 관리하기 위해 설계된 New Relic 서비스입니다. NerdGraph 는 구조화된 데이터 쿼리 및 변형에 최적화되어 있으므로 Blob Storage API는 파일 콘텐츠 전송 및 버전 관리와 관련된 작업에 사용됩니다.

Fleet Control 내에서 Blob Storage API 은 에이전트 설정, 즉 설정 파일 생성, 버전 관리, 콘텐츠 검색 및 삭제를 관리합니다.

중요

Fleet Control 의 에이전트 설정은 Blob Storage API 가 아닌 NerdGraph 을 사용합니다. 플릿, 멤버 및 구현, 배포 작업에 대해서는 NerdGraph 튜토리얼을 참조하세요.

전제 조건

사용자 API 키가 있는 New Relic 계정
당신의 New Relic Organization ID
설정을 관리하기 위한 적절한 권한

입증

모든 Blob Storage API requests New Relic 사용자 API 키를 사용한 인증이 필요합니다.

API 키를 생성하세요:

one.newrelic.com으로 이동하세요.
왼쪽 하단에 있는 이름을 클릭하세요.
API Keys [API 키]를선택하세요
User [사용자] 키를 생성하세요 (브라우저 키 또는 라이선스 키가 아닙니다).

요청 헤더에 포함하세요:

Api-Key: NRAK-YOUR-USER-API-KEY

기본 엔드포인트

https://blob-api.service.newrelic.com/v1/e

EU 지역 계정의 경우 다음을 사용하세요.

https://blob-api.service.eu.newrelic.com/v1/e

에이전트 설정 작업

조직에 새로운 에이전트 설정을 만듭니다.

끝점

POST /v1/e/organizations/{orgId}/AgentConfigurations

요청 매개변수

매개변수	위치	데이터 형식	필수 사항인가요?	설명
`orgId`	길	문자열	네	귀하의 뉴렐릭 조직 ID입니다.
`Api-Key`	머리글	문자열	네	사용자 API 키입니다.
`Content-Type`	머리글	문자열	네	`application/x-yaml` 이어야 합니다.
`NewRelic-Entity`	머리글	JSON 문자열	네	설정데이터(이름, 에이전트 유형, 관리되는EntityType)가 포함된 JSON 개체입니다.
요청 본문	몸	일반 텍스트	네	YAML 형식의 에이전트 설정 콘텐츠입니다.

NewRelic-엔티티 헤더 형식

NewRelic-Entity 헤더에는 다음 필드를 포함하는 JSON 객체가 있어야 합니다.

들	데이터 형식	필수 사항인가요?	설명
`name`	문자열	네	설정 이름입니다.
`agentType`	문자열	네	에이전트 유형(예: `NRInfra` , `NRDOT` , `FluentBit` ).
`managedEntityType`	문자열	네	엔티티 유형: `HOST` 또는 `KUBERNETESCLUSTER` .

들

데이터 형식

필수 사항인가요?

설명

name

문자열

네

설정 이름입니다.

agentType

문자열

네

에이전트 유형(예:

NRInfra

NRDOT

FluentBit

managedEntityType

문자열

네

엔티티 유형:

HOST

또는

KUBERNETESCLUSTER

지원되는 에이전트 유형

인프라 에이전트 (호스트 및 쿠버네티스 클러스터용):

NRInfra - 뉴렐릭 인프라 에이전트
NRDOT - 뉴릭 OpenTelemetry Collector배포
FluentBit - Fluent Bit 로깅 에이전트
NRPrometheusAgent - 프로메테우스 에이전트
PipelineControlGateway - 파이프라인 제어 게이트웨이
NRApmOperator - Kubernetes용 APM 운영자
NReBPFAgent - eBPF 에이전트

샘플 요청

bash

$curl -X POST \
>  https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurations \
>  -H 'Api-Key: NRAK-YOUR-API-KEY' \
>  -H 'Content-Type: application/x-yaml' \
>  -H 'NewRelic-Entity: {"name": "Production Infra Config", "agentType": "NRInfra", "managedEntityType": "HOST"}' \
>  -d 'license_key: YOUR_LICENSE_KEY
$log:
$  level: info
$  forward: true
$integrations:
$  - name: nri-docker
$    enabled: true'

샘플 응답

{
  "entityGuid": "<YOUR_ENTITY_GUID>",
  "blobId": "<YOUR_BLOB_ID>",
  "blobVersionEntity": {
    "entityGuid": "<YOUR_ENTITY_GUID>",
    "version": 1
  }
}

중요: 응답에서 entityGuid 을 저장하십시오. 설정의 버전 관리, 검색 및 삭제에 필요합니다.

기존 에이전트 설정의 새 버전을 만듭니다.

끝점

POST /v1/e/organizations/{orgId}/AgentConfigurations/{parentConfigurationId}

요청 매개변수

매개변수	위치	데이터 형식	필수 사항인가요?	설명
`orgId`	길	문자열	네	귀하의 뉴렐릭 조직 ID입니다.
`parentConfigurationId`	길	문자열	네	상위 설정 GUID입니다.
`Api-Key`	머리글	문자열	네	사용자 API 키입니다.
`Content-Type`	머리글	문자열	네	`application/x-yaml` 이어야 합니다.
요청 본문	몸	일반 텍스트	네	YAML 형식으로 에이전트 설정 콘텐츠가 업데이트되었습니다.

샘플 요청

bash

$curl -X POST \
>  https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurations/<YOUR_ENTITY_GUID> \
>  -H 'Api-Key: NRAK-YOUR-API-KEY' \
>  -H 'Content-Type: application/x-yaml' \
>  -d 'license_key: YOUR_LICENSE_KEY
$log:
$  level: debug
$  forward: true
$integrations:
$  - name: nri-docker
$    enabled: true
$  - name: nri-nginx
$    enabled: true'

샘플 응답

{
  "entityGuid": "<YOUR_ENTITY_GUID>",
  "blobId": "<YOUR_BLOB_ID>",
  "blobVersionEntity": {
    "entityGuid": "<YOUR_ENTITY_GUID>",
    "version": 2
  }
}

특정 설정 버전의 내용을 가져옵니다.

끝점

GET /v1/e/organizations/{orgId}/AgentConfigurationVersions/{configurationVersionId}

설정의 최신 버전을 가져오려면 다음을 사용하십시오.

GET /v1/e/organizations/{orgId}/AgentConfigurations/{configurationId}

요청 매개변수

매개변수	위치	데이터 형식	필수 사항인가요?	설명
`orgId`	길	문자열	네	귀하의 뉴렐릭 조직 ID입니다.
`configurationVersionId`	길	문자열	네	설정 버전 GUID입니다.
`Api-Key`	머리글	문자열	네	사용자 API 키입니다.
`version`	질문	정수	아니요	검색할 특정 버전 번호(예: `?version=1` ).

샘플 요청 (특정 버전)

bash

$curl -X GET \
>  'https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurationVersions/<YOUR_ENTITY_GUID>' \
>  -H 'Api-Key: NRAK-YOUR-API-KEY'

샘플 요청(최신 버전)

bash

$curl -X GET \
>  'https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurations/<YOUR_ENTITY_GUID>' \
>  -H 'Api-Key: NRAK-YOUR-API-KEY'

샘플 응답

설정 내용을 일반 텍스트(YAML) 형식으로 반환합니다.

license_key: YOUR_LICENSE_KEY
log:
  level: info
  forward: true
integrations:
  - name: nri-docker
    enabled: true

설정의 모든 버전을 검색합니다.

끝점

GET /v1/e/organizations/{orgId}/AgentConfigurations/{configurationId}/versions

요청 매개변수

매개변수	위치	데이터 형식	필수 사항인가요?	설명
`orgId`	길	문자열	네	귀하의 뉴렐릭 조직 ID입니다.
`configurationId`	길	문자열	네	설정 부분 GUID입니다.
`Api-Key`	머리글	문자열	네	사용자 API 키입니다.

샘플 요청

bash

$curl -X GET \
>  https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurations/<YOUR_ENTITY_GUID>/versions \
>  -H 'Api-Key: NRAK-YOUR-API-KEY'

샘플 응답

{
  "versions": [
    {
      "entity_guid": "<YOUR_ENTITY_GUID_1>",
      "blob_id": "<YOUR_BLOB_ID_1>",
      "version": "1",
      "timestamp": "2024-01-01T00:00:00Z"
    },
    {
      "entity_guid": "<YOUR_ENTITY_GUID_2>",
      "blob_id": "<YOUR_BLOB_ID_2>",
      "version": "2",
      "timestamp": "2024-01-02T00:00:00Z"
    }
  ],
  "cursor": null
}

설정과 해당 설정의 모든 버전을 삭제합니다.

끝점

DELETE /v1/e/organizations/{orgId}/AgentConfigurations/{configurationId}

요청 매개변수

매개변수	위치	데이터 형식	필수 사항인가요?	설명
`orgId`	길	문자열	네	귀하의 뉴렐릭 조직 ID입니다.
`configurationId`	길	문자열	네	삭제할 설정 구성 GUID입니다.
`Api-Key`	머리글	문자열	네	사용자 API 키입니다.

샘플 요청

bash

$curl -X DELETE \
>  https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurations/<YOUR_ENTITY_GUID> \
>  -H 'Api-Key: NRAK-YOUR-API-KEY'

샘플 응답

삭제가 성공하면 HTTP 204 No Content를 반환합니다.

특정 설정 버전을 삭제합니다.

끝점

DELETE /v1/e/organizations/{orgId}/AgentConfigurationVersions/{configVersionGuid}

요청 매개변수

매개변수	위치	데이터 형식	필수 사항인가요?	설명
`orgId`	길	문자열	네	귀하의 뉴렐릭 조직 ID입니다.
`configVersionGuid`	길	문자열	네	삭제할 설정 버전 GUID입니다.
`Api-Key`	머리글	문자열	네	사용자 API 키입니다.

샘플 요청

bash

$curl -X DELETE \
>  https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurationVersions/<YOUR_ENTITY_GUID> \
>  -H 'Api-Key: NRAK-YOUR-API-KEY'

샘플 응답

삭제가 성공하면 HTTP 204 No Content를 반환합니다.

모범 사례

엔티티 GUID 저장: 생성 작업에서 반환된 entityGuid 을 저장합니다. 버전 관리, 검색 및 삭제 작업을 위해 이러한 항목이 필요합니다.
점진적 버전 관리: 설정을 삭제하고 다시 생성하는 대신 설정 변경 시 새 버전을 생성합니다.
기술 이름 사용: 설정 이름은 목적과 목표 환경을 명확하게 나타내야 합니다.
YAML 유효성 검사: 업로드하기 전에 설정 콘텐츠가 유효한 YAML 형식인지 확인하십시오.
에이전트 유형 호환성 확인: 에이전트 유형이 관리 대상 엔티티 유형(HOST 또는 KUBERNETESCLUSTER)과 호환되는지 확인하십시오.
API 키를 안전하게 보호하세요: 사용자 API 키를 클라이언트 측 코드나 공개 저장소에 절대 노출하지 마세요.
HTTP 상태 코드를 확인하세요. API는 작업이 성공하면 2xx, 찾을 수 없으면 404, 그리고 오류가 발생하면 다른 상태 코드를 반환합니다.

일반적인 오류 응답

상태 코드	설명	해결책
`400 Bad Request`	잘못된 요청 형식, NewRelic-엔티티 헤더의 형식이 잘못된 JSON	요청 형식 및 헤더 값을 확인합니다.
`401 Unauthorized`	API 키가 없거나 유효하지 않습니다.	사용자 API 키가 유효하고 API 키 헤더에 포함되어 있는지 확인하십시오.
`404 Not Found`	설정 또는 버전을 찾을 수 없습니다.	엔티티 GUID가 올바른지 확인하십시오.
`415 Unsupported Media Type`	Content-Type 헤더가 잘못되었습니다.	사용 `Content-Type: application/x-yaml`

추가 리소스

NerdGraph 플릿 튜토리얼 - 플릿 관리 및 구현, 배포
플릿 컨트롤 CLI -이 API를 기반으로 구축된 인터페이스
플릿 컨트롤 개요
뉴렐릭 API 키

사용자의 편의를 위해 제공되는 기계 번역입니다.

Blob Storage API 사용하여 에이전트 설정

기능 가용성

중요

전제 조건.css-21sua1{background:none;border:none;width:0;padding:0;}

입증

기본 엔드포인트

에이전트 설정 작업

설정 버전 만들기

설정 콘텐츠 가져오기

설정 버전 나열

설정 삭제

설정 버전 삭제

모범 사례

일반적인 오류 응답

추가 리소스

전제 조건