- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- Administrator's Guide
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
HTTP tests allow you to send HTTP requests to your applications’ API endpoints to verify responses and defined conditions, such as overall response time, expected status code, header, or body content.
HTTP tests can run from both managed and private locations depending on your preference for running the test from outside or inside your network. HTTP tests can run on a schedule, on-demand, or directly within your CI/CD pipelines.
After choosing to create an HTTP
test, define your test’s request.
Choose the HTTP Method and specify the URL to query. Available methods are: GET
, POST
, PATCH
, PUT
, HEAD
, DELETE
, and OPTIONS
. Both http
and https
URLs are supported.
Name your HTTP test.
Add env
Tags as well as any other tag to your HTTP test. You can then use these tags to filter through your Synthetic tests on the Synthetic Monitoring & Continuous Testing page.
Click Test URL to try out the request configuration. A response preview is displayed on the right side of your screen.
When setting up a new Synthetic Monitoring API test, use snippets to automatically fill in basic auth, performance, and regions, rather than selecting these options manually. The following snippets are available:
Basic Auth: Automatically test your APIs using pre-populated basic auth headers, JavaScript, bearer token, and API/app key auth variables.
Performance: Automatically configure a test with the shortest frequency (one minute), perform a gRPC health check, and test for overall response time latency with a breakdown of network timing.
Regions: Automatically test your API endpoint against a location in each of the three primary geographic regions (AMER, APAC and EMEA).
HTTP/1.1 only
, HTTP/2 only
, or HTTP/2 fallback to HTTP/1.1
.user-agent
header).<COOKIE_NAME1>=<COOKIE_VALUE1>; <COOKIE_NAME2>=<COOKIE_VALUE2>
.Client Certificate: Authenticate through mTLS by uploading your client certificate (.crt
) and the associated private key (.key
) in PEM
format. You can use the openssl
library to convert your certificates. For example, convert a PKCS12
certificate to PEM
formatted private keys and certificates.
openssl pkcs12 -in <CERT>.p12 -out <CERT_KEY>.key -nodes -nocerts
openssl pkcs12 -in <CERT>.p12 -out <CERT>.cert -nokeys
HTTP Basic Auth: Add HTTP basic authentication credentials.
Digest Auth: Add Digest authentication credentials.
NTLM: Add NTLM authentication credentials. Support both NTLMv2 and NTLMv1.
AWS Signature v4: Enter your Access Key ID and Secret Access Key. Datadog generates the signature for your request. This option uses the basic implementation of SigV4. Specific signatures such as Amazon S3 are not supported out-of-the box.
For “Single Chunk” transfer requests to Amazon S3 buckets, add x-amz-content-sha256
containing the sha256-encoded body of the request as a header (for an empty body: x-amz-content-sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
).
OAuth 2.0: Choose between granting client credentials or a resource owner password and enter an access token URL. Depending on your selection, enter a client ID and secret, or a username and password. From the dropdown menu, select an option to either send the API token as a basic authentication header, or send the client credentials in the body. Optionally, you can provide additional information such as the audience, resource, and scope (as well as the client ID and secret, if you selected Resource Owner Password).
application/json
, application/octet-stream
, application/x-www-form-urlencoded
, multipart/form-data
, text/html
, text/plain
, text/xml
, GraphQL
, or None
) you want to add to your HTTP request.application/json
, application/x-www-form-urlencoded
, text/html
, text/plain
, text/xml
, GraphQL
.application/octet-stream
.multipart/form-data
.http://<YOUR_USER>:<YOUR_PWD>@<YOUR_IP>:<YOUR_PORT>
).Define variables for your HTTP API tests with JavaScript:
<div class="shortcode-wrapper shortcode-img expand"><figure class="text-center"><a href="https://datadog-docs.imgix.net/images/synthetics/api_tests/http_javascript.66fe410698cb2c156ee0634db040393e.png?fit=max&auto=format" class="pop" data-bs-toggle="modal" data-bs-target="#popupImageModal"><picture class="" style="width:90%;" >
<img
class="img-fluid"
srcset="https://datadog-docs.imgix.net/images/synthetics/api_tests/http_javascript.66fe410698cb2c156ee0634db040393e.png?auto=format"
style="width:90%;" alt="Define HTTP API test with Javascript" />
</picture></a></figure>
</div>
Assertions define what an expected test result is. After you click Test URL, basic assertions on response time
, status code
, and header
content-type
are added based on the response that was obtained. You must define at least one assertion for your test to monitor.
Type | Operator | Value type |
---|---|---|
body | contains , does not contain , is , is not ,matches , does not match ,jsonpath , xpath | String Regex |
header | contains , does not contain , is , is not ,matches , does not match | String Regex |
response time | is less than | Integer (ms) |
status code | is , is not ,matches , does not match | Integer Regex |
HTTP tests can decompress bodies with the following content-encoding
headers: br
, deflate
, gzip
, and identity
.
You can create up to 20 assertions per API test by clicking New Assertion or by clicking directly on the response preview:
To perform OR
logic in an assertion, use the matches regex
comparator to define a regex with multiple expected values like (200|302)
. For example, you may want your HTTP test to succeed when a server must respond with a 200
or 302
status code. The status code
assertion succeeds if the status code is 200 or 302. You can also add OR
logic on a body
or header
assertion.
If a test does not contain an assertion on the response body, the body payload drops and returns an associated response time for the request within the timeout limit set by the Synthetics Worker.
If a test contains an assertion on the response body and the timeout limit is reached, an Assertions on the body/response cannot be run beyond this limit
error appears.
Select the Locations to run your HTTP test from. HTTP tests can run from both managed and private locations depending on your preference for running the test from outside or inside your network.
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 |
HTTP tests can run:
알림 조건을 설정해 테스트 실패 시 알림을 트리거할 상황을 정의하세요.
알림 조건을 An alert is triggered if any assertion fails for X minutes from any n of N locations
으로 설정하면 해당 두 조건이 참인 경우에만 알림이 트리거됩니다.
결과가 테스트 실패인 경우 Y
밀리초 후 X
회 재시도를 트리거할 수 있습니다. 알림 중요도에 맞게 재시도 간격을 커스터마이즈할 수 있습니다.
위치 가동 시간은 각 평가 기준으로 계산됩니다(평가 전 마지막 테스트 결과가 상승 또는 감소했는지 여부). 총 가동 시간은 설정된 알림 조건에 따라 계산됩니다. 전송된 알림은 총 가동 시간을 기준으로 합니다.
알림은 이전에 정의된 알림 조건 기준 테스트에서 전송됩니다. 이 섹션을 통해 팀에 메시지를 전달하는 방법과 해당 메시지의 내용을 정의하세요.
모니터 설정 방법과 유사하게 알림을 받아야 하는 사용자 및/또는 서비스를 선택합니다. @notification
를 메시지에 추가하거나, 드롭다운 메뉴를 사용해 팀 구성원과 연결된 통합을 검색할 수 있습니다.
테스트에 대한 알림 메시지를 입력합니다. 이 필드는 표준 마크다운 형식을 허용하며 다음 조건부 변수를 지원합니다.
조건 변수 | 설명 |
---|---|
{{ #is_alert }} | 테스트가 알림을 전송하면 표시합니다. |
{{ ^is_alert }} | 테스트가 알림을 전송하지 않으면 표시합니다. |
{{ #is_recovery }} | 테스트에서 알림을 복원하면 표시합니다. |
{{ ^is_recovery }} | 테스트가 일림을 복원하지 않으면 표시합니다. |
{{ #is_renotify }} | 모니터가 알림을 다시 알리면 표시합니다. |
{{ ^is_renotify }} | 모니터가 알림을 다시 알리면 표시합니다. |
{{ #is_priority }} | 모니터가 우선순위(P1~P5)와 일치하면 표시합니다. |
{{ ^is_priority }} | 모니터가 우선순위와 일치하지 않으면 표시됩니다(P1~P5). |
테스트 실패 시 테스트에서 알림 메시지를 재전송할 빈도를 지정합니다. 테스트 실패에 대해 알림이 다시 전송되는 것을 방지하려면 옵션을 Never renotify if the monitor has not been resolved
로 남겨둡니다.
생성을 클릭해 테스트 설정 및 모니터를 저장합니다.
자세한 정보는 신서틱(Synthetic) 테스트 모니터를 참조하세요.
API test creation suggests endpoints from the API Catalog and existing API tests to prefill your test form with relevant options. Use existing Datadog data sources such as APM traces, API Catalog endpoints discovery, and existing similar Synthetic tests created by users.
Start typing in the API test URL input to get endpoint suggestions or similar tests in Synthetic Monitoring:
Then, select a suggestion to prefill your test configuration (request options and headers, authentication, and variables):
To create a local variable, click Create a Local Variable. You can select one of the following available builtins to add to your variable string:
n
digits.n
letters.n
characters.n
units.n
units.To obfuscate local variable values in test results, select Hide and obfuscate variable value. Once you have defined the variable string, click Add Variable.
You can use the global variables defined on the Settings page in the URL, advanced options, and assertions of your HTTP tests.
To display your list of variables, type {{
in your desired field:
A test is considered FAILED
if it does not satisfy one or more assertions or if the request prematurely failed. In some cases, the test can fail without testing the assertions against the endpoint.
The most common errors include the following:
AUTHENTICATION_ERROR
CONNREFUSED
CONNRESET
DNS
Error performing HTTP/2 request
INVALID_REQUEST
SSL
TIMEOUT
TIMEOUT
can happen:TIMEOUT: The request couldn't be completed in a reasonable time.
indicates that the request duration hit the test defined timeout (default is set to 60s).
For each request only the completed stages for the request are displayed in the network waterfall. For example, in the case of Total response time
only being displayed, the timeout occurred during the DNS resolution.TIMEOUT: Overall test execution couldn't be completed in a reasonable time.
indicates that the test duration (request + assertions) hits the maximum duration (60.5s).MALFORMED_RESPONSE
By default, only users with the Datadog Admin and Datadog Standard roles can create, edit, and delete Synthetic HTTP tests. To get create, edit, and delete access to Synthetic HTTP tests, upgrade your user to one of those two default roles.
If you are using the custom role feature, add your user to any custom role that includes synthetics_read
and synthetics_write
permissions.
Access restriction is available for customers using custom roles on their accounts.
You can restrict access to an HTTP test based on the roles in your organization. When creating an HTTP test, choose which roles (in addition to your user) can read and write your test.