API Manager UI에서 분석 액세스

API Manager UI에서 분석 데이터를 보고, 분석하고, 내보내는 방법입니다.

분석 데이터는 API Manager UI의 대시보드에 표시됩니다. 대시보드는 제공자 조직, 카탈로그 및 공간 레벨에서 범위가 지정됩니다.

카탈로그 또는 공간 레벨에서 분석 데이터에 액세스하는 기능은 지정된 역할 및 권한에 따라 다릅니다. 카탈로그 및 스페이스에 대한 자세한 내용은 카탈로그로 작업하기API Connect를 참조하세요.

카탈로그 범위 분석 대시보드에 액세스하려면 다음 단계를 완료합니다:
  1. API 관리자 UI에서 탐색 패널의 [관리 카탈로그 관리 아이콘 ]를 선택합니다.
  2. API Manager 대시보드의 사용 가능한 카탈로그 목록에서 필요한 카탈로그를 선택하십시오.
  3. 선택 사항: 스페이스가 활성화되어 있고 스페이스의 범위에서 분석을 보려는 경우:
    1. 공간 탭을 클릭하십시오.
    2. 보려는 공간을 선택하십시오.
  4. ‘분석’ 탭을 클릭하세요.분석 카탈로그 보기

Draft comment: iainsoed@uk.ibm.com
Also talk about analytics for API troubleshooting in manager UI. Not really covered anywhere atm

분석 대시보드

API Manager UI의 분석 대시보드는 제공자 조직, 카탈로그 및 공간의 범위에서 API 이벤트 데이터를 표시합니다.

제공자 조직별 대시보드는 탐색 패널의 분석 분석 아이콘 아이콘을 통해 액세스할 수 있습니다. 분석 카탈로그 보기

공간 범위 대시보드는 공간을 볼 때 분석 탭에서 액세스할 수 있습니다.

다음 대시보드를 사용할 수 있습니다.
  • 요약: 통화 볼륨, 대기 시간 및 해당 통화가 발생하는 시기에 대한 간략한 정보입니다.
  • 이용: 클라우드의 총 API 호출 수입니다. 이용 기반 라이센싱에 필요합니다.
  • API: 호출되는 API와 호출되지 않는 API에 대해 알아야 하는 모든 것입니다.
  • 제품 : 전체적으로 또는 시간에 따라 가장 인기 있는 제품입니다.
    Draft comment: iainsoed@uk.ibm.com
    This dashboard doesn't mean much on the CMC, maybe will change in future: https://ibmapim.slack.com/archives/C016L7RA2RH/p1655806918287239?thread_ts=1655806509.463429&cid=C016L7RA2RH.
  • 이용자: 시간이 경과하면서 전체적으로 가장 많은 API 호출을 작성하는 이용자 조직을 판별합니다.
  • 애플리케이션: 총 시간 및 시간에 따른 대부분의 API 호출을 담당하는 애플리케이션입니다.
  • AI 사용량: AI 토큰 수와 모델 사용량을 추적하여 AI 서비스가 어떻게 사용되고 있는지 확인하세요.
  • 상태 : API 호출 성공 및 실패에 대한 중요 정보로, 시간 경과에 따른 성공률과 실패율을 HTTP 응답 코드 분석과 함께 표시합니다.
  • 대기 시간: API가 응답을 리턴하는 데 걸리는 시간 및 시간에 따른 대기 시간의 변경입니다.
  • 데이터 전송: 요청 및 응답 페이로드에 대한 모든 정보. 가장 큰 요청 및 응답 페이로드에 대한 책임이 있는 API, 이용자 및 애플리케이션입니다.
  • 클라이언트 정보: API를 호출하는 사용자 및 디바이스.
    참고: 인터넷에서 액세스할 수 있는 IP 주소만 지리적 위치로 분석할 수 있습니다. 내부 IP 주소는 무시됩니다.
  • 게이트웨이 조작: 각 게이트웨이 서비스의 각 게이트웨이에 대한 호출 볼륨 및 대기 시간 정보. 이 정보를 사용하여 로드가 균등하게 분산되고 있는지 또는 게이트웨이가 저성능인지 여부를 판별할 수 있습니다.

