NerdGraph 튜토리얼: API 키 관리

이 문서에는 NerdGraph를 사용하여 일부 뉴렐릭 API 키(볼륨 키, 브라우저 키, 사용자 키)를 프로그래밍 방식으로 관리하는 방법에 대한 튜토리얼이 포함되어 있습니다. 키에 대한 일반 정보는 API 키를 참조하세요.

기능 설명 개요

API 키 UI 를 사용하여 키를 만들고 관리할 수 있습니다. 또는 NerdGraph 의 ApiAccess 필드를 사용하여 프로그래밍 방식으로 다음 유형의 키를 만들고 관리할 수 있습니다.

• NerdGraph 사용에 필요한 사용자 키

• 다음을 포함한 데이터 수집 키:

  • 라이선스 키: 브라우저 모니터링데이터 및 모바일 모니터링데이터를 제외하고 대부분의 데이터를 뉴렐릭으로 수집하는 데 필요합니다.
  • 브라우저 키 : 브라우저 모니터링 데이터 수집에 필요

이 기능의 일반적인 사용 사례 중 하나는 보안을 위해 키를 교체하는 기능입니다. 이 NerdGraph 기능을 사용하여 원래 계정으로 생성된 라이선스 키 또는 브라우저 키를 삭제할 수 없습니다. 원래 키는 삭제할 수 없습니다. 추가 라이선스 키만 생성하고 생성한 키를 관리할 수 있습니다.

이 기능에 대한 참고 사항:

• 모든 변형은 여러 키를 인수로 받아들일 수 있으며 성공적인 변경 및 오류에 대한 세부 정보를 반환합니다. 자세한 내용은 아래 예를 참조하십시오.

• 모든 변형(생성, 업데이트 및 삭제)은 감사 목적으로 쿼리할 수 있는 NrAuditEvent 을 생성합니다. 자세한 내용은 감사 이벤트 를 참조하십시오.

• 라이센스 키 관련:

  • 관측 키는 NerdGraph에서 ingest keys 으로 분류됩니다. 이는 주요 용도가 데이터 수집을 허용하는 것이기 때문입니다.
  • 키 교체를 허용하는 각 라이센스 키 유형에 대해 최대 1,000개의 키를 생성할 수 있습니다.
  • 원본 라이선스 키는 관리하거나 삭제할 수 없습니다. 추가 라이선스 키를 생성하고 생성한 키만 관리할 수 있습니다.

예제를 사용하기 전에

다음 예제 쿼리를 사용하기 전에 주의해야 할 사항:

• 아래 예에서는 라이센스 키(수집 키라고도 함)를 사용하지만 유사한 방식으로 사용자 키 를 쿼리하여 수집 키별 필드를 사용자 키별 필드로 바꿀 수 있습니다.
• 데이터 구조를 이해하려면 GraphiQL 탐색기 를 사용하여 쿼리를 실험하는 것이 좋습니다.
• UI를 사용하여 사용자 키를 생성, 확인 및 삭제할 수도 있습니다.

키 생성

여러 계정 및 키 유형에 대해 단일 변형으로 여러 키(사용자 키 또는 라이선스 키)를 생성합니다. 돌연변이는 성공적으로 생성된 키와 키를 생성하는 동안 발생한 오류를 반환할 수 있습니다.

키 생성 예:

mutation {
  apiAccessCreateKeys(
    keys: {
      ingest: {
        accountId: YOUR_ACCOUNT_ID
        ingestType: BROWSER
        name: "Browser Key"
        notes: "A note."
      }
    }
  ) {
    createdKeys {
      id
      key
      name
      notes
      type
      ... on ApiAccessIngestKey {
        ingestType
      }
    }
    errors {
      message
      type
      ... on ApiAccessIngestKeyError {
        accountId
        errorType
        ingestType
      }
    }
  }
}

결과는 데이터에 따라 다릅니다. GraphiQL 탐색기 를 사용하여 돌연변이 및 쿼리를 실험하십시오.

다음은 이 쿼리를 사용하여 사용자 키 를 만드는 예입니다.

mutation {
  apiAccessCreateKeys(
    keys: { user: { accountId: YOUR_ACCOUNT_ID, userId: YOUR_USER_ID } }
  ) {
    createdKeys {
      id
      key
      name
      notes
      type
      ... on ApiAccessIngestKey {
        ingestType
      }
    }
    errors {
      message
      type
      ... on ApiAccessIngestKeyError {
        accountId
        errorType
        ingestType
      }
    }
  }
}

키 업데이트

업데이트 변형은 키를 식별하기 위해 키 문자열이 아닌 키 ID를 사용합니다.

mutation {
  apiAccessUpdateKeys(
    keys: {
      ingest: { keyId: KEY_ID, name: "Updated name", notes: "A new note!" }
    }
  ) {
    updatedKeys {
      id
      key
      type
      name
      notes
    }
    errors {
      message
    }
  }
}

결과는 데이터에 따라 다릅니다. GraphiQL 탐색기 를 사용하여 돌연변이 및 쿼리를 실험하십시오.

키 삭제

삭제 변형은 키를 식별하기 위해 키 문자열이 아닌 키 ID를 사용합니다. 삭제된 키는 더 이상 New Relic 시스템에 대한 액세스 권한을 부여하지 않으며 API 액세스 GraphQL API에 대한 쿼리에 의해 더 이상 반환되지 않습니다.

mutation {
  apiAccessDeleteKeys(keys: { ingestKeyIds: INGEST_KEY_ID }) {
    deletedKeys {
      id
    }
    errors {
      message
    }
  }
}

결과는 데이터에 따라 다릅니다. GraphiQL 탐색기 를 사용하여 돌연변이 및 쿼리를 실험하십시오.

쿼리 키

액터로 범위가 지정된 단일 키 또는 모든 키를 쿼리하여 수집 및 사용자 키에 액세스할 수 있습니다. 단일 키를 쿼리하는 경우 키 ID 및 유형(INGEST 또는 USER)을 제공해야 합니다. 여러 키에 대한 쿼리는 필수 유형 목록과 선택적 범위를 사용하여 결과를 필터링하는 키 검색을 통해 수행됩니다. 다른 사용자에게 속한 사용자 키는 결과에서 난독화됩니다.

단일 키 예제 쿼리:

query {
  actor {
    apiAccess {
      key(id: "INGEST_KEY_ID", keyType: INGEST) {
        key
        name
        type
        ... on ApiAccessIngestKey {
          ingestType
        }
      }
    }
  }
}

주요 검색 예시 쿼리:

query {
  actor {
    apiAccess {
      keySearch(query: { types: INGEST, scope: { ingestTypes: BROWSER } }) {
        keys {
          name
          key
          type
          ... on ApiAccessIngestKey {
            ingestType
          }
        }
      }
    }
  }
}

결과는 데이터에 따라 다릅니다. GraphiQL 탐색기 를 사용하여 돌연변이 및 쿼리를 실험하십시오.