커스텀 보고서 만들기 및 관리

현재 Apigee Edge 문서가 표시되고 있습니다.
Apigee X 문서로 이동 정보

커스텀 보고서를 사용하면 특정 API 측정항목을 상세히 살펴보고 보려는 정확한 데이터를 확인할 수 있습니다. Edge에서 기본 제공되는 metrics과 측정기준을 사용하여 커스텀 보고서를 만들 수 있습니다. 또한 사용자 또는 제품 ID, 가격, REST 작업, 대상 버전, 대상 URL, 메시지 길이와 같은 커스텀 측정항목을 수집하기 위해 API 프록시에 StatisticsCollector 정책을 연결할 수 있습니다.

동영상

커스텀 보고서에 대해 자세히 알아보려면 다음 동영상을 시청하세요.

동영상	설명
UI를 사용하여 커스텀 보고서 만들기	Edge UI를 사용하여 커스텀 보고서를 만드는 방법을 알아봅니다.
커스텀 보고서 개요	커스텀 보고서 사용에 대한 개요를 확인합니다.
API 지연 시간 추적	커스텀 보고서를 사용하여 API 지연 시간을 추적하는 방법을 알아봅니다.
API 오류 응답 추적	커스텀 보고서를 사용하여 API 오류 응답을 추적합니다.

커스텀 보고서에 대한 정보

맞춤 보고서를 작성할 때 표시할 데이터 (측정항목)를 선택하고, 데이터를 의미 있는 방식 (측정기준)으로 그룹화하고, 원하는 경우 데이터의 특정 특성 (필터)에 따라 반환되는 데이터를 제한할 수 있습니다.

커스텀 보고서에 표시되는 차트 유형을 열 또는 선 차트로 설정할 수도 있습니다. 다음 이미지는 API 프록시 측정기준별로 그룹화된 초당 트랜잭션의 차트 예시입니다.

• 열 - 각 API 프록시는 서로 다른 열로 표시됩니다.

  

• 선 - 각 API는 서로 다른 선으로 표시됩니다.

  

측정항목 및 측정기준 설정

커스텀 보고서에 대해 선택한 metrics은 측정하려는 데이터를 지정합니다. 일반적인 측정항목은 다음과 같습니다.

• 초당 트랜잭션 수
• 응답 시간
• 정책 오류

일부 측정항목을 사용하면 측정항목에 대해 실행할 집계 함수를 설정할 수 있습니다. 예를 들어 응답 시간 측정항목과 함께 다음 집계 함수를 사용할 수 있습니다.

• avg: 평균 응답 시간을 반환합니다.
• min: 최소 응답 시간을 반환합니다.
• max: 최대 응답 시간을 반환합니다.
• sum: 모든 응답 시간의 합계를 반환합니다.

일부 측정항목은 모든 집계 함수를 지원하지 않습니다. metrics 문서에는 측정항목 이름 및 측정항목에서 지원하는 함수(sum, avg, min, max)를 지정하는 테이블이 포함되어 있습니다.

측정기준은 측정항목 데이터를 그룹화하는 방법을 지정합니다. 예를 들어 응답 시간 측정항목을 보여주는 맞춤 보고서를 만들려고 합니다. 측정기준을 사용하여 API 제품, API 프록시 또는 개발자 이메일로 측정항목 데이터를 그룹화하면 다음 항목을 가져올 수 있습니다.

• API 제품 당 응답 시간
• API 프록시 당 응답 시간
• 개발자 이메일 당 응답 시간

커스텀 보고서의 차트에 측정기준이 표시되는 방식은 차트 유형에 따라 다릅니다.

• 열: 각 열은 측정기준의 여러 값에 해당합니다.
• 선: 차트의 각 선은 측정기준의 다른 값에 해당하며 X축은 시간을 나타냅니다.

맞춤 측정항목 및 측정기준 만들기

