Synthetic Monitoring Settings

Synthetic Monitoring Settings

On the Synthetic Monitoring Settings page, you can adjust the following settings:

Global variables

Global variables can be used in single and multistep API tests as well as browser tests of your test suite. To create a global variable, go to the Global Variables tab in the Settings page, and click New Global Variable on the upper right corner.

Choose the type of variable you want to create:

  1. Enter a Variable Name. Your variable name can only use uppercase letters, numbers, and underscores.
  2. Enter a Description for your variable (optional).
  3. Select Tags to associate with your variable (optional).
  4. Enter the Value you want to assign to your variable.
  5. Enable obfuscation of your variable to hide its value on test results (optional).

You can create variables from your existing HTTP tests by parsing their associated response headers and body:

  1. Enter a Variable Name. Your variable name can only use uppercase letters, numbers, and underscores.
  2. Enter a Description for your variable (optional).
  3. Select Tags to associate with your variable (optional).
  4. Pick the HTTP test you want to extract your variable from.
  5. Enable obfuscation of your variable to hide its value on test results (optional).
  6. Decide whether to extract your variable from the response headers or from the response body.
    • Extract the value from Response Header: use the full response header for your variable or parse it with a regex.
    • Extract the value from Response Body: parse the response body of the request with a jsonpath, a regex, or use the full response body.

Note: Variable values are updated whenever the test they are extracted from runs.

Permissions

By default, only users with the Datadog Admin and Datadog Standard roles can access the Synthetic Monitoring Global Variables page. You can get access to the Global Variables page by having your user upgraded to one of these two default roles.

If you have access to the custom role feature, add your user to a custom role that includes synthetics_global_variable_read and synthetics_global_variable_write permissions for global variables.

Restrict access

RBAC restrict access to global variables is in beta. To request access, contact Datadog support.

You can restrict access to a global variable based on the roles in your organization. When creating a global variable, choose which roles (in addition to your user) can read and write your global variable in Permissions settings.

Default settings

Default locations

Choose the default locations for your API test, multistep API test , or browser test details. Options include all of the available managed locations Datadog offers and the private locations you set up for your account.

APM integration for browser tests

Allow URLs to add APM integration headers to that URL. Datadog’s APM integration headers allow Datadog to link browser tests with APM.

Define which endpoints should be sent the APM headers by adding a URL into this section.

Use * to allow wider domain names. For example, adding https://*.datadoghq.com/* allows everything on https://datadoghq.com/.

If the endpoint is being traced and allowed, your browser test results are automatically tied to its corresponding trace.

Permissions

By default, only users with the Datadog Admin and Datadog Standard roles can access the Synthetic Monitoring Default Settings page. To get access to the Default Settings page, upgrade your user to one of these two default roles.

If you have access to the custom role feature, add your user to a custom role that includes synthetics_default_settings_read and synthetics_default_settings_write permissions for default settings.

Further Reading