Synthetic Monitoring Settings

Synthetic Monitoring Settings

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

Global variables

Global variables are variables that are accessible from all your Synthetic tests. They can be used in all 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).
    Global Variable Specify Value

    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 regex, a jsonpath, an xpath, or use the full response body.
    Variable from HTTP Test

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

    To generate and use a TOTP in your tests, create a global variable where you enter a secret key or upload a QR code from your authentication provider.

    1. In Choose variable type, select MFA Token.
    2. In Define Variable, enter a Variable Name. Your variable name can only use uppercase letters, numbers, and underscores.
    3. Enter a Description for your variable (optional).
    4. Select Tags to associate with your variable (optional).
    5. Enter the Secret Key to your variable or upload a QR code image.
    6. Click + Generate to create an OTP. You can copy the generated OTP with the Copy icon.
    Create a MFA token

    Note: For more information about TOTP-based MFA in a browser test, see the TOTP guide.

    Once created, global variables can be used in all Synthetic tests by typing {{ in the field of interest and selecting your global variable. For more information, see the HTTP test, Multistep API test, Browser test configuration, and Steps documentation.

    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 those two default roles.

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

    Restrict access

    Access restriction is available for customers with custom roles enabled on their account.

    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.

    Restrict access to a global variable

    Default settings

    Default locations

    Choose the default locations for your API test, multistep API test, or browser test details.

    Your 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 is allowed, your browser test results are automatically tied to its corresponding trace.

    Tag enforcement

    Tag enforcement is an advanced feature included in the Enterprise plan. For all other plans, contact your account representative or success@datadoghq.com to request this feature.

    Allows you to enforce selected tags on Synthetics tests. You can break down cost and usage by services, applications, or teams.

    To enable tag enforcement, click Enforce tags for usage attributions on all tests.

    Enforce tags for usage attributions on all tests

    For more information, see Usage Attribution.

    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 those two default roles.

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

    Further Reading

    Additional helpful documentation, links, and articles:

    Introducing Datadog Synthetic MonitoringBLOG more more Configure an API TestDOCUMENTATION more more Configure a Browser TestDOCUMENTATION more more Identify Synthetic BotsDOCUMENTATION more more TOTPs For Multi-Factor Authentication (MFA) in Browser TestDOCUMENTATION more more