Introduction


Use this guide for Skedler v2.8.1.   For Skedler v3.0 or higher please refer to How to configure email settings, time zone settings and default logo for reports

 

Skedler is an easy-to-use report scheduling and distribution application for Kibana. The application allows you to centrally schedule and distribute Kibana Dashboards for a specific time window as hourly, daily, weekly, and monthly PDF reports to customers, managers, and other stakeholders.

 

Skedler enables you to send the right information to recipients at the right time. Managers and stakeholders appreciate the convenience of Kibana reports delivered automatically to their email inbox , as they can open and read the report from mobile or desktop email clients. Report Scheduler saves both capital and operational expenses for IT departments by driving both analysis and reporting from the Kibana Platform and eliminating redundant reporting systems for Elasticsearch.

 

This document provides information on how to configure reports using the Report Scheduler for Kibana 4 and 5 releases. For information on installing Report Scheduler for Kibana 4 and Kibana 5. refer the Skedler Installation Guide.

Skedler Concepts

S.No.
Name
Mandatory/Optional
Description
1
Scheduled Report Name

Mandatory

A name used to define the scheduled report

2
Kibana Dashboard/ Search

Mandatory

The kibana dashboard/search forms the basis of the scheduled report. Skedler can automatically search all the existing kibana dashboards/search. You need to select one dashboard/search for your report.
3
Filter List

Optional

A filter list is a collection of dynamic queries and recipients that can be applied to a dashboard to create a report.
4
Filter List (Report Filter)
Optional

A report filter is a dynamic elasticsearch query filter that is applied to a dashboard to create the report. It is the same query that you use in Kibana for filters. An example is zip:”94538” AND city:”Fremont”.
5
Filter List (Report Recipients)
Optional
The targeted email addresses who receive the report corresponding to a specific filter. Email addresses are separated by a comma.
6
Filter (Folder Path)

Optional

Folder Path can be set for storing the scheduled reports at different levels. Hierarchy of folder path for storing scheduled report. If a path is set in Filter Folder Path, the reports are stored in the specified path (filter level). If a path is set in Schedule Report  Folder Path, the reports are stored in that folder (reports level) else if-if path is set in configuration file reporting.yml then the scheduled reports are stored in this folder , if nowhere folder is specified reports will be stored in skedler home folder at skedler/reports directory
7
To and CC

Optional

The email addresses to which the scheduled report is sent.  Email addresses are separated by a comma.
8
Parameters

Optional

You can set parameters in Subject and Message. For Example: You can select the parameter name “Dashboard Url” and copy paste the parameter “${{DashboardUrl}}” in the required place.
9
Subject

Optional

Subject for the email through which report is attached.

10
Message

Optional

Message content for the email through which the report is attached.
11
Schedule

Optional

Schedule set to generate reports on an hourly, daily, weekly, monthly, or yearly basis.

12
Report Time Window
Optional
a) Dashboard Time Window – Generate the scheduled report with the stored time when the dashboard is saved with “Store time with dashboard” option in Kibana.

b) Time Window - Generate a report for a specific time window.

13
Report Layout / Filter Layout
Optional
You can configure the Report Layout based on the report type.
Note: Layout Configuration applicable only for PDF reports.


Paper size: If the report type is PDF, you can configure the paper size of the report as follows:

a) Set the paper or sheet size as Letter, Legal, A4, A3, Tabloid or Default size (Height as 1024 pixel and width as 2048 pixel)

b) Landscape

14
Report Logo
Optional
You can set a logo for the report to be generated. The logo options are as follows:
a) Default Logo: In the Configuration page you can upload the default logo to the PDF reports from "Other Settings"(This applies for all reports)
b) Custom Logo: You can set custom logo for a specific report by uploading logo in the Logo field.


Access skedler

After installation, skedler can be accessed from the following URL if it is using the port 3000: http://<yourserver>:3000

Configure Email

When you log on for the first time, the Email Configuration page is displayed.

Email Settings

1. Set the Email Setting field to:

   • On: When you want to email the reports

   • Off: When you do not want to email the reports (However the reports will be generated in the folder specified)

