Skip to content

Commit aa5d1d6

Browse files
authored
fix(syntheticmonitoring): Update timeout documentation (#2221)
* fix(syntheticmonitoring): Update timeout documentation Set the timeout for checks to 180 seconds(180000ms) to align with the existing api. A potential improvement would be to also include a ValidateFunc that ensures the values are in between the documented minimum and maximum. * Update documentation
1 parent eb1b1c8 commit aa5d1d6

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/resources/synthetic_monitoring_check.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -426,7 +426,7 @@ resource "grafana_synthetic_monitoring_check" "traceroute" {
426426
- `enabled` (Boolean) Whether to enable the check. Defaults to `true`.
427427
- `frequency` (Number) How often the check runs in milliseconds (the value is not truly a "frequency" but a "period"). The minimum acceptable value is 1 second (1000 ms), and the maximum is 1 hour (3600000 ms). Defaults to `60000`.
428428
- `labels` (Map of String) Custom labels to be included with collected metrics and logs. The maximum number of labels that can be specified per check is 5. These are applied, along with the probe-specific labels, to the outgoing metrics. The names and values of the labels cannot be empty, and the maximum length is 32 bytes.
429-
- `timeout` (Number) Specifies the maximum running time for the check in milliseconds. The minimum acceptable value is 1 second (1000 ms), and the maximum 10 seconds (10000 ms). Defaults to `3000`.
429+
- `timeout` (Number) Specifies the maximum running time for the check in milliseconds. The minimum acceptable value is 1 second (1000 ms), and the maximum 180 seconds (180000 ms). Defaults to `3000`.
430430

431431
### Read-Only
432432

internal/resources/syntheticmonitoring/resource_check.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -747,7 +747,7 @@ multiple checks for a single endpoint to check different capabilities.
747747
},
748748
"timeout": {
749749
Description: "Specifies the maximum running time for the check in milliseconds. " +
750-
"The minimum acceptable value is 1 second (1000 ms), and the maximum 10 seconds (10000 ms).",
750+
"The minimum acceptable value is 1 second (1000 ms), and the maximum 180 seconds (180000 ms).",
751751
Type: schema.TypeInt,
752752
Optional: true,
753753
Default: checkDefaultTimeout,

0 commit comments

Comments
 (0)