API 프록시에 StatisticsCollector 정책을 추가하여 사용자 또는 제품 ID, 가격, REST 작업, 대상 버전, 대상 URL, 메시지 길이와 같은 커스텀 분석 데이터를 수집합니다. 데이터는 Apigee에서 사전 정의된 흐름 변수, 요청 헤더, 쿼리 매개변수 또는 사용자가 정의하는 커스텀 변수에서 가져올 수 있습니다. 데이터가 수집되면 커스텀 보고서를 만들어 해당 데이터를 볼 수 있습니다.

커스텀 보고서에 커스텀 분석 데이터를 표시하는 방법은 데이터 유형에 따라 다릅니다.

• 문자열 유형의 데이터인 경우 커스텀 보고서에서 통계 데이터를 측정기준으로 참조하세요.
• 숫자 데이터 유형(integer/float/long/double)의 경우 커스텀 보고서의 통계 데이터를 측정기준 또는 측정항목으로 참조하세요.

커스텀 분석 데이터를 수집하는 예시는 StatisticsCollector 정책을 참조하세요.

필터 설정

필터를 사용하면 반환할 측정항목 데이터에 대한 특정 특성을 설정하여 커스텀 보고서에 표시되는 측정항목 데이터를 제한할 수 있습니다. 예를 들어 특정 값보다 큰 응답 시간 또는 특정 이름의 API 프록시에 대한 측정항목 데이터만 표시하도록 필터를 만들 수 있습니다.

필터는 eq, ne, gt, lt 등의 연산자를 사용하여 복잡한 필터를 빌드할 수 있는 조건 구문을 사용합니다.

커스텀 보고서 예시

가장 간단한 커스텀 보고서 유형에서는 단일 측정항목과 단일 측정기준을 지정합니다. 예를 들어 다음 설정을 사용하여 커스텀 보고서를 정의할 수 있습니다.

• 유형 = 열
• 측정항목 = 초당 평균 트랜잭션 수
• 측정기준 = API 프록시

커스텀 보고서에는 API 프록시 측정기준별로 그룹화된 '초당 평균 트랜잭션 수' 측정항목 데이터가 포함된 열 차트가 포함됩니다.

평균을 표시하는 측정항목은 위의 차트에서 볼 수 있듯이 차트 오른쪽에 분산 표시 링크도 표시합니다. 링크 위로 마우스를 이동해 분포 박스를 엽니다. 분포 박스는 데이터의 중심 경향을 표시합니다.

커스텀 보고서에 여러 측정항목을 추가할 수 있습니다. 예를 들어 다음과 같이 2개 측정항목으로 커스텀 보고서를 정의합니다.

• 유형 = 열
• 측정항목 = 초당 평균 트랜잭션 수
• 측정항목 = 정책 오류
• 측정기준 = API 프록시

커스텀 보고서에는 측정항목마다 별도의 차트가 포함됩니다.

커스텀 보고서에 여러 측정기준을 추가할 수 있습니다. 예를 들어 2개의 측정항목과 2개의 측정기준이 포함된 다음과 같은 설정으로 커스텀 보고서를 정의합니다.

• 유형 = 열
• 측정항목 = 초당 평균 트랜잭션 수
• 측정항목 = 정책 오류
• 측정기준 = API 프록시
• 측정기준 = 요청 동사

이 차트에는 커스텀 보고서를 만들 때 지정된 첫 번째 측정기준인 프록시별로 그룹화된 측정항목이 표시됩니다.

그런 다음 첫 번째 측정기준에 해당하는 프록시 드롭다운을 사용하여 개별 프록시를 선택할 수 있습니다. 이제 업데이트된 차트에는 요청 동사별로 선택한 프록시의 측정항목이 표시됩니다.

커스텀 보고서에 측정기준을 더 많이 추가하면 각 측정기준별로 보고서를 상세히 살펴볼 수 있도록 UI가 조정됩니다.

모든 커스텀 보고서 보기

