API 및 CLI

플릿 컨트롤은 API 및 명령줄 인터페이스를 통해 포괄적인 프로그래밍 방식 액세스를 제공하여 UI 에 의존하지 않고도 차량 운영을 자동화하고 기존 도구와 통합하고 측정, 계측을 대규모로 관리할 수 있도록 합니다.

프로그램 액세스 옵션

플릿 컨트롤은 프로그래밍 방식으로 액세스할 수 있는 세 가지 방법을 제공합니다.

• NerdGraph API: 함대 생성, 멤버 관리 및 구현, 배포 제어 등 함대 관리 작업을 위한 API
• Blob Storage API: 설정 생성, 버전 관리 및 검색을 포함한 에이전트 설정 작업용
• 플릿 컨트롤 CLI: 대화형 복합줄 관리 및 자동화용

API와 CLI는 언제 사용해야 할까요?

사용 사례에 가장 적합한 액세스 방법을 이해하면 낱장 제어를 더욱 효율적으로 사용할 수 있습니다.

API (NerdGraph + Blob Storage API)

API는 다음과 같은 경우에 가장 적합합니다.

• 자동화 및 통합: 플릿 작업을 CI/CD 파이프라인, 사용자 정의 도구 또는 기타 자동화된 흐름 흐름으로 구축
• 코드로 포함: 교체 정의와 함께 Fleet 설정 관리
• 시스템 간 통합: 플릿 컨트롤을 다른 플랫폼, 지지 케이스 시스템 또는 오케스트레이션 도구와 연결
• 복잡한 워크플로우: 여러 작업을 결합하거나 외부 데이터 소스와 통합하는 정교한 자동화 시스템 구축
• 프로그래밍 방식의 액세스: 자체 제작이나 서비스에 플릿 확률 기능을 구축해야 하는 경우

플릿 컨트롤 CLI

CLI는 다음과 같은 경우에 가장 적합합니다.

• 대화형 작업: 명령줄에서 사람이 직접 수행하는 빠르고 간편한 작업
• 임시 관리: 일회성 관리 작업 또는 문제 해결, 해결
• 터미널 기반 작업우: 터미널에서 직접 작업하는 것을 선호하는 경우
• 로컬 테스트: 자동화 전에 차량 운행을 시험해 보기
• 셸 스크립트: 간단한 순차적 작업에 적합합니다(복잡한 자동화에는 API가 더 나을 수 있습니다).
• 학습 및 탐색: CLI는 즉각적이고 체계적인 피드백을 제공하여 제어 작업 과정을 이해하는 데 도움을 줍니다.

CLI는 동일한 API를 기반으로 구축되었으므로 기능적으로 동일한 기능을 제공합니다. 선택은 인터페이스 선호도와 사용 사례에 따라 달라집니다. CLI는 사람의 조작과 편의성을 위해, API는 프로그래밍 방식의 통합 및 자동화를 위해 사용됩니다.

NerdGraph API (플릿 운영)

NerdGraph는 플릿, 멤버 및 구현, 배포를 관리하기 위한 플릿 취소 작업에 대한 액세스를 제공하는 뉴렐릭의 GraphQL API 입니다. Blob Storage API 사용하는 에이전트 설정과 달리 모든 함대 수준 작업은 NerdGraph를 사용합니다.

NerdGraph Explorer에 액세스하기

NerdGraph Explorer는 사용 가능한 쿼리 제어 API를 검색하고, 쿼리를 구축하고, 작업을 테스트할 수 있는 대화형 GraphQL IDE입니다.

NerdGraph Explorer에 접속하려면 다음 단계를 따르세요.

1. 해당 지역의 NerdGraph Explorer로 이동하세요.

   • 미국 지역: https://one.newrelic.com/nerdgraph-graphiql
   • EU 지역: https://one.eu.newrelic.com/nerdgraph-graphiql

2. 사용할 때 사용자 API 키를 입력하세요. 이번 출시로 사용자 계정으로 접근 권한이 제한된 API 탐색기가 제공됩니다.

3. 왼쪽 패널에서 mutation를 확장하고 fleetControl 로 이동하여 사용 가능한 모든 플릿 제어 작업을 확인하세요.

이용 가능한 플릿독성 돌연변이

NerdGraph API 다음과 같은 플릿 독소 돌연변이를 제공합니다:

차량 관리

• fleetControlCreateFleet - 새로운 함대를 생성하세요
• fleetControlUpdateFleet - 기존 차량 목록의 속성을 업데이트합니다.
• fleetControlDeleteFleet - 함대를 삭제하세요

함대 구성원 관리

• fleetControlAddFleetMembers - 관리 대상 엔티티를 플릿 링에 추가합니다.
• fleetControlRemoveFleetMembers - 플릿 링에서 관리되는 엔티티를 제거합니다.

구현, 배포 관리

