조회¶
GET /api/v1/service_manage/performance/get
개요¶
현재 워크스페이스에서 지정된 기간 내 한 서비스의 성능 통계를 조회합니다.
호출 전 및 사용 단계¶
먼저 서비스 성능 목록에서 service 이름을 가져와 serviceName에 그대로 입력합니다. 통계 범위는 목록과 동일한 start, end를 사용하여 비교할 수 있도록 합니다. 이 API는 첫 번째로 일치하는 통계 항목을 반환하므로 content를 직접 읽습니다. 데이터가 없으면 content는 빈 객체입니다. 서비스 연결 상태는 동기 조회를 사용합니다.
요청 헤더¶
| 파라미터 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>취득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Query 요청 파라미터¶
| 파라미터 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| end | integer | Y | 조회 종료 시간, Unix 밀리초. start와 동일한 시간 기준을 사용합니다. 예: 1785430800000취득 또는 입력 방법: 조회 종료 시각의 Unix 밀리초 정수를 사용합니다. 예: JavaScript Date.getTime() 결과. |
| serviceName | string | Y | 서비스 이름으로, 이름 값과 sman_으로 시작하는 서비스 구성 UUID를 구분합니다. 빈 문자열 허용: False null 허용: False 예: checkout-api취득 또는 입력 방법: 서비스 성능 목록의 content.buckets[].service에서 원본 서비스 이름을 가져오거나, 서비스 구성 목록에서 서비스 이름을 가져올 수 있습니다. |
| start | integer | Y | 조회 시작 시간, Unix 밀리초. end와 함께 실제 필요한 통계 기간을 구성하는 것이 좋습니다. 예: 1785427200000취득 또는 입력 방법: 콘솔 시간 선택기 또는 업무 기록에 따라 조회 시작 시각을 가져와 Unix 밀리초 정수로 변환합니다. 예시 시간은 자신의 조회 기간으로 바꿔야 합니다. |
파라미터 추가 설명¶
응답 시간 원시 값은 마이크로초 단위를 사용하고, 오류율은 0~1 비율을 사용합니다. 통계 내용은 수집 차원에 따라 달라질 수 있습니다.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/service_manage/performance/get' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode start=1785427200000 \
--data-urlencode end=1785430800000 \
--data-urlencode serviceName=checkout-api
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content.key | string | 그룹 서비스 이름이며 일반적으로 service와 동일합니다. |
| content.service | string | 수집 데이터의 서비스 이름이며, 단일 서비스 조회의 serviceName이기도 합니다. |
| content.source_type | string | 수집된 서비스 소스 유형입니다. |
| content.type | string | 호환 필드이며 source_type과 동일합니다. |
| content.version | string | 서비스 버전이며, 해당 통계 차원이 존재할 때 반환됩니다. |
| content.env | string | 서비스 환경이며, 해당 통계 차원이 존재할 때 반환됩니다. |
| content.total_count | integer | 통계 기간의 요청 횟수입니다. |
| content.avg_per_second | number | 초당 평균 요청 횟수이며 단위는 req/s입니다. |
| content.avg_resp_time | number | 평균 응답 시간이며 단위는 마이크로초입니다. 밀리초로 변환할 때는 1000으로 나눕니다. |
| content.sum_resp_time | number | 누적 요청 응답 시간이며 단위는 마이크로초입니다. |
| content.max_duration | number | 최장 요청 응답 시간이며 단위는 마이크로초입니다. |
| content.p50 | number | 응답 시간의 50번째 백분위수이며 단위는 마이크로초입니다. |
| content.p75 | number | 응답 시간의 75번째 백분위수이며 단위는 마이크로초입니다. |
| content.p90 | number | 응답 시간의 90번째 백분위수이며 단위는 마이크로초입니다. |
| content.p95 | number | 응답 시간의 95번째 백분위수이며 단위는 마이크로초입니다. |
| content.p99 | number | 응답 시간의 99번째 백분위수이며 단위는 마이크로초입니다. |
| content.error_count | integer | 오류 요청 횟수입니다. |
| content.error_rate | number | 오류율이며 0~1입니다. 백분율로 표시할 때는 100을 곱합니다. |
| content.apdex | number 또는 string | 백엔드에서 제공할 때 반환되는 Apdex 만족도입니다. |
| content.serviceCatelog | object | 등록된 서비스의 TOML 서비스 구성이 변환되어 생성된 객체입니다. 철자는 serviceCatelog로 유지합니다. 구조는 서비스 구성 생성의 serviceCatelog TOML 문자열을 파싱한 후의 구조와 동일합니다. 생성 파라미터는 여전히 TOML 문자열이며, 필드 의미와 입력 출처는 해당 페이지를 참조하십시오. 등록되지 않은 경우 빈 객체입니다. |
| content.serviceCatelog.Team.team | string | 구성이 존재할 때 담당 팀 이름입니다. 기타 서비스 구성 필드는 서비스 구성 상세와 함께 읽을 수 있습니다. |
| content.checkerInfo | array<object> |
연결된 모니터 목록입니다. |
| content.checkerInfo[].name | string | 모니터 이름입니다. |
| content.checkerInfo[].uuid | string | 모니터 UUID입니다. |
| content.checkerInfo[].type | string | 모니터 유형입니다. |
| content.dfStatus | string | 서비스의 현재 이벤트 상태입니다(예: ok, critical). 상태 기록이 없으면 ok입니다. |
| content.__docid | string | 서비스 상태에 대응하는 이벤트 문서 ID이며, 대응하는 이벤트가 없으면 빈 문자열입니다. |
| content.isFavorite | integer 또는 null | 현재 호출 주체의 즐겨찾기 표시입니다. 등록된 서비스는 0 또는 1이며, 대응하는 서비스 구성이 없으면 null일 수 있습니다. |
| content.uuid | string | 등록된 서비스 구성 UUID입니다. 등록되지 않은 서비스는 빈 문자열일 수 있습니다. |
| content.language | string | 등록된 수집 SDK 언어이며, 등록되지 않은 경우 비어 있을 수 있습니다. |
| content.declaration | object 또는 null | 비어 있지 않은 통계 결과에 추가되는 워크스페이스 공통 선언입니다. |
{
"code": 200,
"content": {
"key": "checkout-api",
"service": "checkout-api",
"source_type": "web",
"type": "web",
"version": "1.0.0",
"env": "production",
"total_count": 1200,
"avg_per_second": 0.333333,
"avg_resp_time": 25000,
"sum_resp_time": 30000000,
"max_duration": 150000,
"p50": 18000,
"p75": 25000,
"p90": 45000,
"p95": 70000,
"p99": 120000,
"error_count": 12,
"error_rate": 0.01,
"serviceCatelog": {},
"checkerInfo": [],
"dfStatus": "ok",
"__docid": "",
"isFavorite": 0,
"uuid": "sman_example",
"language": "python",
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
일치하는 데이터가 없을 때
{
"code": 200,
"content": {},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
일치하는 트레이스 데이터가 없으면 목록은 빈 buckets를 반환하고, 단일 서비스는 빈 객체를 반환하며, 일반적으로 "서비스가 존재하지 않음" 오류는 반환하지 않습니다. 백엔드에서 반환하는 기타 4xx 조회 오류는 실제 errorCode와 message에 따라 반환됩니다.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반했습니다. | 파라미터 파싱 실패 | 파라미터 위치, 필드 이름, 타입 및 값을 확인하십시오. |
| 422 | ft.KodoAPMSummaryRowBudgetExceeded | 서비스 통계 집계 스캔 예산 한도 초과 | APM 서비스 요약 데이터량이 처리 상한을 초과했습니다. 시간 범위를 줄인 후 다시 시도하십시오. | 시간 범위를 줄이십시오. pageSize를 줄여도 전체 서비스 집계 예산은 줄어들지 않습니다. |
| 429 | ft.KodoServerOverloaded | 조회 서비스가 과부하되었거나 사용량이 많습니다. | 현재 요청이 너무 많습니다. 잠시 후 다시 시도하십시오. | 백오프 간격으로 재시도하고 동시 조회 수를 줄이십시오. |
| 500 | ft.InternalServerError | 통계 서비스 사용 불가, 연결 시간 초과 또는 기타 내부 조회 예외가 그대로 전달되지 않음 | 내부 오류 | 잠시 후 다시 시도하거나 시간 범위를 줄이십시오. 계속 실패하면 traceId와 요청 파라미터를 제공하십시오. |
| 406 | ft.KodoRequestDeadlineExceeded | 조회 실행이 백엔드에서 허용된 시간을 초과했습니다. | 데이터 조회 시간 초과. 다음과 같은 원인일 수 있습니다: 데이터량 과다, 네트워크 지연, 서버 부하 과다. 다음 방법으로 해결할 수 있습니다: 1. 필터 조건을 추가하거나 시간 범위를 줄인 후 다시 조회합니다. 2. 잠시 기다린 후 다시 조회합니다. |
시간 범위를 줄이고 serviceName을 확인한 후 재시도하십시오. 계속 실패하면 traceId를 제공하십시오. |
| 406 | ft.KodoTooManyRows | 조회 데이터량이 백엔드 제한을 초과했습니다. | 조회한 데이터량이 최대 수량 제한을 초과했습니다. 필터 조건을 추가하거나 시간 범위를 줄인 후 다시 조회하십시오. | 시간 범위를 줄이고 serviceName을 확인한 후 재시도하십시오. 계속 실패하면 traceId를 제공하십시오. |