아래에 설명된 대로 맞춤 보고서 페이지에 액세스합니다.

다음 그림과 같이 커스텀 보고서 페이지에 조직에 대해 만든 모든 커스텀 보고서가 표시됩니다.

그림에 강조표시된 것처럼 커스텀 보고서 페이지에서 다음을 수행할 수 있습니다.

• 모든 커스텀 보고서의 목록 보기
• 커스텀 보고서를 추가
• 목록에서 이름을 클릭하여 커스텀 보고서를 실행합니다. 보고서는 기본적으로 지난 1시간 동안 수집된 데이터를 사용하여 실행되며 데이터는 커스텀 보고서 대시보드에 표시됩니다. 커스텀 보고서 대시보드 살펴보기를 참조하세요.
• 검색창에 관련 문자열의 전체 또는 일부를 입력하여 커스텀 보고서 목록을 검색합니다. 표시된 모든 필드는 문자열에 대해 검색됩니다.
• 커스텀 보고서 삭제

커스텀 보고서 대시보드 살펴보기

커스텀 보고서 대시보드는 지정된 측정항목의 열 또는 선 차트를 포함하여 특정 기간에 대한 커스텀 보고서 결과를 표시합니다.

커스텀 보고서 대시보드를 사용하여 다음을 수행할 수 있습니다.

• 선택한 기간의 커스텀 보고서 데이터 보기
• 커스텀 보고서 데이터를 보려는 환경 선택
• 특정 측정기준을 선택하여 커스텀 보고서 데이터 필터링. 이 영역은 보고서에 여러 측정기준을 지정하는 경우에만 사용 설정됩니다.

• 차트 또는 표 보기 선택

• 연결된 측정항목의 테이블 행에 있는 아이콘을 선택하여 측정항목을 분석합니다. 이상치를 확인하고 이전 기간 또는 다른 측정항목과 비교합니다.
• 기간을 클릭하고 설정하여 커스텀 보고서 실행
• CSV 파일로 커스텀 보고서 다운로드. 파일 이름은 metric.csv 형식으로 지정됩니다. 예를 들면 Average_of_total_response_time.csv입니다.
• 커스텀 보고서 수정

측정항목 분석 대시보드 살펴보기

요약 표 행에서 아이콘을 선택하면 다음 차트가 표시됩니다(보고서에서 측정항목 여러 개를 사용하도록 구성한 경우에는 상단 차트만 표시됨).

이 차트에는 다음 정보가 표시됩니다.

• 비교 대상: 여러 측정항목을 사용하도록 보고서를 구성한 경우 측정항목을 서로 비교합니다.
• 이전 기간과 비교: 이전 기간의 측정항목을 열람합니다. 예를 들어 지난 24시간 동안의 커스텀 보고서 보기를 선택한 경우 이 차트는 지난 24시간 동안의 데이터가 표시됩니다.

• 이상치 분석: 보고서 데이터에 주요 데이터 포인트가 표시됩니다. 이 차트에는 두 값이 표시됩니다.

  • 선으로 표시되는 측정항목의 이동 평균입니다. 선에 있는 특정 지점의 이동 평균 값은 해당 시점 측정항목 값의 평균과 이전 데이터 포인트 두 개 측정항목의 값으로 계산됩니다.
  • 차트의 파란색 영역은 측정항목의 평균 최댓값 및 평균 최솟값을 정의합니다. 평균 최댓값은 1.2 * (이동 평균), 평균 최솟값은 0.8 * (이동 평균)입니다.

  이동 평균이 평균 최댓값 또는 평균 최솟값의 범위를 벗어나면 비정상적인 것으로 간주되어 차트에 빨간색 점으로 표시됩니다.

커스텀 보고서 추가

커스텀 보고서를 추가하여 API 프로그램의 모든 측면에 대한 유용한 정보를 제공하는 일련의 차트를 만들 수 있습니다.

