HTTP Tests

Overview

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.

Configuration

After choosing to create an HTTP test, define your test’s request.

Define request

  1. 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.

  2. Enrich your HTTP request with Advanced Options (optional):

    • Follow redirects: Select to have your HTTP test follow up to ten redirects when performing the request.
    • Timeout: Specify the amount of time in seconds before the test times out.
    • Request headers: Define headers to add to your HTTP request. You can also override the default headers (for example, the user-agent header).
    • Cookies: Define cookies to add to your HTTP request. Set multiple cookies using the format <COOKIE_NAME1>=<COOKIE_VALUE1>; <COOKIE_NAME2>=<COOKIE_VALUE2>.
    • 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 AWS S3 are not implemented.


    You can optionally specify the domain and work station in the Additional configuration section.

    • Encode parameters: Add the name and value of query parameters that require encoding.
    • Body type: Select the type of the request body (text/plain, application/json, text/xml, text/html, application/x-www-form-urlencoded, or None) you want to add to your HTTP request.
    • Request body: Add the content of your HTTP request body. The request body is limited to a maximum size of 50 kilobytes.
    • Ignore server certificate error: Select to have your HTTP test go on with connection even if there are errors when validating the SSL certificate.

    • 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 you can 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
      
    • Proxy URL: Specify the URL of the proxy the HTTP request should go through (http://<YOUR_USER>:<YOUR_PWD>@<YOUR_IP>:<YOUR_PORT>).
    • Proxy header: Add headers to include in the HTTP request to the proxy.
    • Do not save response body: Select this option to prevent response body from being saved at runtime. This can be helpful to ensure no sensitive data gets featured in your test results. Use mindfully as it can make failures troubleshooting more difficult. For more security recommendations, see Synthetic Monitoring Security.

  1. Name your HTTP test.

  2. Add env Tags as well as any other tag to your HTTP test. You can then use these tags to quickly filter through your Synthetic tests on the Synthetic Monitoring homepage.

Define HTTP request

Click Test URL to try out the request configuration. A response preview is displayed on the right side of your screen.

Define assertions

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.

TypeOperatorValue type
bodycontains, does not contain, is, is not,
matches, does not match,
jsonpath, xpath
String
Regex
headercontains, does not contain, is, is not,
matches, does not match
String
Regex
response timeis less thanInteger (ms)
status codeis, 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:

Define assertions for your HTTP test to succeed or fail on

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 locations

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.

Specify test frequency

HTTP tests can run:

  • On a schedule to ensure your most important endpoints are always accessible to your users. Select the frequency at which you want Datadog to run your HTTP test.
  • Within your CI/CD pipelines to start shipping without fearing faulty code might impact your customers experience.
  • On-demand to run your tests whenever makes the most sense for your team.

Define alert conditions

Set alert conditions to determine the circumstances under which you want a test to fail and trigger an alert.

Alerting rule

When you set the alert conditions to: An alert is triggered if your test fails for X minutes from any n of N locations, an alert is triggered only if these two conditions are true:

  • At least one location was in failure (at least one assertion failed) during the last X minutes;
  • At one moment during the last X minutes, at least n locations were in failure.

Fast retry

Your test can trigger retries X times after Y ms in case of a failed test result. Customize the retry interval to suit your alerting sensibility.

Location uptime is computed on a per-evaluation basis (whether the last test result before evaluation was up or down). The total uptime is computed based on the configured alert conditions. Notifications sent are based on the total uptime.

Notify your team

A notification is sent by your test based on the alerting conditions previously defined. Use this section to define how and what message to send to your teams.

  1. Similar to how you configure monitors, select users and/or services that should receive notifications either by adding a @notificationto the message or by searching for team members and connected integrations with the drop-down box.

  2. Enter the notification message for your test. This field allows standard Markdown formatting and supports the following conditional variables:

    Conditional VariableDescription
    {{#is_alert}}Show when the test alerts.
    {{^is_alert}}Show unless the test alerts.
    {{#is_recovery}}Show when the test recovers from an alert.
    {{^is_recovery}}Show unless the test recovers from an alert.
    {{#is_renotify}}Show when the monitor renotifies.
    {{^is_renotify}}Show unless the monitor renotifies.
    {{#is_priority}}Show when the monitor matches priority (P1 to P5).
    {{^is_priority}}Show unless the monitor matches priority (P1 to P5).
  3. Specify how often you want your test to re-send the notification message in case of test failure. To prevent renotification on failing tests, leave the option as Never renotify if the monitor has not been resolved.

Click Save to save and start your test.

Variables

Create local variables

You can create local variables by clicking Create Local Variable at the top right hand corner of your test configuration form. You can define their values from one of the below available builtins:

{{ numeric(n) }}
Generates a numeric string with n digits.
{{ alphabetic(n) }}
Generates an alphabetic string with n letters.
{{ alphanumeric(n) }}
Generates an alphanumeric string with n characters.
{{ date(n, format) }}
Generates a date in one of our accepted formats with a value of the date the test is initiated + n days.
{{ timestamp(n, unit) }}
Generates a timestamp in one of our accepted units with a value of the timestamp the test is initiated at +/- n chosen unit.

Use variables

You can use the global variables defined in the Settings in the URL, advanced options, and assertions of your HTTP tests.

To display your list of variables, type {{ in your desired field:

Test failure

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.

These reasons include the following:

CONNREFUSED
No connection could be made because the target machine actively refused it.
CONNRESET
The connection was abruptly closed by the remote server. Possible causes include the web server encountering an error or crashing while responding, or loss of connectivity of the web server.
DNS
DNS entry not found for the test URL. Possible causes include misconfigured test URL or the wrong configuration of your DNS entries.
INVALID_REQUEST
The configuration of the test is invalid (for example, a typo in the URL).
SSL
The SSL connection couldn’t be performed. See the dedicated error page for more information.
TIMEOUT
The request couldn’t be completed in a reasonable time. Two types of 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
The remote server responded with a payload that does not comply with HTTP specifications.

Permissions

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.

Restrict access

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.

Set permissions for your test

Further Reading