| 1 | # yamllint disable rule:line-length |
| 2 | --- |
| 3 | - id: 'notify-kavenegar' |
| 4 | meta: |
| 5 | name: 'Kavenegar' |
| 6 | link: 'https://kavenegar.com/' |
| 7 | categories: |
| 8 | - notify.agent |
| 9 | icon_filename: 'kavenegar.png' |
| 10 | keywords: |
| 11 | - Kavenegar |
| 12 | overview: |
| 13 | notification_description: | |
| 14 | [Kavenegar](https://kavenegar.com/) as service for software developers, based in Iran, provides send and receive SMS, calling voice by using its APIs. |
| 15 | You can send notifications to Kavenegar using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more. |
| 16 | notification_limitations: '' |
| 17 | setup: |
| 18 | prerequisites: |
| 19 | list: |
| 20 | - title: '' |
| 21 | description: | |
| 22 | - The APIKEY and Sender from http://panel.kavenegar.com/client/setting/account |
| 23 | - Access to the terminal where Netdata Agent is running |
| 24 | configuration: |
| 25 | file: |
| 26 | name: 'health_alarm_notify.conf' |
| 27 | options: |
| 28 | description: 'The following options can be defined for this notification' |
| 29 | folding: |
| 30 | title: 'Config Options' |
| 31 | enabled: true |
| 32 | list: |
| 33 | - name: 'SEND_KAVENEGAR' |
| 34 | default_value: 'YES' |
| 35 | description: "Set `SEND_KAVENEGAR` to YES" |
| 36 | required: true |
| 37 | - name: 'KAVENEGAR_API_KEY' |
| 38 | default_value: '' |
| 39 | description: "Set `KAVENEGAR_API_KEY` to your API key." |
| 40 | required: true |
| 41 | - name: 'KAVENEGAR_SENDER' |
| 42 | default_value: '' |
| 43 | description: "Set `KAVENEGAR_SENDER` to the value of your Sender." |
| 44 | required: true |
| 45 | - name: 'DEFAULT_RECIPIENT_KAVENEGAR' |
| 46 | default_value: '' |
| 47 | description: "Set `DEFAULT_RECIPIENT_KAVENEGAR` to the SMS recipient you want the alert notifications to be sent to. You can define multiple recipients like this: 09155555555 09177777777." |
| 48 | required: true |
| 49 | detailed_description: | |
| 50 | All roles will default to this variable if lest unconfigured. |
| 51 | |
| 52 | You can then have different SMS recipients per role, by editing `DEFAULT_RECIPIENT_KAVENEGAR` with the SMS recipients you want, in the following entries at the bottom of the same file: |
| 53 | ```text |
| 54 | role_recipients_kavenegar[sysadmin]="09100000000" |
| 55 | role_recipients_kavenegar[domainadmin]="09111111111" |
| 56 | role_recipients_kavenegar[dba]="0922222222" |
| 57 | role_recipients_kavenegar[webmaster]="0933333333" |
| 58 | role_recipients_kavenegar[proxyadmin]="0944444444" |
| 59 | role_recipients_kavenegar[sitemgr]="0955555555" |
| 60 | ``` |
| 61 | |
| 62 | The values you provide should be defined as environments in `/etc/alertad.conf` with `ALLOWED_ENVIRONMENTS` option. |
| 63 | examples: |
| 64 | folding: |
| 65 | enabled: true |
| 66 | title: '' |
| 67 | list: |
| 68 | - name: 'Basic Configuration' |
| 69 | folding: |
| 70 | enabled: false |
| 71 | description: '' |
| 72 | config: | |
| 73 | #------------------------------------------------------------------------------ |
| 74 | # Kavenegar (Kavenegar.com) SMS options |
| 75 | |
| 76 | SEND_KAVENEGAR="YES" |
| 77 | KAVENEGAR_API_KEY="XXXXXXXXXXXX" |
| 78 | KAVENEGAR_SENDER="YYYYYYYY" |
| 79 | DEFAULT_RECIPIENT_KAVENEGAR="0912345678" |
| 80 | troubleshooting: |
| 81 | problems: |
| 82 | list: [] |