Alert Configuration
Alert configuration file alertconfig.yml in alert_home/config folder
Used to configure skedler alerts configurations like host, port elasticsearch URL, authentication and folder configuration
Alertconfig.yml Configuration
S.NO |
Name |
Mandatory/Optional |
Description |
1. |
port |
Mandatory |
The port in which skedler-alerts runs. Default port is 3001 |
| 2. | host |
Optional | The host to bind the skedler alerts server. This bind address should be configured in /etc/hosts with host name e.g.: if bind address is 127.0.0.1 then in /etc/hosts 127.0.0.1 <hostname> should be added |
| 3. | basePath |
Optional | Enables you to specify a path to mount skedler alerts at if you are running behind a proxy. This only affects the URLs generated by skedler alerts, your proxy is expected to remove the basePath value before forwarding requests to skedler alerts. This setting cannot end in a slash. Default basePath is " ". |
| 4. | alert_index |
Mandatory |
Alert index which will be created in elasticsearch. It will create a new index if it doesn't already exist. Default alert_index is .alert |
| 5. | alert_history |
Mandatory |
Alert history which will be created in elasticsearch. It will create a new index if it doesn't already exist. Default alert_history is .alert_history |
| 6. | alerts_path |
Mandatory |
|
| 7. | workerCount |
Optional | Number of worker threads which depends on the CPU cores(n), Ideally n/2. e.g.: workerCount : [number] - 1 |
| 8. | max_records |
Mandatory |
The maximum matching records attach in mail or webhook. e.g.: max_records : [number] - 10 |
| 9. | max_table_rows |
Mandatory |
The maximum number of rows to show in the table on alert details. e.g.: max_table_rows : [number] - 500 |
| 10. | pingTimeout |
Optional |
Time in milliseconds to wait for elasticsearch to respond to pings, defaults to request_timeout setting. e.g.: pingTimeout : [number] - 1500 |
| 11. | requestTimeout |
Optional |
Time in milliseconds to wait for responses from the back end or elasticsearch. This must be > 0. e.g.: requestTimeout : [number] - 300000 |
| 12. | If Elasticsearch uses shield / search guard /any basic auth, add the shield user name and password for alert |
||
| alert_elasticsearch_username |
Optional | Username | |
| alert_elasticsearch_password |
Optional | Password | |
| 13. | If Elasticsearch behind Ngnix, configure Ngnix username password for elasticsearch in alert |
||
| alert_nginx_elasticsearch_username |
Optional | Username | |
| alert_nginx_elasticsearch_password |
Optional | Password | |
| 14. | Enables SSL and paths to the PEM-format SSL certificate and SSL key files, respectively. These settings enable SSL for outgoing requests from the skedler alerts server to the browser | ||
| server_ssl_enabled |
Optional | In order to enable SSL for outgoing requests from the skedler alerts server to the browser , set this variable as true. By default the variable is set to false. e.g: server_ssl_enabled : [boolean] - false |
|
| server_ssl_certificate |
Optional | If server_ssl_enabled is true. You need to set the server_ssl_certificate path e.g: server_ssl_certificate: /path/to/your/server.crt | |
| server_ssl_key |
Optional | If server_ssl_enabled is true. You need to set the server_ssl_key path e.g: server_ssl_key: /path/to/your/server.key |
|
| 15. | Optional settings that provide the paths to the PEM-format SSL certificate and key files. These files validate that your Elasticsearch backend uses the same key files. |
||
| enable_elasticsearch_ssl |
Optional | In order to enable SSL for Elasticsearch , set this variable as true. By default the variable is set to false e.g.: enable_elasticsearch_ssl : [boolean] - false | |
| elasticsearch_ssl_certificate |
Optional |
If enable_elasticsearch_ssl is true. You need to set the elasticsearch_ssl_certificate path e.g.: elasticsearch_ssl_certificate: /path/to/your/client.crt |
|
| elasticsearch_ssl_key |
Optional |
If enable_elasticsearch_ssl is true. You need to set the elasticsearch_ssl_certificate path e.g.: elasticsearch_ssl_key : /path/to/your/client.key |
|
| 16. | elasticsearch_ssl_certificateAuthorities |
Optional |
Optional setting that enables you to specify a path to the PEM file for the certificate authority for your Elasticsearch instance. e.g.: elasticsearch_ssl_certificateAuthorities : [ "/path/to/your/CA.pem" ] |
| 17. | elasticsearch_ssl_verificationMode |
Optional | To disregard the validity of SSL certificates, change this setting's value to 'none' e.g.: elasticsearch_ssl_verificationMode: full |