Skedler Configuration

Skedler has two configuration files

  • reportingEngineOptions in skedler_home/config folder

               Used to configure ReportingEngine options like scaling options, Phantom options etc.,

  • reporting.yml in skedler_home/config folder

              Used to configure skedler configurations like host, port elasticsearch URL, Kibana URL , authentication and folder configuration


ReportingEngine Configurations


ReportingEngine is scaled as per the CPU cores in the system and is configurable. The parameter "workerCount" in the file config/reportingEngineOptions specifies how many worker threads are created to scale. Ideally, it can be set as n/2, where n is the number of CPU cores as shown. The default value is 2, assuming a 4 CPU core system. If the system freezes, try reducing the workerCount. The minimum value is 1.




RZJeHzALgtn5gxg1DzoPYDxRL7SAl25b2g.png



Other setting in reportingEngineOptions


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 also increases.
2
phantomPort


Optional


Port series for Phantom. If workerCount is 2 phantom instance will be listening on ports 12301 (phantomPort + 1) and 12302(phantomPort + 2)




Reporting.yml Configurations


Other settings in reporting.yml


S. NO  Name Mandatory/Optional Description
1     port
Mandatory
The 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 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 kibana_index
Mandatory
Kibana uses an index in Elasticsearch to all data. Configure kibana index here. skedler will use this index to auto discover dashboards.
Skedler will not create this index. Default kibana_index is .kibana
4 skedler_index
Mandatory
Skedler index which will be created in elasticsearch. It will create a new index if it doesn't already exist. Default skedler_index is .skedler
5 Kibana_version
Mandatory
Skedler to identify Kibana configurations
6 Kibana_display_url
Optional
URL configuration for skedler kibana connectivity and kibana proxy URL in UI
7 load_time
Optional

Kibana dashboard load time is the approximate load time provided by Skelder for Kibana to generate the dashboards.

If reports are not fully loaded, configure (increase) the load time (in milliseconds) here so that Skedler provides adequate time for Kibana to load the dashboard.


Default load_time value is 10 seconds (10000 milliseconds)
8 kibana_shield_plugin
Optional
Kibana shield plugin is installed in kibana to connect to elasticsearch shield.
If kibana shield plugin is installed in Kibana please set this variable as "yes". By detfault the variable is set to “no”.
If kibana does not have shield plugin and elasticsearch is configured with shield, set this variable to “no”.
9 log_dir
Optional
You can configure the location for storing your skedler log files using log_dir. Make sure the folder has read/write permissions. The default location is skedler/log in the application directory.
10 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 storing the files. Make sure the folder has read/write permissions. The following folders in Skedler will be persisted:

skedler/src/logo
skedler/src/public/img
skedler/src/public/custom
11
basePath
Optional
Enables you to specify a path to mount skedler at if you are running behind a proxy. This only affects the URLs generated by skedler, your proxy is expected to remove the basePath value before forwarding requests to skedler.
This setting cannot end in a slash.

12
search_limit
Optional
Search limit is the number of rows to show in the search table. Limit should be between 1 and 10000. The default value is 500
For PDF report the max limit is 1000. If the search_limt size is greater than 1000. The default value 1000 will be set.
For excel and CSV report the max limit is 10000.