2. By default Supported Service is set to Others which allows you to set the following fields,

  • Enter the outgoing server in the Outgoing Server field.
  • Enter the email id of the sender in the Sender’s Email ID field (this is the emaild id from which all the reports are sent) to configure the outgoing mail settings.
  • Select the Enable Password checkbox if the SMTP server has authentication.
  • Enter the password in the Password field.

3. You can also select the available list of services and set the following fields,

  • Gmail Service
    • Enter the email id of the sender in the Sender’s Email ID field (this is the emaild id from which all the reports are sent) to configure the outgoing mail settings.
    • Enter the password in the Password field.
  • Amazon SES Service
    • Enter the email id of the sender in the Sender’s Email ID field (this is the emaild id from which all the reports are sent) to configure the outgoing mail settings
    • Enter the username in the Username field.
    • Enter the password in the Password field.

4. Enter the "Admin Email" field to which a warning message will be sent if the reports are empty 

5. Click Save to save the configuration.



Time Zone Settings

1. Enter the time zone to schedule the report in the Time zone field.

2. Click Save to save the time zone settings for the schedule report.


CYw8EJCCd9obW_9MVwGQ36Igm2vpfcsEFQ.png



3. Optionally, you can click Select image from the Logo field to upload the logo for the generated PDF report.

4. Click Save to save the uploaded image. To reset the image, click Reset.

 

Schedule Reports

To schedule the report, click the Schedule Report button.



AkPwZ5EqhElwDYG_Cwc11WRsHpWQhtVB1w.png






Refer the Schedule Report based on Dashboard section to schedule the reports for Dashboard and Schedule Report based on Dashboard section to schedule the reports based on Search.

 

Schedule Report based on Dashboard

Enter the appropriate values in the fields to generate the report.

Report Details

1. Enter the name of the report in the Scheduled Report Name field.

2. Select the type as Dashboard to schedule the report.

3. Select the required dashboard from the Select Dashboard dropdown to generate reports.

4. Select the required filter from the Select Filter dropdown. By default, the “No filter” option is selected.

Refer the Setup filter section to setup the filter and configure the filter for the scheduled reports.

5. Select the format of the report from the Report Format dropdown. The following formats are available:

PDF, PNG - Inline, PNG - Attachment or Excel.

Note: When the Email setting is disabled, the report is downloaded in the PDF or PNG format.

6. Enter the folder path to store the scheduled reports in the Folder Path field.

7. Optionally, you can enable the Include Report type option to generate excel report along with the other report type PDF, PNG - Inline, or PNG - Attachment. By default None is enabled

8. Select the folder path from the Folder Path dropdown in which the scheduled reports are stored.

9. Click Next.


ZSUGQiQ90bHVl1qmdtENCgExebc_0NVfrg.png




Layout Details

1. Enter the title of the report for the generated PDF report in the Report Title field.

2. Optionally you can refer the steps 13 and 14 in Skedler Concepts to set the Report Layout based on the report type.

3. Click Next.


gKNj1oirlPIvW7F671Dk8XHfpOQ4PQOFhQ.png




Schedule Details

1. Setup the schedule for the report by selecting the Frequency Type as “Hourly”, “Daily”, “Weekly”, “Monthly”, or “Yearly”

2. Enter the scheduled frequency time in the Schedule Frequency Time section to schedule report generation.

3. Enter/select the start time to generate the report from the Start Time field.

4. If the Dashboard is saved with Store time with dashboard in kibana then Use dashboard time window option is enabled by default. This schedules the report for the stored time. If Use dashboard time window checkbox is not selected, Time Window is enabled, which allows you to generate report for a specific time

window.

5. Click Next.


DkW0oKshhATpDtx0668yKvdZU9aD8oBXjw.png





cjq5Ih7LKnAf9XZhfGejUwDhdXgXE-r9gA.png

 



Email Details

You can generate the reports using the Generate now option when the Email Setting option is set to “off” in the Email Configuration page. You can also schedule email for the report if the Email Setting option is set to “on” in the Email configuration page. For more information, refer the Configure Email section.

 

1. Select the parameter name from the Merge Parameter Name field. You can merge the parameter names in the Subject and Message fields for the email with the generated report.

2. Enter the subject of the email in the Subject field.

3. Enter the message for the email in the Message field.

3. Enter the recipient email address in the Email To field.