• fleetControlCreateFleetDeployment - 함대에 대한 새로운 구현, 배포 생성
• fleetControlUpdateFleetDeployment - 기존 구현 업데이트, 배포
• fleetControlDeleteFleetDeployment - 구현 삭제, 배포
• fleetControlDeploy - 플릿 링으로 롤아웃하기 위한 구현, 배포 트리거

입증

모든 NerdGraph API requests 뉴렐릭 사용자 API 키를 사용한 인증이 필요합니다. API 키를 생성하려면 다음 단계를 따르세요.

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

NerdGraph Explorer 외부에서 API 호출할 때는 요청 헤더에 API 키를 포함하세요.

NerdGraph 사용에 대한 자세한 내용은 NerdGraph 소개 문서를 참조하십시오.

Blob Storage API (에이전트 설정)

Blob Storage API 는 플릿셀 내에서 에이전트 설정을 관리하기 위해 특별히 설계된 RESTful 인터페이스입니다. 이 API 설정 생성, 버전 관리, 콘텐츠 검색 및 삭제를 포함한 모든 설정 관련 작업을 처리합니다.

기본 엔드포인트

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

입증

모든 Blob Storage API requests 뉴렐릭 사용자 API 키를 사용한 Api-Key 헤더를 통한 인증이 필요합니다.

Api-Key: your-user-api-key

주요 운영

Blob Storage API 에이전트 설정에 대해 다음 작업을 지원합니다.

에이전트 설정 만들기

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

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

헤더 필수:

• Api-Key - 사용자 API 키
• Content-Type - application/x-yaml
• NewRelic-Entity - 설정데이터를 사용하는 JSON(이름, 에이전트 유형, 관리되는EntityType, 구성 유형)

요청 본문: 에이전트 설정의 일반 텍스트 콘텐츠(YAML 형식)

에이전트 설정 버전 만들기

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

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

헤더 필수:

• Api-Key - 사용자 API 키
• Content-Type - application/x-yaml

요청 본문: 새 설정 버전의 일반 텍스트 내용(YAML 형식)

참고: 상위 설정 ID는 URL 경로에 지정되어 있습니다. 버전 생성에는 NewRelic-Entity 헤더가 필요하지 않습니다.

설정 버전 콘텐츠 가져오기

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

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

헤더 필수:

• Api-Key - 사용자 API 키

응답: 설정된 내용을 일반 텍스트/YAML 형식으로 반환합니다.

설정 버전 삭제

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

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

헤더 필수:

• Api-Key - 사용자 API 키

응답: 삭제 성공 시 2xx 상태 코드, 설정 버전을 찾을 수 없는 경우 404 오류 코드 반환

유효한 필드 값

설정 생성 시 특정 필드에 유효한 값을 지정해야 합니다.

에이전트 유형

지원되는 에이전트 유형은 다음과 같습니다.

인프라 에이전트 (HOST 및 KUBERNETESCLUSTER 관리형 엔티티 유형용):

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

인력 구성 (관리형 분리 유형):

• NRJavaAgent - 자바 APM 에이전트
• NRPythonAgent - 파이썬 APM 에이전트
• NRNodeAgent - Node.js APM 에이전트
• NRRubyAgent - 루비 APM 에이전트
• NRDotNetAgent - .NET APM 에이전트

관리되는 엔티티 유형

• HOST - 개별 호스트/서버 엔티티(인프라 에이전트만 사용 가능)
• KUBERNETESCLUSTER - 쿠버네티스 클러스터 엔티티(인프라 에이전트만 사용 가능)
• APPLICATION - 애플리케이션 엔티티(애플리케이션 에이전트만 사용 가능)

설정 유형

• Instrumentation - 현재 지원되는 유일한 설정 유형입니다.

모범 사례

• 항상 HTTP 상태 코드를 확인하세요. API는 작업이 성공적으로 완료되면 200을 반환합니다.
• 반환된 엔티티 GUID를 저장하세요. 버전 관리 및 삭제 작업에 필요합니다.
• JSON 형식 유효성 검사: NewRelic-Entity 헤더의 JSON 형식이 올바른지 확인합니다.
• 에이전트 유형 호환성 확인: 에이전트 유형이 관리 대상 엔티티 유형과 호환되는지 확인하십시오.
• 올바른 Content-Type을 사용하세요. 설정 콘텐츠에는 항상 application/x-yaml 사용하세요.
• API 키를 안전하게 보호하세요: 사용자 API 키를 클라이언트 측 코드나 공개 저장소에 절대 노출하지 마세요.

플릿 컨트롤 CLI

플릿 컨트롤 CLI는 플릿, 설정, 구현, 배포, 멤버 및 편집 쿼리를 포함한 모든 플릿 컨트롤 편집을 관리하기 위한 포괄적인 가변줄 인터페이스입니다. CLI는 대화형 작업과 자동화를 위한 구조화된 터미널 기반 인터페이스를 제공합니다.

