update-monitor-example (#253)

thecraftman · tothmano · web-flow · commit 5a92b0c932f4 · 2025-03-24T17:06:55.000+01:00
Co-authored-by: Mano Toth &lt;tothmano@gmail.com&gt;
diff --git a/apps/terraform.mdx b/apps/terraform.mdx
@@ -106,13 +106,33 @@ To create a monitor in Axiom using the provider, add the following code to your
 ```hcl
 resource "axiom_monitor" "test_monitor" {
   depends_on       = [axiom_dataset.test_dataset, axiom_notifier.test_slack_notifier]
+
+  # `type` can be one of the following:
+  # - "Threshold": For numeric values against thresholds. It requires `operator` and `threshold`.
+  # - "MatchEvent": For detecting specific events. It doesn’t require `operator` and `threshold`.
+  # - "AnomalyDetection": For detecting anomalies. It requires `compare_days` and `tolerance, operator`.
+
+  type             = "Threshold"
+
   name             = "test_monitor"
   description      = "This is a test monitor created by Terraform."
   apl_query        = "['test_dataset'] | summarize count() by bin_auto(_time)"
   interval_minutes = 5
+  
+  # `operator` is required for threshold and anomaly detection monitors.
+  # Valid values are "Above", "AboveOrEqual", "Below", "BelowOrEqual".
   operator         = "Above"
+
   range_minutes    = 5
+
+  # `threshold` is required for threshold monitors
   threshold        = 1
+
+  # `compare_days` and `tolerance` are required for anomaly detection monitors.
+  # Uncomment the two lines below for anomaly detection monitors.
+  # compare_days     = 7
+  # tolerance        = 25
+  
   notifier_ids = [
     axiom_notifier.test_slack_notifier.id
   ]
