[U-3684] Update playwright docs and add an example (#125)

BetterStackHQ · Nov 22, 2024 · 3fbe5d4 · 3fbe5d4
1 parent d658bb4
commit 3fbe5d4
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 3 deletions.
diff --git a/docs/data-sources/betteruptime_monitor.md b/docs/data-sources/betteruptime_monitor.md
@@ -87,7 +87,7 @@ Monitor lookup.
 - **remember_cookies** (Boolean) Set to true to keep cookies when redirecting.
 - **request_body** (String) Request body for POST, PUT, PATCH requests. Required if monitor_type is set to dns (domain to query the DNS server with).
 - **request_headers** (List of Map of String) An array of request headers, consisting of name and value pairs
-- **request_timeout** (Number) How long to wait before timing out the request? In seconds.
+- **request_timeout** (Number) How long to wait before timing out the request? In seconds. When `monitor_type` is set to `playwright`, this determines the Playwright scenario timeout.
 - **required_keyword** (String) Required if monitor_type is set to keyword  or udp. We will create a new incident if this keyword is missing on your page.
 - **scenario_name** (String) For Playwright monitors, the scenario name identifying the monitor in the UI.
 - **sms** (Boolean) Should we send an SMS to the on-call person?

diff --git a/docs/resources/betteruptime_monitor.md b/docs/resources/betteruptime_monitor.md
@@ -83,7 +83,7 @@ https://betterstack.com/docs/uptime/api/monitors/
 - **remember_cookies** (Boolean) Set to true to keep cookies when redirecting.
 - **request_body** (String) Request body for POST, PUT, PATCH requests. Required if monitor_type is set to dns (domain to query the DNS server with).
 - **request_headers** (List of Map of String) An array of request headers, consisting of name and value pairs
-- **request_timeout** (Number) How long to wait before timing out the request? In seconds.
+- **request_timeout** (Number) How long to wait before timing out the request? In seconds. When `monitor_type` is set to `playwright`, this determines the Playwright scenario timeout.
 - **required_keyword** (String) Required if monitor_type is set to keyword  or udp. We will create a new incident if this keyword is missing on your page.
 - **scenario_name** (String) For Playwright monitors, the scenario name identifying the monitor in the UI.
 - **sms** (Boolean) Should we send an SMS to the on-call person?

diff --git a/examples/advanced/main.tf b/examples/advanced/main.tf
@@ -52,6 +52,21 @@ resource "betteruptime_monitor" "dns" {
   monitor_group_id = betteruptime_monitor_group.this.id
 }
 
+resource "betteruptime_monitor" "playwright" {
+  url               = "Better Stack Homepage"
+  monitor_type      = "playwright"
+  monitor_group_id  = betteruptime_monitor_group.this.id
+  playwright_script = <<-EOT
+    const { test, expect } = require('@playwright/test');
+
+    test('has title', async ({ page }) => {
+      await page.goto('https://betterstack.com/')
+      await expect(page).toHaveTitle(/Better Stack/)
+    });
+  EOT
+  request_timeout   = 60
+}
+
 resource "betteruptime_status_page_resource" "monitor_status" {
   status_page_id         = betteruptime_status_page.this.id
   status_page_section_id = betteruptime_status_page_section.monitors.id

diff --git a/internal/provider/resource_monitor.go b/internal/provider/resource_monitor.go
@@ -239,7 +239,7 @@ var monitorSchema = map[string]*schema.Schema{
 		// TODO: ValidateDiagFunc: validation.StringInSlice
 	},
 	"request_timeout": {
-		Description: "How long to wait before timing out the request? In seconds.",
+		Description: "How long to wait before timing out the request? In seconds. When `monitor_type` is set to `playwright`, this determines the Playwright scenario timeout.",
 		Type:        schema.TypeInt,
 		Optional:    true,
 		Computed:    true,