aboutsummaryrefslogtreecommitdiff
path: root/config.example.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'config.example.yaml')
-rw-r--r--config.example.yaml57
1 files changed, 44 insertions, 13 deletions
diff --git a/config.example.yaml b/config.example.yaml
index b9d4ae1..93236df 100644
--- a/config.example.yaml
+++ b/config.example.yaml
@@ -63,6 +63,7 @@ groups:
# show_group_uptime: true # Show aggregate uptime percentage (true by default)
# Group-level defaults (optional - apply to all monitors in this group unless overridden)
# defaults:
+ # # Common options
# interval: 30s
# timeout: 10s
# retries: 2
@@ -73,11 +74,25 @@ groups:
# round_uptime: false
# disable_ping_tooltips: false
# disable_uptime_tooltip: false
+ # # HTTP/HTTPS options
# method: GET
# user_agent: "Custom-Agent/1.0"
# expected_status: 200
+ # expected_content: "ok"
+ # body: '{"ping": true}'
# headers:
# Authorization: "Bearer token"
+ # # ICMP options
+ # ping_count: 4
+ # # DNS options
+ # dns_server: "8.8.8.8:53"
+ # record_type: A
+ # # GraphQL options
+ # graphql_query: "query { health }"
+ # graphql_variables:
+ # key: "value"
+ # # Database options
+ # db_type: postgres
monitors:
- name: "Website"
type: https
@@ -224,22 +239,38 @@ incidents:
# ================================
#
# Group-level defaults (optional):
+# All monitor options (except name, type, target, link, reset_on_next_check,
+# expected_ips, expected_cname) can be set as group defaults.
+# Individual monitors can override any default.
# defaults:
-# interval: duration - Default check interval for all monitors in group
-# timeout: duration - Default timeout for all monitors in group
-# retries: int - Default retry attempts for all monitors in group
-# verify_ssl: bool - Default SSL verification for all monitors in group
-# hide_ssl_days: bool - Hide SSL certificate days left (default: false)
-# hide_ping: bool - Hide response time from display (default: false)
-# round_response_time: bool - Round response time to nearest second (default: false)
-# round_uptime: bool - Round uptime percentage (default: false)
-# disable_ping_tooltips: bool - Disable hover tooltips on ping bars (default: false)
-# disable_uptime_tooltip: bool - Disable uptime tooltip with last failure info (default: false)
-# method: string - HTTP method for HTTP/HTTPS monitors (default: GET)
+# # Common options
+# interval: duration - Default check interval
+# timeout: duration - Default timeout
+# retries: int - Default retry attempts
+# verify_ssl: bool - Default SSL verification
+# hide_ssl_days: bool - Hide SSL certificate days left
+# hide_ping: bool - Hide response time from display
+# round_response_time: bool - Round response time to nearest second
+# round_uptime: bool - Round uptime percentage
+# disable_ping_tooltips: bool - Disable hover tooltips on ping bars
+# disable_uptime_tooltip: bool - Disable uptime tooltip with last failure info
+# # HTTP/HTTPS options
+# method: string - HTTP method (default: GET)
# user_agent: string - Custom User-Agent header
-# expected_status: int - Expected HTTP status code (default: 200)
+# expected_status: int - Expected HTTP status code
+# expected_content: string - Expected text in response body
+# body: string - Request body for POST/PUT/PATCH
# headers: map[string]string - Custom headers to send
-# Note: Individual monitors can override these defaults
+# # ICMP options
+# ping_count: int - Number of ICMP packets to send
+# # DNS options
+# dns_server: string - DNS server to query
+# record_type: string - DNS record type (A, AAAA, CNAME, MX, TXT)
+# # GraphQL options
+# graphql_query: string - GraphQL query to execute
+# graphql_variables: map - GraphQL query variables
+# # Database options
+# db_type: string - Database type (postgres, mysql, redis, memcached, mongodb)
#
# Common fields for all monitor types:
# name: string (required) - Display name for the monitor