API 테스트 시작하기

문서 > 시작하기 > 신서틱(Synthetic) 모니터링 시작하기 > API 테스트 시작하기

개요

API 테스트는 언제 어디서나 가장 중요한 서비스가 정상적으로 작동하는지 사전 모니터링합니다. 싱글 API 테스트에는 시스템의 다양한 네트워크 레이어에서 요청을 실행하도록 해주는 하위 유형 8가지가(HTTP, SSL, DNS, WebSocket, TCP, UDP, ICMP, gRPC) 있습니다. 멀티스텝 API 테스트는 연속으로 HTTP 테스트를 실행하여 API 레벨에서 주요 여정의 업타임을 모니터링하도록 해줍니다.

싱글 API 테스트 만들기

HTTP 테스트는 API 엔드포인트를 모니터링하고 응답 레이턴시가 정의된 조건보다 높거나 충족하지 못하는 경우 경고를 보냅니다. 예를 들면 예상되는 HTTP 상태 코드, 응답 시간이나 응답 본문의 내용 등이 정의된 조건을 충족하는지 검증할 수 있습니다.

아래의 예시는 싱글 API 테스트의 하위 유형인 HTTP 테스트를 만드는 방법을 설명합니다.

요청 정의하기

Datadog 사이트에서 UX Monitoring 위에 커서를 두고 **Synthetic Tests**를 선택합니다.
New Test > **New API test**를 클릭합니다.
HTTP 요청 유형을 선택합니다.
요청 정의하기:
- 모니터링할 엔드포인트의 URL을 추가합니다. 어디에서 시작할지 모르겠다면 테스트용 이커머스 웹 애플리케이션인 https://www.shopist.io/를 사용할 수 있습니다. 테스트할 엔드포인트를 정의하면 자동으로 테스트 이름이 Test on www.shopist.io로 지정됩니다.
- Advanced Options를 선택해 사용자 설정 요청 옵션, 인증서, 인증 자격 등을 설정할 수 있습니다.
  참조: 자격 정보를 저장하기 위해 안전한 글로벌 변수를 사용할 수 있습니다. 또, 로컬 변수를 생성하여 동적인 타임스탬프를 요청 페이로드에 삽입할 수도 있습니다. 이러한 변수를 생성한 후 관련 필드에 {{로 입력하고 변수를 선택하면 테스트 옵션에 변수가 삽입됩니다.
  이번 예시에서는 특정 고급 옵션이 필요하지 않습니다.
- env:prod, app:shopist 등의 태그를 테스트에 설정할 수 있습니다. 태그를 사용하면 테스트 스위트(suite)를 정리하고, 홈페이지에서 관심 있는 테스트를 빠르게 찾을 수 있습니다.
Test URL을 클릭해 샘플 테스트 실행을 트리거하세요.

어설션(표명) 정의하기

Test URL을 클릭하면 엔드포인트 응답에 대한 기본 어설션이 자동으로 입력됩니다. 어설션은 테스트 실행 성공을 정의합니다.

이번 예시에서는 샘플 테스트 실행을 트리거한 후 세 가지 기본 어설션이 입력됩니다.

어설션은 사용자의 의향에 따라 맞춤 설정이 가능합니다. 커스텀 어설션을 추가하려면 헤더와 같은 응답 미리보기의 요소를 클릭하거나, New Assertion을 클릭해 신규 어설션을 처음부터 정의하세요.

위치 선택하기

테스트를 실행하려면 하나 이상의 Managed Locations 또는 Private Locations를 선택하세요. Datadog’s out-of-the-box managed locations allow you to test public-facing websites and endpoints from regions where your customers are located.

Americas	APAC	EMEA
Canada Central (AWS)	Hong Kong (AWS)	Cape Town (AWS)
Northern California (AWS)	Mumbai (AWS)	Frankfurt (AWS)
Northern Virginia (AWS)	Seoul (AWS)	Ireland (AWS)
Ohio (AWS)	Singapore (AWS)	London (AWS)
Oregon (AWS)	Sydney (AWS)	Paris (AWS)
São Paulo (AWS)	Tokyo (AWS)	Stockholm (AWS)
Virginia (Azure)	Osaka (AWS)	Milan (AWS)
	Jakarta (AWS)	Bahrain (AWS)

The Datadog for Government site (US1-FED) uses the following managed location:

Americas
US-West

Shopist 애플리케이션은 https://www.shopist.io/에서 공용으로 사용할 수 있으므로 테스트를 실행할 관리되는 위치를 선택할 수 있습니다. 내부 애플리케이션을 테스트하거나 개별 지리적 영역에서 사용자 동작을 시뮬레이션하려면 개인 위치를 사용하세요.

테스트 빈도 지정

테스트를 실행할 빈도를 선택합니다. 기본 빈도인 1분을 그대로 둘 수도 있습니다.

스케줄에 따라 신서틱 테스트를 실행할 뿐만 아니라 CI/CD 파이프라인에서 수동으로 또는 직접 트리거할 수 있습니다.

경고 조건 정의

경고 조건을 정의하여 이따금 일시적으로 발생하는 네트워크 문제 등에 대하여 테스트가 트리거되지 않도록 설정할 수 있습니다. 이렇게 하면 엔드포인트에 실제 문제가 발생한 경우에만 경고를 받습니다.

위치에서 실행할 수 없다고 판단하기 전에 발생해야 하는 연속 실패 횟수를 지정할 수 있습니다.

Retry test 2 times after 300 ms in case of failure

또한 엔드포인트가 특정 시간 동안, 특정 개수의 위치에서 실행에 실패했을 때만 알림을 보내도록 테스트를 설정할 수도 있습니다. 다음 예시에서는 서로 다른 위치 두 곳에서 테스트가 3분간 실패할 경우 알림을 전송하도록 경고 규칙이 설정되어 있습니다.

An alert is triggered if your test fails for 3 minutes from any 2 of 13 locations

테스트 모니터 설정

나만의 경고 메시지를 디자인하고 테스트에서 경고를 보낼 이메일 주소를 추가하세요. 또한 Slack, PagerDuty, Microsoft Teams, 웹훅 등의 알림 통합을 사용할 수도 있습니다. 이러한 도구에서 신서틱 경고를 트리거하려면 먼저 해당하는 통합을 설정하셔야 합니다.

테스트 설정을 저장하고 모니터할 준비가 되면 Create를 클릭합니다.

멀티스텝 API 테스트 만들기

멀티스텝 API 테스트를 사용하면 주요 비즈니스 트랜잭션을 API 수준에서 모니터링할 수 있습니다.

HTTP 테스트와 유사하게, 멀티스텝 API 테스트는 엔드포인트가 너무 느리거나 정의한 조건을 충족하지 못할 때 경고를 보냅니다. 개별 스텝 응답에서 변수를 생성할 수 있고, 이러한 값을 다음 단계에 다시 입력해 애플리케이션이나 서비스의 작동을 모사하는 방식으로 각 절차를 연결할 수 있습니다.

아래의 예시는 장바구니에 제품을 추가하는 행동을 모니터링하는 멀티스텝 API 테스트를 만드는 방법을 설명합니다. 테스트는 3단계 절차로 구성됩니다.

장바구니 만들기
제품 만들기
제품을 장바구니에 추가하기

어느 API 엔드포인트에서 멀티스텝 API 테스트를 만들어야 할지 모르겠다면 아래의 예시 엔드포인트를 사용하세요.

새로운 멀티스텝 API 테스트를 만들려면 New Test > **Multistep API test**를 클릭하세요. Add product to cart와 같은 테스트 이름을 추가하고 태그를 포함한 다음 위치를 선택합니다.

장바구니 만들기

Define steps에서 Create Your First Step를 클릭합니다.
단계에 이름을 추가합니다(예: Get a cart).
쿼리할 HTTP 메소드와 URL을 지정합니다. POST 및 https://api.shopist.io/carts를 입력할 수 있습니다.
Test URL을 클릭하세요. 이렇게 하면 Shopist 애플리케이션 백엔드에 장바구니 제품이 생성됩니다.
기본 어설션을 그대로 두거나 수정합니다.
선택 사항으로, 실행 파라미터를 정의할 수 있습니다.
Continue with test if this step fails를 선택하면 전체 엔드포인트 컬렉션을 테스트했는지, 이전 단계의 성공이나 실패와 관계없이 최근 정리 단계를 실행했는지를 확인하는 데 도움이 됩니다. Retry 단계 기능은 API 엔드포인트에서 응답하기까지 시간이 다소 소요된다는 점을 알고 있는 상황에 유용합니다.
이번 사례에서는 특정 실행 파라미터가 필요하지 않습니다.
장바구니 ID의 변수를 벗어난 변수를 location 헤더 끝에 위치하도록 만드는 방법은 다음과 같습니다.
- Extract a variable from response content를 클릭합니다.
- 변수 이름을 CART_ID라고 설정합니다.
- Response Header에서 location을 선택합니다.
- Parsing Regex 필드에서 `(?:^\/)+{TX-PL-LABEL}#x60; 등의 정규 표현식을 추가합니다.
Save Variable을 클릭합니다.
테스트 절차 만들기를 완료했다면 Save Step을 클릭합니다.

제품 만들기

Define another step에서 Add Another Step를 클릭합니다. 기본적으로 최대 10단계까지 절차를 만들 수 있습니다.
단계에 이름을 추가합니다(예: Get a product).
쿼리할 HTTP 메소드와 URL을 지정합니다. 여기에서는 GET 및 https://api.shopist.io/products.json를 추가할 수 있습니다.
Test URL을 클릭합니다. 이렇게 하면 Shopist 애플리케이션에서 이용 가능한 제품 목록을 불러옵니다.
기본 어설션을 그대로 두거나 수정합니다.
선택 사항으로, 실행 파라미터를 정의할 수 있습니다. 이번 예시에서는 특정 실행 파라미터가 필요하지 않습니다.
제품 ID에서 벗어난 변수를 응답 본문에 위치하도록 만드는 방법은 다음과 같습니다.
- Extract a variable from response content를 클릭합니다.
- 변수 이름을 PRODUCT_ID라고 설정합니다.
- Response Body 탭을 클릭합니다.
- 제품의 $oid 키를 클릭해 JSON Path를 생성합니다(예: $[0].id['$oid']).
Save Variable을 클릭합니다.
테스트 절차 만들기를 완료했다면 Save Step을 클릭합니다.

제품을 장바구니에 추가하기

Add Another Step를 클릭해 마지막 단계를 추가해, 제품을 장바구니에 넣는 단계를 더합니다.
단계에 이름을 추가합니다(예: Add product to cart).
쿼리할 HTTP 메소드와 URL을 지정합니다. 여기에서는 POST 및 https://api.shopist.io/add_item.json를 추가할 수 있습니다.

Request Body 탭에서 application/json 본문 유형을 선택하고 다음을 입력합니다.

    {
      "cart_item": {
        "product_id": "{{ PRODUCT_ID }}",
        "amount_paid": 500,
        "quantity": 1
      },
      "cart_id": "{{ CART_ID }}"
    } 
    

Test URL을 클릭합니다. 이렇게 하면 2단계에서 추출한 제품이 1단계에서 생성한 장바구니에 들어가고, 결제 URL이 반환됩니다.
**Add assertions (optional)**에서 Response Body를 클릭하고 url 키를 클릭해, 결제 완료 URL을 포함한 응답을 포함하여 테스트에서 여정이 완료되었음을 표명합니다.
이번 마지막 단계에서는 실행 파라미터와 변수 추출이 필요하지 않습니다.
테스트 절차 만들기를 완료했다면 Save Step을 클릭합니다.