-
Notifications
You must be signed in to change notification settings - Fork 67
/
monika.example.yml
201 lines (196 loc) · 6.2 KB
/
monika.example.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
# Monika runs on configurations, therefor it needs a configuration file to run
# For complete documentation on configuration check https://monika.hyperjump.tech/guides/probes
# Monika can run by its minimal configuration such as :
probes:
- id: '1'
name: GitHub
description: Multiple
requests:
- url: https://github.com
timeout: 7000
- url: https://github.com/hyperjump
timeout: 7000
# Configuration example for sending HTML Form Submission
# Using this configuration Monika will send a POST request to http://www.foo.com/login.php
# with the defined headers and request's body.
# probes:
# - id: '1'
# name: HTML form submission
# description: simulate html form submission
# interval: 10
# requests:
# - url: http://www.foo.com/login.php
# method: POST
# timeout: 7000
# headers:
# Content-Type: application/x-www-form-urlencoded
# body:
# username: someusername
# password: somepassword
# Example for sending a ping instead of a REST request.
# - id: 'ping_test'
# name: ping_test
# description: requesting icmp ping
# interval: 10
# ping:
# - uri: http://google.com
# Configuration example for sending Multiple requests
# Requests could be define in array to run for multiple requests
# and with this configuration monika will check on github.com first and then https://github.com/hyperjumptech.
# If the status code of github.com is 500, monika will not check https://github.com/hyperjumptech.
# Alerts could also be define in array to check on multiple response conditions
# probes:
# - id: "1"
# name: Probing Github
# description: Multiple
# interval: 10
# requests:
# - url: https://github.com/
# method: GET
# timeout: 7000
# saveBody: false
# - url: https://github.com/hyperjumptech
# method: GET
# timeout: 7000
# saveBody: true
# # You can use pipe (|) to set multiline strings in YAML if you want to send plain text or XML content
# - url: https://example.com/plain-text
# method: POST
# headers:
# Content-Type: text/plain
# body: |
# name=John
# password=secret
# - url: https://example.com/xml
# method: POST
# headers:
# Content-Type: application/xml
# body: |
# <user>
# <name>John</name>
# <password>secret</password>
# </user>
# - url: https://expired.badssl.com
# method: GET
# timeout: 7000
# allowUnauthorized: true
# # allowUnauthorized will make the https agent to not check certificate validity
# alerts:
# - assertion: response.status == 500
# message: response status message
# - assertion: response.time > 150
# message: response time message
# Configuration example for enabling notification
# Using this configuration Monika will check the page every 10 seconds
# and will send a notification by email when the page response status returns 500 down 3 times in a row.
# Notifications defined as an array of configuration for sending alerts through the channels defined
# For a complete notification channel please refer to https://monika.hyperjump.tech/guides/notifications
# probes:
# - id: '1'
# name: Example Probe
# description: Probe
# interval: 10
# requests:
# - url: http://example.com
# method: POST
# timeout: 6000
# alerts:
# - assertion: response.status == 500
# message: response status message
# notifications:
# - id: unique-id-smtp,
# type: smtp,
# data:
# recipients:
# - RECIPIENT_EMAIL_ADDRESS
# hostname: smtp.gmail.com
# port: 587
# username: YOUR_GMAIL_ACCOUNT
# password: YOUR_GMAIL_PASSWORD_OR_APP_PASSWORD
# Other notifications channel configurations
# - id: random-string-monika-notif
# type: monika-notif
# data:
# url: https://YOUR_MONIKA_NOTIF_URL
# - id: random-string-mailgun
# type: mailgun
# data:
# recipients: [RECIPIENT_EMAIL_ADDRESS]
# apiKey: YOUR_API_KEY
# domain: YOUR_DOMAIN
# - id: random-string-sendgrid
# type: sendgrid
# data:
# recipients: [RECIPIENT_EMAIL_ADDRESS]
# apiKey: YOUR_API_KEY
# - id: random-string-smtp
# type: smtp
# data:
# recipients: [RECIPIENT_EMAIL_ADDRESS]
# hostname: SMTP_HOSTNAME
# port: 587
# username: SMTP_USERNAME
# password: SMTP_PASSWORD
# - id: random-string-statuspage
# type: statuspage
# data:
# apiKey: YOUR_STATUSPAGE_API_KEY
# pageID: YOUR_STATUSPAGE_PAGE_ID
# - id: random-string-webhook
# type: webhook
# data:
# method: POST
# url: https://WEBHOOK_URL
# - id: random-string-slack
# type: slack
# data:
# url: https://YOUR_SLACK_INCOMING_WEBHOOK_URL
# - id: random-string-telegram
# type: telegram
# data:
# group_id: YOUR_GROUP_ID
# bot_token: YOUR_BOT_TOKEN
# - id: random-string-whatsapp
# type: whatsapp
# data:
# recipients: ["1234567890"]
# url: http://example.com
# username: example
# password: password_example
# - id: random-string-teams
# type: teams
# data:
# url: https://YOUR_TEAMS_WEBHOOK_URL
# - id: random-string-discord
# type: discord
# data:
# url: https://YOUR_DISCORD_URL
# - id: random-string-workplace
# type: workplace
# data:
# thread_id: "1234567890"
# access_token: YOUR_CUSTOM_INTEGRATION_ACCESS_TOKEN
# - id: random-string-dingtalk
# type: dingtalk
# data:
# access_token: YOUR_CUSTOM_INTEGRATION_ACCESS_TOKEN
# - id: random-string-pushover
# type: pushover
# data:
# token: "app-token => please register app on pushover first"
# user: "user-token"
# - id: random-string-opsgenie
# type: opsgenie
# data:
# geniekey: "genie-key"
# - id: random-string-instatus
# type: instatus
# data:
# apiKey: YOUR_INSTATUS_API_KEY
# pageID: YOUR_INSTATUS_PAGE_ID
# limit log database size in bytes
db_limit:
max_db_size: 1000000000
deleted_data: 1
cron_schedule: '*/1 * * * *'
# status-notification: 0 6 * * *