대시보드의 각 차트를 PNG 또는 JPG 이미지로 내보낼 수 있습니다. 각 차트의 원본 데이터는 JSON 또는 CSV 파일로 내보낼 수 있습니다. 차트를 내보내려면 오른쪽 상단의 ‘작업’을 클릭하세요:분석 예제 원형 차트

을 클릭하면 차트를 전체 화면으로 분석 전체 화면 아이콘확대할 수도 있습니다. 원본 데이터를 표 형식으로 보려면 여기를 클릭하세요 분석 테이블 아이콘.

보기 발견

기본적으로 대시보드 탭이 표시됩니다. API 이벤트 데이터를 표 양식으로 보려면 검색을 선택하십시오.

분석 검색 보기UI를 통해 액세스할 수 있는 API 이벤트의 최대 개수는 10,000개입니다. 검색 보기에서 페이지당 표시할 수 있는 최대 이벤트 레코드 수는 200입니다.

필터 섹션에 표시되는 열을 사용자 정의할 수 있습니다. 열 머리글을 클릭하면 테이블을 오름차순 또는 내림차순으로 정렬할 수 있습니다.

타임라인 차트를 대수 Y축으로 전환하고 차트의 오른쪽 상단에 있는 조치 를 클릭하여 차트의 데이터를 내보낼 수 있습니다.

차트 데이터 내보내기 및 타임라인 메뉴 전환

테이블의 오른쪽 상단에 있는 조치 를 클릭하여 테이블에서 API 이벤트 데이터를 내보낼 수 있습니다.

애널리틱스 데이터 내보내기 메뉴 옵션

참고: ‘Discover’ 보기에서 ‘ CSV 로 내보내기’ 또는 ‘JSON으로 내보내기’를 선택하여 데이터를 내보낼 경우, 현재 결과 페이지에 표시된 데이터만 내보내집니다. 모든 페이지의 데이터를 내보내려면 ‘ CSV 형식의 전체 데이터’ 또는 ‘JSON 형식의 전체 데이터’를 선택하세요. 툴킷 CLI를 사용하여 모든 애널리틱스 데이터를 내보낼 수도 있습니다. 자세한 내용은 ‘분석 데이터 내보내기 ’를 참조하세요.

‘Discover’ 보기에 예상치 못한 ‘ HTTP OPTIONS’ 이벤트가 표시된다면, 이는 브라우저 기반 API 테스트 도구에서 발생한 ‘ CORS ’ 요청 때문인 것입니다. 테스트 도구 및 OPTIONS 호출에 대한 자세한 정보는 API 테스트를 참조하십시오.

표시된 데이터 필터링

필터 ( 조회라고도 함) 를 정의하여 대시보드검색 보기에 표시되는 데이터를 필터링할 수 있습니다. 필터 섹션을 펼쳐 표시된 데이터를 보고, 정의하고, 조회를 적용하십시오.

분석 필터 설정

정의한 조회를 저장하고 공유할 수 있습니다.
  • 공유 조회는 동일한 범위의 모든 사용자에게 표시됩니다. 다른 범위의 사용자에게는 표시되지 않습니다. 예를 들어, Cloud Manager UI 사용자가 공유하는 조회는 API Manager UI 사용자에게 표시되지 않습니다. API Manager UI에서 카탈로그 범위에서 작성된 조회는 제공자 조직 범위에서 분석 데이터를 보는 사용자에게 표시되지 않습니다.
  • 다른 사용자는 사용자가 공유하는 조회를 편집하거나 삭제할 수 없지만 편집하고 공유할 수 있는 중복 조회를 작성할 수 있습니다.
  • 모든 조회에는 이름 및 선택적 설명이 있습니다. 이름은 고유할 필요가 없습니다.

