Run with GMail Notification

1. Create a monika.yml file and fill it out with the following

1 notifications:
2   - id: unique-id-smtp
3     type: smtp
4     data:
5       recipients:
6         - YOUR_EMAIL_ADDRESS_HERE
7       hostname: smtp.gmail.com
8       port: 587
9       username: YOUR_GMAIL_ACCOUNT
10       password: YOUR_GMAIL_PASSWORD_OR_APP_PASSWORD
11 probes:
12   - id: '1'
13     name: Monika Landing Page
14     description: Landing page of awesome Monika
15     interval: 10 # in seconds
16     requests:
17       - url: https://hyperjumptech.github.io/monika
18         timeout: 7000 # in milliseconds
19     alerts:
20       - status-not-2xx

2. Replace YOUR_EMAIL_ADDRESS_HERE in the monika.yml with your email address that will receive the notification.

3. Replace YOUR_GMAIL_ACCOUNT with your valid Gmail account, e.g., yourname@gmail.com.

4. Replace YOUR_GMAIL_PASSWORD_OR_APP_PASSWORD with your Gmail password.

   1. If you have activated Two Factor Authentication (2FA), you need to create an app password. Refer here to create an app password for your Gmail account.

5. If you have installed Monika globally, run monika from Terminal app (macOS) in the same directory where monika.yml exists. If you haven't, you can quickly run Monika by running npx @hyperjumptech/monika in the same directory where monika.yml exists.

6. During runtime, Monika will output a log that looks like this

    INFO (on x1): Starting Monika. Probes: 4. Notifications: 1
   

1 INFO: 2021-06-16T04:14:40.128Z 1 id:5 200 http://localhost:7001/health 7ms
2 INFO: 2021-06-16T04:14:45.109Z 2 id:5 200 http://localhost:7001/health 4ms
3 INFO: 2021-06-16T04:14:50.126Z 3 id:5 200 http://localhost:7001/health 10ms
4 INFO: 2021-06-16T04:14:55.107Z 4 id:5 200 http://localhost:7001/health 1ms
5 WARN: 2021-06-16T04:15:00.117Z 5 id:5 500 http://localhost:7001/health 0ms, ALERT: status-not-2xx
6 WARN: 2021-06-16T04:15:05.371Z 6 id:5 500 http://localhost:7001/health 0ms, ALERT: status-not-2xx
7 WARN: 2021-06-16T04:15:10.128Z 7 id:5 500 http://localhost:7001/health 0ms, ALERT: status-not-2xx
8 WARN: 2021-06-16T04:15:15.138Z 8 id:5 500 http://localhost:7001/health 0ms, ALERT: status-not-2xx, NOTIF: service probably down
9 INFO: 2021-06-16T04:15:20.130Z 9 id:5 200 http://localhost:7001/health 6ms
10 INFO: 2021-06-16T04:15:25.128Z 10 id:5 200 http://localhost:7001/health 4ms
11 INFO: 2021-06-16T04:15:30.137Z 11 id:5 200 http://localhost:7001/health 6ms
12 INFO: 2021-06-16T04:15:35.146Z 12 id:5 200 http://localhost:7001/health 8ms, NOTIF: service is back up
13 INFO: 2021-06-16T04:15:40.140Z 13 id:5 200 http://localhost:7001/health 4ms
14 
15 
16 INFO_TYPE: current-time iteration probe:id _probeURL_ [response time in ms],[ALERT messages if any], [NOTIFICATION messages if any]