4. To  send the generted reports to the recipients corresponding to the filter, select the Include Recipients in Filter checkbox. Refer to Set up Filters section for information on setting up the filter.

5. To send a copy of the email, enter the email addresses in the Email CC field.

6. To send a copy of the report instantly, click the Mail Now button.

7. To save the scheduled report, click Save.


nr6UbE82Pv1qwVVsMfwSr8LZjiCBf7mtag.png



When the report is scheduled, you can view the scheduled report for the Dashboard.


ERIZCOh50urB17MpBPQ1YRcOZfXH0eoDrg.png



8. Click the edit icon to edit the scheduled report.


ZlT7TC6KSOF0xZWvJf5ESFHwg_sOPRGQCw.png




9. To delete the scheduled reports, click the delete icon.



hN4O7JWkboGw3SQ_T89_1Ppp8NvizxCCcw.png




10. To copy the existing scheduled report, click the clone icon. The Clone Report window is displayed.


h-xDU6JDxo8onvLKgrRfJzTgN6LY8nw5Pw.png




11. Enter the name of the report and click the Clone button.


dp_Cpw8TFR-tu7eLZZeixehvleasPB2eHw.png




 

6ArEcbWgq7AvyU6bq48YymO4uCRC5je-HQ.png



 

12. To pause the scheduled reports, click the pause icon. When you pause a scheduled report, the reports are no longer generated or mailed until resumed.


859su5eijT9Qgfb2OGWMOS7lXf8yQd8VLg.png





_Z5E-aZtFjBow5iPeNonSPz_SMNdHGcWuA.png


ZYwxohtfprCM7X6pgB-RbFQQyHZOjXTmlQ.png



 

13. To resume the scheduled dashboard report, click the Resume icon.

Note: For Hourly reports, the reports are generated from the given start time. You must update the start time when you want to generate the report at the next hour. If needed to generate from next hour please update the start time.


E1z8BGWwBPAyBda77LGnqQQsRclNK3kZLA.png




Preview Dashboard Report

1. Click the preview icon to preview the dashboard.


VUxFhR5R6GYy5UQPiAiopGX1eTLycyRwHg.png




2. Select the preview type along with the preview time window (hourly, daily, weekly, monthly, yearly or dashboard time window)

3. Based on the selected preview type, select the Filter Layout options as mentioned in the steps 13 and 14 in the Skedler Concepts section.

4. Click the Preview button to preview the report.


qp5wMRAYjXlnyi1Z4i0asvWHiw7-VqtJGA.png



 

5. Enter the email address in the Mail To field, and click the Mail Now button to send the report instantly.


r-yl7ToR3I6F1XO9_yuA_P6V_25p9xEAhA.png


Note: If the Dashboard is saved with the “Store time with dashboard” option in kibana, you can preview the dashboard with the stored time by selecting the Dashboard time window option.

 

If the “Use dashboard time window” option is cleared and the “Time Window” option is enabled, you can generate a report for a specific time window.

Schedule Report based on Search

Enter the appropriate values in the fields to generate the report.

Report Details

1. Enter the name of the report in the Scheduled Report Name field.

2. Select the type as Search using which you can schedule the report.

3. Select the required search from the Select Search field to generate reports.

4. Select a filter from the Select Filter dropdown. By default, the “No filter” option is selected. Refer the Setup filter section to setup and configure the filter for the scheduled reports.

5. Select the required report format from the Select Format dropdown. The available options are PDF and Excel.

6. Optionally, you can enable the Include Report type option to generate excel or CSV report along with PDF.

7. Select the folder path from the Folder Path dropdown in which the scheduled reports are stored.

Note: Search cannot be stored with time in kibana; hence skedler cannot schedule a report using the “Use dashboard time window” option.

8. Click Next.


RMwWP5wVIbySzhlIbt-UEJBSxJbPMrsCbw.png




Layout Details

1. Enter the title of the report generated in the Report Title field.

2. Refer the steps 13 and 14 in Skedler Concepts to set the Report Layout based on the report type.

3. Click Next.


TIK73ls3bLFaH1QfixwaHInKDdYDgAHCmg.png




Schedule Details

1. Setup the schedule for the report by selecting the Frequency Type as “Hourly”, “Daily”, “Weekly”, “Monthly”, or “Yearly”.