커스텀 보고서를 추가한 후에는 동기식 또는 비동기식으로 이 보고서를 run해야 합니다.

커스텀 보고서를 추가하려면 다음 안내를 따르세요.

1. 맞춤 보고서 페이지에 액세스하기
2. + 커스텀 보고서를 클릭합니다.
3. 기본 섹션에서 다음 정보를 입력합니다.

   필드	설명
   보고서 이름	보고서의 이름입니다.
   보고서 설명	보고서에 대한 설명입니다.
   차트 유형	맞춤 분석 데이터를 표시하는 데 사용할 차트 스타일을 선택합니다. 열: X축은 측정기준으로 지정된 그룹을 나타냅니다. 선: X축은 시간을 나타냅니다.

4. 측정항목 섹션에서 다음을 실행합니다.
   1. 측정항목의 아이콘을 클릭합니다.
   2. 분석할 측정항목을 선택합니다.
   3. 집계 함수를 선택하여 합계, 평균, 최솟값, 최댓값을 표시합니다.
   4. 저장을 클릭합니다.
   5. 아이콘을 클릭하여 측정항목을 더 추가합니다.
5. 측정기준 섹션에서 을 클릭하고 '프록시'와 같은 측정기준을 선택하여 보고서를 생성하는 데 사용되는 데이터 세트를 제한합니다. 측정기준을 더 추가하여 데이터를 추가로 제한할 수 있습니다.

6. 필터 섹션에서 보고서 정의에 필터를 추가하여 표시되는 데이터의 범위를 더욱 좁히세요. 예를 들어 날씨 API 프록시 또는 개발자인 jane@example.com에 대한 데이터를 제외하는 필터를 추가할 수 있습니다.

   1. 를 클릭하고 필터링할 항목의 이름, = 또는 !=와 같은 연산자, 값을 선택합니다.
   2. 추가를 클릭하여 필터를 저장합니다.
   3. 를 클릭하여 필터를 추가하고 AND 또는 OR 커넥터를 선택합니다.

7. 커스텀 보고서에 액세스할 수 있는 사용자를 제한하려면 보고서에 정의된 커스텀 역할을 수정합니다.

   1. 를 클릭하여 커스텀 역할 설정을 수정합니다.
   2. 보고서 및 액세스 수준(보기, 수정, 삭제)에 액세스하는 데 필요한 커스텀 역할을 선택합니다.
   3. Add를 클릭합니다.
   4. 를 클릭하여 추가 역할을 수정합니다.
8. 저장을 클릭하여 보고서를 저장합니다.

커스텀 보고서 실행

Edge 애널리틱스를 사용하면 보고서를 동기식으로 또는 비동기식으로 실행할 수 있습니다.

• 동기식 보고서의 경우 보고서 요청을 실행하면 분석 서버가 응답을 제공할 때까지 요청이 차단됩니다. 그러나 보고서가 많은 데이터 양(예: 100GB의 데이터)을 처리해야 할 수 있으므로 타임아웃으로 동기식 보고서가 실패할 수 있습니다.

  동기식 보고서의 최대 기간은 14일입니다. 기간을 15일 이상으로 선택하면 보고서가 항상 비동기로 실행됩니다.

• 비동기식 보고서의 경우 보고서 요청을 실행하면 나중에 결과를 검색합니다. 다음은 비동기식 쿼리 처리가 좋은 대안이 될 수 있는 경우입니다.

  • 여러 시간 간격에 걸친 보고서를 분석하고 만드는 경우
  • 쿼리를 복잡하게 만드는 다양한 그룹화 측정기준과 기타 제약조건으로 데이터를 분석하는 경우
  • 일부 사용자 또는 조직에 대한 데이터 볼륨이 현저히 높아진 때 쿼리를 관리하는 경우

  이 문서에서는 UI를 사용하여 비동기식 보고서를 시작하는 방법을 설명합니다. 비동기식 커스텀 보고서 API 사용에 설명된 대로 API를 사용할 수도 있습니다.