저장된 조회는 REST API및 툴킷 CLI 조회에서 사용할 문자열로 내보낼 수 있습니다. 예를 들면, 다음과 같습니다.

분석 복사 조회 메뉴 옵션다음 문자열을 클립보드에 복사합니다:
timeframe=last7days

애널리틱스에서 기본 쿼리 설정

이제 애널리틱스에서 대시보드 또는 검색 페이지를 방문할 때 자동으로 적용되는 기본 쿼리를 설정할 수 있습니다. 기본 쿼리는 사용자 및 범위(조직, 카탈로그 또는 스페이스) 별로 구성됩니다.
참고:
  • 공유 쿼리만 기본 쿼리로 설정할 수 있습니다.
  • 각 범위에는 사용자당 하나의 기본 쿼리가 있을 수 있습니다. 각 카탈로그와 스페이스마다 다른 기본 쿼리를 설정할 수 있습니다.
  1. 기본값으로 설정하려는 쿼리가 저장되었는지 확인합니다.
  2. 저장된 쿼리를 공유하려면 다음 단계를 완료하세요.
    • 저장된 탭을 클릭합니다.
    • 옵션 메뉴에서 공유를 클릭합니다.
    • 쿼리 공유 창에서 공유를 클릭합니다.
  3. 공유 탭을 클릭합니다.
  4. 옵션 메뉴에서 ‘기본 쿼리로 설정’을 클릭하세요.Editanalytics_copy_query.png
  5. 기본 쿼리 창에서 기본값을 클릭합니다.
  6. 기본 쿼리를 즉시 적용하려면 적용을 클릭하십시오. 기본 쿼리는 해당 범위의 모든 사용자에 대해 즉시 적용됩니다. 기본 쿼리를 설정한 후 적용을 클릭하지 않으면 다음에 대시보드 또는 검색 탭을 방문할 때 자동으로 적용됩니다.

보고서 보기

보고서 보기에서는 개별 API 이벤트가 아닌 장기적인 요약 데이터를 표시합니다.분석 보고서 보기
참고: 보고서 보기는 v10.0.6에서 도입되었으며 v10.0.6으로 업그레이드하기 전에 생성된 데이터를 포함하지 않습니다.

호출량 추세에서는 가장 많이 호출된 API와 가장 적게 호출된 API, 성공 및 실패한 API 호출의 총 건수, 송수신된 총 바이트 수, 그리고 범위별 총계를 확인할 수 있습니다.분석 호출 볼륨 경향 타일

소비자 동향은 시간의 흐름에 따른 소비자 수와 구독 및 애플리케이션 이용 현황을 보여줍니다: 분석 이용자 경향 타일

사용량 보고서는 게이트웨이를 통해 처리된 API 호출의 장기적인 추세를 보여주며, 이는 사용량 기반 라이선싱에 대한 통찰력을 얻는 데 필수적입니다.소비_보고서

‘비활성 상품’은 구독자가 없는 상품과 트래픽이 없는 상품을 표시합니다.분석 비활성 제품 타일

‘비활성 소비자 단체’는 신청 건, 구독, 최근 트래픽이 없거나 트래픽이 전혀 없는 소비자 단체를 의미합니다.분석 비활성 이용자 조직 타일

‘사용 중단된 상품’은 더 이상 지원되지 않지만 여전히 조회수가 발생하는 상품들을 보여줍니다.사용되지 않는 제품 보고서

API 호출량 순위표 섹션에는 API, 제품, 요금제, 애플리케이션, 소비자 조직, 게이트웨이 서비스 및 카탈로그별 분석에 대한 순위표가 표시됩니다. 이름 을 클릭하면 각 항목의 데이터를 확인할 수 있습니다.분석 호출 볼륨 리더보드 테이블