2. Enter the scheduled frequency time in the Schedule Frequency Time section to schedule report generation.

3. Enter/select the start time to generate the report from the Start Time field.

4. Select the Time Window option to generate report for a specific time window.

5. Click Next.


HHvFFovSz2yPlu_7uifzyktUJF57TX1b1Q.png



Email Details

You can generate the reports using the Generate now option when the Email Setting option is set to “off” in the Email Configuration page. You can also schedule email for the report if the Email Setting option is set to “on” in the Email configuration page. For more information, refer the Configure Email section.

 

1. Select the parameter name from the Merge Parameter Name field. You can merge the parameter names in the Subject and Message fields for the email with the generated report.

2. Enter the subject of the email in the Subject field.

3. Enter the message for the email in the Message field.

3. Enter the recipient email address in the Email To field.

4. To  send the generted reports to the recipients corresponding to the filter, select the Include Recipients in Filter checkbox. Refer to Set up Filters section for information on setting up the filter.

5. To send a copy of the email, enter the email addresses in the Email CC field.

6. To send a copy of the report instantly, click the Mail Now button.

7. To save the scheduled report, click Save.

 

44-W0pIJ7Z2nHxqLdiwwHhM6Q1h8_ZyNNw.png



 

When the report is scheduled, you can view the scheduled report for the Search:


HoUlFVyrXnurAXIM1GCqKpox_fvfW5I_xQ.png




8. Click the edit icon to edit the scheduled report.


WKx9Bt9fgp18Ss3prnkdjkYPD24XIbSh3g.png




4. To delete the scheduled reports, click the delete icon.


5PJFwwdua5_5wTcoxVtPoUONCq8R8GKKaQ.png




10. To copy the existing scheduled report, click the clone icon. The Clone Report window is displayed.


qz5ier_gg9UPn7T1mL5Tf8U6cE-U-9WOPA.png




11. Enter the name of the report and click the Clone button.


JtgfqlkS61dUynXpIxMtExQZKCxvwi2tqw.png




5QpY9ZNcNbErDcCf5hiMrMZb4Ub01rriIA.png



12. To pause the scheduled reports, click the pause icon. When you pause a scheduled report, the reports are no longer generated or mailed until resumed.


eb3Xrk6XrMrMuvrKm_lPVTGfm0PkS_wTTA.png




pbycHNROMjHrb9QLXyZ5SLXhB4xBDtpiaw.png





UkKEQs9gM3aCprV048Y2ASVyEAvNBOd-LQ.png



13. To resume the scheduled search report, click the resume icon.


j2vMNZovegAfZJHFp1_bACndN71BJdBykg.png



Note: For Hourly reports, the reports are generated from the given start time. You must update the start time when you want to generate the report at the next hour.

Preview Search Report

1. Click the preview icon to preview the dashboard.


GDXx1pmuxYZdnfhIXTlMCf73Fpid__Rbiw.png



 

2. Select the preview type along with the preview time window (hourly, daily, weekly, monthly, yearly).

3. Based on the selected preview type, select the filter layout options as mentioned in the step 13 and 14 in the Skedler Concepts section.

4. Click the Preview button to preview the Search report.


1Bd0KPReyjpdc2N1-QXmV_RnZlw2hutrew.png



5. To email the report, enter the email address in the Mail To field and click the Mail Now button.


BYcID1Oml1O8YZTwZEPBMgM8pmsK_yIhng.png



“Time Window” allows generating report for a specific time window.

Notification

Skedler notification enables you to track the failure reports. You can view the notifications in the Notification list page.

1. Click the notification icon to view the notification list. The notification is generated when:

• Elasticsearch cluster is down.

• There is a failure in sending mail for the scheduled report.

• There is a failure in a generating report.


E8tKEWIsQKzcARqkTTSnJtOGqceDe57MZw.png



Grid View

 

To change the view of the Scheduler home page, click the grid icon.



h0xROMQdPIOt5Idw1sajJDgZn4WbdhLieQ.png



 



Setup Filters

Filters are used to generate and send custom reports based on a single dashboard. For example, you can create a generic Kibana dashboard to display the Web traffic for all your customers. You can then apply a dynamic filter CustomerID: “1001” to the Kibana dashboard to view the web traffic for CustomerID 1001 and send an email only to that customer.

 

