Skedler Configuration 


Skedler has two configuration files

  • reporting.yml in $skedler_home/config folder
                    Used t configure Skedler configuration like Elasticsearch URL, Kibana URL, Security credentials, host configuration etc.,
  • reportingEngineOptions in $skedler_home/config folder
                    Used to configure Skedler report generation options like scaling options, Phantom Flags etc.,

reporting.yml CONFIGURATION

BASIC SETTINGS

S. No
Name
Mandatory/Optional
Description
1
elasticsearch_url
Mandatory
The Elasticsearch instance to use for all your queries.
2
kibana_url / grafana_url
Mandatory
Kibana/Grafana URL specification.
KIBANA SECURITY SETTINGS
3
security
Optional
If Security plugin is configured in Elasticsearch/Kibana - xpack/searchguard/readonlyrest, then uncomment and configure the security variable as xpack or searchguard or readonlyrest.
4
ESsecurity_user_login
Optional
If Elasticsearch is configured with the security plugin, and if Elasticsearch has security users created, then us can use the security users to login Skedler. User-based reports will be created. To enable Elasticsearch security users in Skedler uncomment and set this variable as `yes`.
5
skedler_elasticsearch_username
skedler_elasticsearch_password
Optional
If Elasticsearch uses security or basic auth, add the security username and password here for Skedler.
6
kibana_elasticsearch_username
kibana_elasticsearch_password
Optional
If Elasticsearch uses security or basic auth, add the security username and password here for Kibana.
NGNIX SETTINGS
7
skedler_nginx_kibana_username
skedler_nginx_kibana_password
Optional

If Kibana is behind Ngnix, configure Ngnix username password.
8
skedler_nginx_elasticsearch_username
skedler_nginx_elasticsearch_password
Optional
If Elasticsearch is behind Ngnix, configure Ngnix username password.
GRAFANA SETTINGS
9
grafana_authentication
Optional
If have authentication to access the dashboard, uncomment and set the variable as yes.
10
skedler_grafana_username
skedler_grafana_password
Optional
If Grafana has authentication to access the dashboard, add the username and password.
11
grafana_auth_token_key
Optional
If Grafana has an authentication token key to access the dashboard, add the token key.


ADVANCED SETTINGS

S. No
Name
Mandatory/Optional
Description
HOST SETTINGS
1
port
Optional
Port in which Skedler runs.
Default port is 3000.
2
host
Optional
The host to bind the Skedler server. This bind address should be configured in /etc/hosts with hostname.
If bind address is 127.0.0.1 then in /etc/hosts the following should be added
127.0.0.1 <hostname>
3
basePath
Optional
Enables you to specify a path to mount Skedler at if you are running Skedler behind a proxy. This only affects the URL generated by Skedler, your proxy is expected to remove the basePath value before forwarding request to Skedler. This settings cannot end in a slash.
INDEX SETTINGS
4
skedler_index
Optional
Skedler index which will be created in elasticsearch. It will create a new index if it doesn't exist.
Default Skedler index is .skedler
5
kibana_index
Optional
Skedler uses this index to auto discover dashboard.
Default Kibana index is .kibana.
Note: Skedler will not create this index.
REPORT SETTINGS
6
ui_files_location
Optional
When you update Skedler version you may require logo and images and custom CSS files which needs to be persisted. You can configure the location for location the files. Make sure the folder has read/write permission. The following folder in Skedler will be persisted.
7
log_dir
Optional

Enables you to specify a folder where Skedler stores the log output. 

Default log output directory $skedler_home/log.

8
browser
Optional
Specifies whether Skedler report generation browser to be chromium or phantom. Default value is set as phantom.
ELASTICSEARCH CONNECTION SETTINGS
9
search_limit
Optional
Search limit is the number of rows to show in the search table. Limit should be between 1 and 10000.
PDF report  the max limit is 1000. If the search limit is greater than 1000, then the default value 1000 will be set.
Excel and CSV report the max limit is 10000
Default value is 500.
10
enable_elasticsearch_ssl: true
elasticsearch_ssl_certificate
elasticsearch_ssl_key
Optional
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.
11
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.
12
elasticsearch_ssl_verificationMode
Optional
To disregard the validity of SSL certificates, change this setting's value to 'none'.
13
pingTimeout
Optional
Time in milliseconds to wait for Elasticsearch to respond to pings. This must be > 0.
14
requestTimeout
Optional
Time in milliseconds to wait for responses from Elasticsearch. This must be > 0.
KIBANA CONNECTION SETTINGS
15
kibana_display_url
Optional
Kibana Display URL specification
16
kibana_display_icon
Optional
Enables to display Kibana icon in Skedler menu.
Default value is set to no.
SKEDLER REPORT SSL SETTINGS
17
server_ssl_enabled
server_ssl_certificate
server_ssl_key
Optional
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 server to the browser.



reportEngineOptions CONFIGURATION


S. No
Name
Mandatory/Optional
Description
1
quality
Optional
You can set the quality of the image between a range of 0 to 100. Default quality 0.

Note: As the quality increases the generated PNG size increases

2
workerCount
Optional
ReportEngine is scaled as per the CPU cores in the system and is configurable using the workerCount variable.
Ideally, its set as n/2,  where n is the number of CPU cores.
The default value is set to 1.
3
workerDeath
Optional
Number of times to reuse the phantom/chromium instance.
The default value is set to 1.
4
pageTries
Optional
Number of tries to load the report generation URL.
5
pageCount
Optional
Number of pages analysed concurrently by the same phantom instance.
The default value is set to 1. (recommended)
6
pageDeath
Optional
Timeout for the report generation process to wait for a report to be generated. The default value is set to 600000. (recommended)
7
phantomPort
Optional
Port series for Phantom.
8
phantomFlags
Optional
Options to load the report engine browser(Phantom) like web security, ssl, proxy.