# Synthetic monitoring with Checkly

Copy as Markdown[Open in ChatGPT](https://chatgpt.com/?q=Read%20https%3A%2F%2Fcoralogix.com%2Fdocs%2Fuser-guides%2Fmonitoring-and-insights%2Fsynthetic-monitoring%2Fsynthetic-monitoring-with-checkly.md%20and%20help%20me%20with%20my%20question%20about%20this%20Coralogix%20documentation%20page.)[Open in Claude](https://claude.ai/new?q=Read%20https%3A%2F%2Fcoralogix.com%2Fdocs%2Fuser-guides%2Fmonitoring-and-insights%2Fsynthetic-monitoring%2Fsynthetic-monitoring-with-checkly.md%20and%20help%20me%20with%20my%20question%20about%20this%20Coralogix%20documentation%20page.)

This tutorial demonstrates how to add synthetic capabilities to your Coralogix dashboard with [Checkly](https://www.checklyhq.com/), allowing you to view and query the results of your Checkly synthetic testing.

## Prerequisites[​](#prerequisites "Direct link to Prerequisites")

* Checkly [account](https://www.checklyhq.com/sign-up/)

## Setup[​](#setup "Direct link to Setup")

In your Checkly account, create [API](https://www.checklyhq.com/docs/api-checks) and / or [browser checks](https://www.checklyhq.com/docs/browser-checks) in your dashboard.

[![Synthetic Monitoring Checkly Coralogix](/docs/assets/images/Screen-Shot-2023-04-05-at-3.11.38-PM-1024x513-a264f27d9f9bdb07e58b4b37b9419b5a.webp)](https://coralogix.com/docs/docs/assets/images/Screen-Shot-2023-04-05-at-3.11.38-PM-1024x513-a264f27d9f9bdb07e58b4b37b9419b5a.webp)

## Configuration[​](#configuration "Direct link to Configuration")

1

<!-- -->

.

To integrate with Coralogix, define a webhook. In your Checkly navigation pane, select **Alerts** and define a new channel using the Coralogix [Rest API `/singles`](https://coralogix.com/docs/docs/developer-portal/apis/log-ingestion/coralogix-rest-api-singles/.md) using the endpoint associated with your Coralogix [domain](https://coralogix.com/docs/docs/user-guides/account-management/account-settings/coralogix-domain/.md).

[![Synthetic Monitoring Checkly Coralogix](/docs/assets/images/Screen-Shot-2023-04-05-at-3.16.47-PM-1024x581-75301672e6336ba65702c7ae8cc95c59.webp)](https://coralogix.com/docs/docs/assets/images/Screen-Shot-2023-04-05-at-3.16.47-PM-1024x581-75301672e6336ba65702c7ae8cc95c59.webp)

The example above consists of the following JSON body. Note the importance of inputting [application and subsystem names](https://coralogix.com/docs/docs/user-guides/account-management/account-settings/application-and-subsystem-names/.md).

```
{ 

  "applicationName": "synthetics",

  "subsystemName": "{{ CHECK_NAME }}",

  "computerName": "{{ CHECK_TYPE }}",

  "severity": 3,

  "text":"{\"message\":\"{{ ALERT_TITLE }}\",\"check_result_id\":\"{{CHECK_RESULT_ID}}\",\"check_id\":\"{{CHECK_ID}}\",\"check_name\":\"{{CHECK_NAME}}\",\"check_type\":\"{{CHECK_TYPE}}\",\"alert_type\":\"{{ALERT_TYPE}}\",\"response_time\":\"{{RESPONSE_TIME}}\",\"response_code\":\"{{API_CHECK_RESPONSE_STATUS_CODE}}\",\"response_text\":\"{{API_CHECK_RESPONSE_STATUS_TEXT}}\",\"run_location\":\"{{RUN_LOCATION}}\",\"result_link\":\"{{RESULT_LINK}}\",\"started_at\":\"{{STARTED_AT}}\",\"group_name\":\"{{GROUP_NAME}}\"}",

  "category": "synthetic-test",

  "className": "{{ CHECK_NAME }}"

}
```

2

<!-- -->

.

Connect your webhook to your checks by adding the webhook as an alert channel for each.

[![Synthetic Monitoring Checkly Coralogix](/docs/assets/images/Screen-Shot-2023-04-05-at-3.58.41-PM-1024x584-71b8cb8b33f3bb77d10224e27dc7fbcd.webp)](https://coralogix.com/docs/docs/assets/images/Screen-Shot-2023-04-05-at-3.58.41-PM-1024x584-71b8cb8b33f3bb77d10224e27dc7fbcd.webp)

## Terraform[​](#terraform "Direct link to Terraform")

You have the option of deploying your Coralogix-Checkly integration as a code using Terraform. Follow these steps:

1

<!-- -->

.

[Set up](https://www.checklyhq.com/docs/terraform-provider/) your Terraform Checkly provider.

2

<!-- -->

.

Create the following terraform resource to deploy a Coralogix webhook within Checkly.

```
# A Coralogix alert channel webhook for Checkly



resource "checkly_alert_channel" "coralogix_ac" {

  webhook {

    name         = "coralogix_alert_channel"

    method       = "post"

    template     = <<EOT

{ 

  "applicationName": "synthetics",

  "subsystemName": "{{ CHECK_NAME }}",

  "computerName": "{{ CHECK_TYPE }}",

  "severity": 3,

  "text":"{\"message\":\"{{ ALERT_TITLE }}\",\"check_result_id\":\"{{CHECK_RESULT_ID}}\",\"check_id\":\"{{CHECK_ID}}\",\"check_name\":\"{{CHECK_NAME}}\",\"check_type\":\"{{CHECK_TYPE}}\",\"alert_type\":\"{{ALERT_TYPE}}\",\"response_time\":\"{{RESPONSE_TIME}}\",\"response_code\":\"{{API_CHECK_RESPONSE_STATUS_CODE}}\",\"response_text\":\"{{API_CHECK_RESPONSE_STATUS_TEXT}}\",\"run_location\":\"{{RUN_LOCATION}}\",\"result_link\":\"{{RESULT_LINK}}\",\"started_at\":\"{{STARTED_AT}}\",\"group_name\":\"{{GROUP_NAME}}\"}",

  "category": "synthetic-test",

  "className": "{{ CHECK_NAME }}"

},

    EOT

    url          = "<cx_rest_api_singles>"

  }

}



# A Checkly check to do a test on api.spacexdata.com. And connecting this check to the above Coralogix

# alert channel. 



resource "checkly_check" "spacexdata_check" {

  name                      = "SpacexData V2 Check"

  type                      = "API"

  activated                 = true

  should_fail               = false

  frequency                 = 1

  double_check              = true

  use_global_alert_settings = true



  locations = [

    "us-west-1"

  ]



  request {

    url              = "<https://api.spacexdata.com/v2>"

    follow_redirects = true

    skip_ssl         = false

    assertion {

      source     = "STATUS_CODE"

      comparison = "EQUALS"

      target     = "200"

    }

  }



  alert_channel_subscription {

    channel_id = checkly_alert_channel.coralogix_ac.id

    activated  = true

  }

}
```

**Notes**:

* **`cx_rest_api_singles`**: Input the **Coralogix Logs** **[endpoint](https://coralogix.com/docs/docs/integrations/coralogix-endpoints/.md)** associated with your Coralogix **[domain](https://coralogix.com/docs/docs/developer-portal/apis/log-ingestion/coralogix-rest-api-singles/.md)**.
* The example terraform script above acreates a new Checkly check entitled "SpacexData V2 Check". It then associates the Coralogix alert channel to that check as well.

3

<!-- -->

.

Once applied, view the Coralogix alert channel created within your Checkly account. Apply the above to view the Coralogix alert channel created within Checkly.

## Validation[​](#validation "Direct link to Validation")

Depending on the frequency with which your checks are being executed and are changing states, you should be able to view the checks in your Coralogix dashboard.

**Notes**:

* Checkly only invokes a webhook when the state of a check changes, either from pass to fail or fail to pass.

* A webhook will not be invoked for every browser check, meaning that you will not receive a message within your Coralogix dashboard for every check.

### Check[​](#check "Direct link to Check")

A check in your Coralogix dashboard should appear as follows:

```
/**

  * To learn more about Playwright Test visit:

  * <https://www.checklyhq.com/docs/browser-checks/playwright-test/>

  * <https://playwright.dev/docs/writing-tests>

  */



const { expect, test } = require('@playwright/test')



// Set the action timeout to 10 seconds to quickly identify failing actions.

// By default Playwright Test has no timeout for actions (e.g. clicking an element).

// Learn more here: <https://www.checklyhq.com/docs/browser-checks/timeouts/>

test.use({ actionTimeout: 10000 })



test('wait for an element to become visible', async ({ page }) => {

  // Change checklyhq.com to your site's URL,

  // or, even better, define a ENVIRONMENT_URL environment variable

  // to reuse it across your browser checks

  await page.goto(process.env.ENVIRONMENT_URL || 



  // Locate the headline and check if it's visible

  // Learn more about all locator functions in the Playwright docs

  // <https://playwright.dev/docs/api/class-locator>

  // const mainHeadline = page.locator('title')

  await expect(page.getByText('Full-Stack Observability')).toBeVisible();



  // Take a screenshot of the current page

  await page.screenshot({ path: 'screenshot.jpg' })

})
```

### Test[​](#test "Direct link to Test")

A multi-step synthetic test, which logs in to a website, should appear as follows:

```
/**

 * To learn more about Playwright Test visit:

 * <https://www.checklyhq.com/docs/browser-checks/playwright-test/>

 * <https://playwright.dev/docs/writing-tests>

 */

const { expect, test, selectors } = require("@playwright/test")



// Set the action timeout to 10 seconds to quickly identify failing actions.

// By default Playwright Test has no timeout for actions (e.g. clicking an element).

// Learn more here: <https://www.checklyhq.com/docs/browser-checks/timeouts/>

test.use({ actionTimeout: 10000 })



test("Login into Github", async ({ page }) => {

  // Go to login page

  page.goto('<https://www.saucedemo.com>')

  

  // Fill in credentials

  await page.getByPlaceholder('Username').type('standard_user')

  await page.getByPlaceholder('Password').type('secret_sauce')

  await page.click('input[value="Login"]')



  // Verify successful login

  // await selectors.setTestIdAttribute("  c sccsßtitle")

  // await expect(page.getByTestId("Products"))

  await expect(page.locator('.title')).toBeVisible();

  // await page.click('input[value="add-to-cart-sauce-labs-backpack"]')

})
```

If you simulate the test to change its state, the message should appear in your Coralogix dashboard as follows:

[![Synthetic Monitoring Checkly Coralogix](/docs/assets/images/Screen-Shot-2023-04-05-at-4.02.09-PM-1024x578-66b98862941297e1792112687cdb58a9.webp)](https://coralogix.com/docs/docs/assets/images/Screen-Shot-2023-04-05-at-4.02.09-PM-1024x578-66b98862941297e1792112687cdb58a9.webp)

## Coralogix dashboard[​](#coralogix-dashboard "Direct link to Coralogix dashboard")

### Custom dashboard[​](#custom-dashboard "Direct link to Custom dashboard")

Below is a sample [custom dashboard](https://coralogix.com/docs/docs/user-guides/custom-dashboards/introduction/.md) built with synthetic test data. Filter the view using your synthetic test.

[![Synthetic Monitoring Checkly Coralogix](/docs/assets/images/custom-dash-c3e1e03f2eb4094da8088360c97ad690.webp)](https://coralogix.com/docs/docs/assets/images/custom-dash-c3e1e03f2eb4094da8088360c97ad690.webp)

### Coralogix actions[​](#coralogix-actions "Direct link to Coralogix actions")

Define a [Coralogix custom action](https://coralogix.com/docs/docs/user-guides/data_exploration/custom_actions/.md), allowing you to navigate from the synthetic test message in your Coralogix dashboard to the status of that specific test within your Checkly account.

[![Synthetic Monitoring Checkly Coralogix](/docs/assets/images/Screen-Shot-2023-04-05-at-4.05.24-PM-1024x581-e2103c713bc64c4e697b4b58bbb8b546.webp)](https://coralogix.com/docs/docs/assets/images/Screen-Shot-2023-04-05-at-4.05.24-PM-1024x581-e2103c713bc64c4e697b4b58bbb8b546.webp)