ICMP Tests

ICMP Tests

Overview

ICMP tests allow you to easily monitor the availability of your hosts and diagnose network communication issues. By asserting on the values received from one or more ICMP pings to your endpoint, Datadog can help detect connectivity issues, above-quota latency for round trip times, and unexpected changes in security firewall configuration. The tests can also track the number of network hops (TTL) required to connect to your host and view traceroute results to discover details on each network hop along the path.

ICMP tests can run from managed and private locations depending on whether you want to trigger ICMP pings to your endpoints from outside or inside your network. You can run ICMP tests on a defined schedule, on demand or from within your CI/CD pipelines.

Configuration

After choosing the type of test you want to create (HTTP, SSL, TCP, DNS, or ICMP test), you can define your test’s request.

Define Request

  1. Specify the Domain Name or IP address to run your test on.
  2. Select or Deselect Track number of network hops (TTL). This option turns on a “traceroute” probe to discover all gateways along the path to the host destination.
  3. Select the Number of Pings to trigger per test session. By default, the number of pings is set to 4 - you can choose to decrease or increase up to 10.
  4. Name your ICMP test.
  5. Add env Tags as well as any other tag to your ICMP test. You can then use these tags to quickly filter through your Synthetic tests on the Synthetic Monitoring homepage.
  6. Select the Locations to run your ICMP test from: ICMP tests can run from managed and private locations depending on whether you want to trigger the ICMP pings from outside or inside your network.

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

Specify test frequency

ICMP tests can run:

  • On a schedule to ensure your most important services are always accessible to your users. Select the frequency you want Datadog to run your ICMP test.

Define assertions

Assertions define what an expected test result is. When hitting Test URL basic assertions on latency, packet loss and packet received is added. You must define at least one assertion for your test to monitor.

TypeAggregationOperatorValue Type
latencyavg, max, min or stddev (aka jitter)is less than, is less than or equal,
is, is more than, is more than or equal
integer (ms)
packet loss-is less than, is less than or equal, is, is more than, is more than or equalpercentage (%)
packet received-is less than, is less than or equal, is, is more than, is more than or equalinteger
network hops-is less than, is less than or equal, is, is more than, is more than or equalinteger

You can create up to 10 assertions per API test by selecting New Assertion or by selecting the response preview directly:

Define alert conditions

You can set alert conditions to determine the circumstances when a test should fail and trigger an alert.

Alerting rule

When you set the alert conditions to: An alert is triggered if any assertion 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 in case of failed test result. By default, the retries are performed 300 milliseconds after the first failed test result. This interval can be configured via the API.

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 monitors, select users and/or services that should receive notifications either by adding an @notification to 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 alert.
    {{^is_recovery}}Show unless the test recovers from alert.
  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.

Email notifications include the message defined in this section as well as a summary of failed assertions. Notifications example:

Click Save to save your test and have Datadog start executing it.

Variables

Create local variables

You can create local variables by defining their values from one of the below available built-ins:

PatternDescription
{{ 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 and the locally defined variables in the URL and assertions of your ICMP 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 several assertions or if the request prematurely failed. In some cases, the test can fail without being able to test the assertions against the endpoint, these reasons include:

ErrorDescription
DNSDNS entry not found for the test URL. Possible causes include misconfigured test URL, wrong configuration of your DNS entries, etc.

Further Reading