You can reuse the filter on other Kibana Dashboards. For example, you can apply the same filter to the Sales Dashboard to view the sales information for a specific customer.

Note: Setting up of filters is optional.

 

Set up Filter Lists

 

A filter list is a collection of filters. An example is a list of pre-defined filters based on the CustomerID and custom email recipients for each filter.

 

1. Click the Add New Filter List button to create a filter list.


U3Jp_PzDc3PFKaPQgPjhfMKUwhStUSyKRA.png




yRnkI5Q8inoMReTRnPgMxRZ8l64ZbgbX0g.png



2. Enter the name of the filter list in the Filter List Name field.

3. To upload the excel file, click the Upload Filters from Excel button.

4. Click the Create button to create a filter list with zero filters (you can add filters later).



 


A sample Excel file format with filters, recipients and folder is given below. The recipients can be an individual email address, email mailing list or can be blank.


yqzsYFZwXy8W-_BsLUh6gWpJdQZZB_2JCA.png

Izx0tGZ4Q_QcxgXu1pI4LmhncElRrWG9bw.png

OiDdxTZTe0S8nF686I6KslRYrH48MDjtWQ.png



3. To edit a filter list, click the edit icon.


mA8yPW1IS03m9iAzgsWnup4CyI-fk_FSoQ.png




LtMxf4HmXQA6Swp8VCrA4JgH1yWuVm86BA.png



4. To delete a filter list, click the delete icon.


LZkRDovF-IIU3InYumHqJ-QLnGuth5jEzA.png




Set up Filters

1. Click the edit icon in the Filter List to set up or edit the Report filters.


WpD3Cx9Quh93QHvT1VQTkfZVXnPOGD_9jA.png


Note: You can edit the report filters by uploading the excel file or through UI.

 

3. Click the Upload Report Filters from Excel to add or overwrite the report filters. The Add option enables you to add the uploaded report filters to the existing report filters. The Overwrite option replaces the existing filters with uploaded report filters.


q4NxtM6W7q22tLiJ9KtvZCX5LqxvPfyygg.png



4. Click the Create button to create the Report filter list.


SZZ7GIuO90ZkpM-DPIWa9xAJWhl_p-63Vg.png




sw8l9COHBS_bY2JQREWLYjbKUtpTmQFlSg.png



5. To add the report filters through UI, click the Add Report Filters button.


506r8Fn9n_M4e5NusnfWjKOql1xzO1mUDg.png



6. Click Save to save the report filter.


YIrp66KSVU-Hs9bV70oXQHEbxHGDwokpPA.png



3. Click the edit icon to edit a report filter.


1BhFm98uOjZN1Hp2IFINuizcv_p5PiMndg.png



4. Click the delete icon to delete a report filter.


e9W-QD2nSdNJID_yiviaxCmCwymhgD5YkA.png




Preview Reports with Filters

Report Filters can be applied to the Kibana dashboards that are created in the Kibana installation. When the filters are relevant to the Kibana dashboard, a dashboard with the filtered data is displayed.

 

1. Click the preview icon to preview the report filter.

2. Select on the type, based on the type Skedler automatically discover all the existing kibana dashboards/searches for you. Select the dashboard/search and preview type along with the preview time window (hourly, daily, weekly, monthly, yearly or dashboard time window) and based on the preview type the Filter Layout options as mentioned in the step 13 and 14 in Skedler Concepts can be selected. Click Proceed button.

 

If the dashboard is saved with Store time with dashboard option in kibana, the dashboard can be previewed with the stored time by selecting dashboard time window.


BGSadwCdno8t4cBx3OULEUN88Ob8AQ-Mtg.png



 

a) Preview for Type “Dashboard” and click “Proceed”.


lto4YIM80nOW2A8KjG7fyRS64eq4v-FojQ.png



b) Preview for Type “Search” and click “Proceed”.


PY7OjBQzLvboArBGn42Bm_nPQUMxXFV8og.png



2. Report Filter is applied to the selected Dashboard in kibana and preview of type PNG looks as shown below:


0E5tIwE6s5BdTQn6zaH8nkxW9vvCdr9u2g.png