Merge pull request #206 from tosuke/docs-query-monitor

Add docs for monitors with a query

Author: azukiazusa1

docs/data-sources/monitor.md

@@ -68,6 +68,12 @@ data "mackerel_monitor" "this" {
   * `operator` - The comparison operator to determines the conditions that state whether the designated variable is either big or small. The observed value is on the left of the operator and the designated value is on the right.
   * `warning` - The threshold that generates a warning alert.
   * `critical` - The threshold that generates a critical alert.
+* `query` - The settings for the monitor of query monitoring.
+  * `query` - The PromQL-style query.
+  * `legend` - The query legend.
+  * `operator` - The comparison operator to determines the conditions that state whether the designated variable is either big or small. The observed value is on the left of the operator and the designated value is on the right.
+  * `warning` - The threshold that generates a warning alert.
+  * `critical` - The threshold that generates a critical alert.
 * `anomaly_detection` - The settings for the monitor of  Anomaly Detection for roles.
   * `scopes` - Expression of the monitoring target. Only valid for graph sequences that become one line.
   * `warning_sensitivity` - The sensitivity to generates warning alerts.

docs/resources/monitor.md

@@ -93,6 +93,22 @@ resource "mackerel_monitor" "role_avg" {
 }
 ```
 
+### query
+
+```terraform
+resource "mackerel_monitor" "httpbin_load" {
+  name = "httpbin load per node"
+
+  query {
+    query = "sum by (k8s.node.name) (container.cpu.utilization{k8s.deployment.name=\"httpbin\"})"
+    legend = "cpu.utilization {{k8s.node.name}}"
+    operator = ">"
+    warning = "0.7"
+    critical = "0.9"
+  }
+}
+```
+
 ### anomaly_detection
 
 ```terraform
@@ -170,6 +186,14 @@ The following arguments are required:
 * `warning` - (Required, at least one of `warning` or `critical`) The threshold that generates a warning alert.
 * `critical` - (Required, at least one of `warning` or `critical`) The threshold that generates a critical alert.
 
+### query
+
+* `query` - (Required) The PromQL-style query.
+* `legend` - The query legend.
+* `operator` - (Required) The comparison operator to determines the conditions that state whether the designated variable is either big or small. The observed value is on the left of the operator and the designated value is on the right. Valid values are `>` and `<`.
+* `warning` - (Required, at least one of `warning` or `critical`) The threshold that generates a warning alert.
+* `critical` - (Required, at least one of `warning` or `critical`) The threshold that generates a critical alert.
+
 ### anomaly_detection
 
 * `scopes` - (Required) Expression of the monitoring target. Only valid for graph sequences that become one line.