특정 기간의 커스텀 보고서를 실행하려면 다음 안내를 따르세요.

1. 맞춤 보고서 페이지에 액세스하기
2. 실행할 보고서를 선택합니다. 기본적으로 보고서에는 이전 1시간 동안의 데이터가 표시됩니다.

3. 다른 기간에 대해 보고서를 실행하려면 다음 안내를 따르세요.

   1. 보고서 상단에서 시간 범위를 클릭하여 커스텀 보고서 시간 선택 팝업을 엽니다.
   2. 다음 중 하나를 선택합니다.
      • 지난 1시간, 어제, 지난 7일 등 사전 정의된 시간 범위

      • 시작/종료 날짜 및 시간을 선택하여 커스텀 기간을 선택하거나 캘린더를 사용하여 시작일 및 종료일을 선택합니다. UTC(세계 협정시)를 사용하려면 UTC를 클릭합니다.

   3. 보고서를 실행하려면 다음 중 하나를 선택합니다.

      • 적용하여 보고서를 동기식으로 실행합니다. 보고서가 완료되면 결과가 커스텀 보고서 대시보드에 표시됩니다. 보고서를 실행하는 데 60초 넘게 소요되면 이 보고서는 자동으로 비동기 보고서로 변환됩니다.

      • 작업 제출: 보고서를 백그라운드 작업으로 비동기식으로 실행하려는 경우. 다음 대화상자가 표시됩니다.

        

        대화상자에서 상태 보기를 클릭하여 커스텀 보고서 작업의 상태를 확인합니다.

비동기식 커스텀 보고서 작업 보기

비동기식 커스텀 보고서 작업을 보려면 다음 중 하나를 선택합니다.

• 백그라운드 작업으로 제출된 보고서 대화상자에서 상태 보기를 클릭합니다.
• 왼쪽 탐색 메뉴에서 분석 > 커스텀 보고서 > 보고서 작업을 선택합니다.

다음 그림에 표시된 대로 보고서 작업 페이지가 표시됩니다.

보고서 작업 페이지에서는 다음을 사용 설정할 수 있습니다.

• 지난 7일 동안 제출된 모든 비동기식 커스텀 보고서 작업 결과를 봅니다.

• 커스텀 보고서 작업을 표시할 환경을 선택합니다.

• 커스텀 보고서를 보려면 상태를 완료해야 합니다. 그런 다음 보고서에 해당하는 행으로 마우스를 이동합니다. 및 아이콘이 나타납니다. 를 펼쳐 보고서를 확인합니다.

• 을 클릭하여 커스텀 보고서를 다운로드합니다.

  전체 보고서는 CSV 파일이 포함된 OfflineQueryResult-xxx.zip이라는 ZIP 파일로 다운로드됩니다.

• 검색창에 관련 문자열의 전체 또는 일부를 입력하여 커스텀 보고서 목록을 검색합니다. 표시된 모든 필드는 문자열에 대해 검색됩니다.

커스텀 보고서 수정

커스텀 보고서를 수정하려면 다음 안내를 따르세요.

1. 맞춤 보고서 페이지에 액세스하기
2. 수정하려는 보고서 이름 위로 마우스를 가져갑니다. 수정 및 삭제 아이콘은 페이지 오른쪽에 나타납니다.
3. 수정 아이콘을 클릭합니다.
4. 커스텀 보고서 세부정보를 수정합니다.
5. 저장을 클릭합니다.

커스텀 보고서 결과로 돌아갑니다.

커스텀 보고서 삭제

커스텀 보고서를 삭제하려면 다음 안내를 따르세요.

1. 맞춤 보고서 페이지에 액세스하기
2. 수정하려는 보고서 이름 위로 마우스를 가져갑니다. 수정 및 삭제 아이콘은 페이지 오른쪽에 나타납니다.
3. 보고서를 삭제하려면 삭제 아이콘을 클릭하세요.