명령 계층 구조

괄호 제어 명령은 직관적인 탐색을 위해 리소스 유형별로 구성되어 있습니다.

newrelic fleetcontrol
├── fleet                    # Fleet management
│   ├── create              # Create a new fleet
│   ├── get                 # Get fleet details
│   ├── search              # Search fleets
│   ├── update              # Update fleet
│   ├── delete              # Delete fleet(s)
│   └── members             # Manage fleet members
│       ├── add             # Add entities to ring
│       ├── remove          # Remove entities from ring
│       └── list            # List fleet members
│
├── configuration            # Configuration management
│   ├── create              # Create configuration
│   ├── get                 # Get configuration content
│   ├── delete              # Delete configuration
│   └── versions            # Manage configuration versions
│       ├── list            # List all versions
│       ├── add             # Add new version
│       └── delete          # Delete specific version
│
├── deployment               # Deployment management
│   ├── create              # Create deployment
│   ├── update              # Update deployment
│   ├── deploy              # Trigger deployment
│   └── delete              # Delete deployment
│
└── entities                 # Entity queries
    ├── get-managed         # List managed entities
    └── get-unassigned      # List available entities

핵심 역량

플릿의 위험 CLI를 사용하면 다음을 수행할 수 있습니다.

• 에이전트 작업 중앙 집중화: 메가줄에서 모든 에이전트 및 통합을 설치, 모니터링, 구성 및 업데이트합니다.
• 함대 관리: 전체 함대에 대한 분량 측정, 소모 요구 사항 및 에이전트 버전 업그레이드를 기준으로 그룹화
• 생성 및 버전 설정: 작성자 저항 설정 및 여러 버전 관리
• 제어 구현, 배포: 생성, 업데이트 및 트리거 구현, 링 기반 롤아웃을 통한 배포
• 엔티티 쿼리: 관리되는 엔티티와 할당되지 않은 엔티티 목록을 확인하여 전체 자산 현황을 파악합니다.

전제 조건

플릿 위험 CLI 명령을 사용하기 전에 다음이 필요합니다.

필수 환경 변수:

$
# Your New Relic User API Key
$
export NEW_RELIC_API_KEY="NRAK-YOUR-API-KEY-HERE"
$

$
# Your New Relic Account ID
$
export NEW_RELIC_ACCOUNT_ID="your-account-id"
$

$
# Optional: Specify region (defaults to US)
$
export NEW_RELIC_REGION="US"  # or "EU" for European accounts

자격 증명 받기:

1. API 키: one.newrelic.com → 사용자 이름 클릭 → API Keys → Create a "User" key에서 사용자 API 키를 생성하세요.
2. 계정 ID: 계정 ID는 뉴렐릭 URL의 /accounts/ 뒤 또는 계정 설정에서 찾을 수 있습니다.
3. 조직 ID: 대부분의 명령은 선택적으로 --organization-id 플래그를 허용합니다. 조직 ID가 제공되지 않으면 CLI는 API 자격 증명을 사용하여 자동으로 조직 ID를 가져옵니다.

CLI 문서 전체 보기

설치 및 설정을 포함하여 뉴렐릭 CLI를 시작하려면 뉴렐릭 CLI 클립을 참조하세요.

플릿 컨트롤 명령 참조, 응답 형식, 유효성 검사 규칙, 문제 해결, 해결 지침에 대한 자세한 내용은 플릿 컨트롤 CLI README 참조하세요.

CLI 설명서에는 다음 내용이 포함됩니다.

• 모든 작업에 대한 전체 명령 참조
• 응답 형식 사양
• JSON 응답을 사용하여 작업하기 jq
• 실제적인 워크플로우 예시
• 유효성 검사 규칙 및 허용 값
• 문제 해결, 일반적인 문제 해결
• 플래그 구문 및 사용 패턴

프로그래밍 방식 액세스 시작하기

프로그래밍 방식으로 플릿의 가능성을 사용하려면:

1. 뉴렐릭 계정 설정에서 Generate a User API Key [사용자 API 키를 생성하세요]

2. 뉴렐릭 플랫폼에서 계정 ID와 조직 ID를 확인하세요.

3. 접속 방법을 선택하세요:

   • NerdGraph Explorer를 사용하여 함대 운용을 대화형으로 탐색해 보세요.
   • 설정 관리를 위한 Blob Storage API 작업 내용을 검토하세요.
   • 터미널 기반 Fleet Control CLI 설치 및 구성

4. 데이터 구조에 익숙해지기 위해 읽기 작업부터 시작하세요 (플릿 검색, 목록 보기, 설정 가져오기).

5. 프레임워크 또는 스토리 흐름으로 작업을 점진적으로 결합하여

API 사용에 대한 추가 도움말은 NerdGraph 소개 문서와 API 키 문서를 참조하세요.