Skip to content

fix(syntheticmonitoring): Update timeout documentation #2221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 19, 2025
Merged

fix(syntheticmonitoring): Update timeout documentation #2221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
591ecc5
fix(syntheticmonitoring): Update timeout documentation
Pokom Jun 18, 2025
c21959c
Update documentation
Pokom Jun 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/resources/synthetic_monitoring_check.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,7 +426,7 @@ resource "grafana_synthetic_monitoring_check" "traceroute" {
- `enabled` (Boolean) Whether to enable the check. Defaults to `true`.
- `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`.
- `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.
- `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`.
- `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`.

### Read-Only

Expand Down
2 changes: 1 addition & 1 deletion internal/resources/syntheticmonitoring/resource_check.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -747,7 +747,7 @@ multiple checks for a single endpoint to check different capabilities.
},
"timeout": {
Description: "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).",
"The minimum acceptable value is 1 second (1000 ms), and the maximum 180 seconds (180000 ms).",
Type: schema.TypeInt,
Optional: true,
Default: checkDefaultTimeout,
Expand Down