skedler areportschedulerfor kibana userguide dashboard to view the web traffic for customerid 1001...

Copyright © 2016 Guidanz Inc. 1

Skedler – A Report Scheduler forKibana

User Guide


Table of Contents

1 Introduction................................................................................................................... 3

2 Skedler Concepts...........................................................................................................3

3 Access skedler............................................................................................................... 7

4 Configure Email............................................................................................................ 7

5 Schedule Reports.........................................................................................................10

6 Schedule Report based on Dashboard..................................................................... 10

6.1 Preview Dashboard Report.............................................................................20

7 Schedule Report based on Search............................................................................21

7.1 Preview Search Report ................................................................................. 30

8 Notification..................................................................................................................31

9 Grid View.................................................................................................................... 33

10 Set up Filters................................................................................................................34

10.1 Set up Filter lists...................................................................................................34

10.2 Set up Filters.........................................................................................................38

10.3 Preview Dashboards with Filters..........................................................................42

11 Feedback......................................................................................................................44


1 IntroductionSkedler is easy to use report scheduling and distribution application for Kibana that willallow you to centrally schedule and distribute Kibana Dashboards as hourly, daily,weekly, and monthly PDF reports to customers, managers, and other stakeholders.

Skedler allows you to send the right information to recipients at the right time. Managersand stakeholders appreciate the convenience of Kibana reports delivered automatically totheir email inbox , as they can open and read at their convenience either from mobile ordesktop email clients. Report Scheduler saves money for IT departments, both capital andoperational expenses, by eliminating redundant reporting systems for Elasticsearch sinceyou can now drive both analysis and reporting from the Kibana Platform.

This document provides information on configuring reports using the Report Schedulerfor Kibana 4 releases. For information regarding installing Report Scheduler for Kibana 4,please refer to the Skedler Installation Guide.

2 Skedler ConceptsA Kibana dashboard can be scheduled as a report

S.No Name Mandatory/Optional

Description

1. Scheduled Report Mandatory An easy to understand name used to define


Name for the scheduled report

2. Kibana Dashboard/Search

Mandatory The kibana dashboard/search forms thebasis of the scheduled report. Skedler willautomatically discover all the existingkibana dashboards/search for you. You justneed to select one dashboard/search foryour report.

3. Filter List Optional A filter list is a collection of dynamicqueries and recipients that can be appliedto a dashboard to create a report.

4. Filter List ( ReportFilter

Optional A report filter is a dynamic elasticsearchquery filter that will be applied to adashboard to create the report. It is thesame query that you would use in Kibanafor filters. An example is zip:”94538”AND city:”Fremont”

5. Filter (ReportRecipients

Optional The targeted email addresses who wouldreceive the report corresponding to aspecific filter. Email addresses areseparated by a comma.

6. Filter (Folder Path Optional Folder Path can be set for storing thescheduled reports at different levels.

Hierarchy of folder path for storingscheduled report. If path is set in Filter ->Folder Path , the reports are stored in thespecified path(filter level) else if path is


set in Schedule Report -> Folder Path, thenreports are stored in that folder (reportslevel) else if-if path is set in configurationfile reporting.yml then the scheduledreports are stored in this folder , if nowherefolder is specified reports will be stored inskedler home folder at skedler/reportsdirectory

7. To and CC Optional The email addresses that will receive thescheduled report. Email addresses areseparated by a comma.

8. Parameters Optional You can set parameters in Subject andMessage. An example is you can select theparameter name Dashboard Url and copypaste the parameter “${{DashboardUrl}}”in the required place.

9. Subject Optional Subject for the email which has the reportas an attachment

10. Message Optional An introductory message for the emailwhich has the report as an attachment

11. Schedule Optional An hourly, daily, weekly, monthly, oryearly schedule when the reports should begenerated and sent.

12. Report TimeWindow

Optional a) Dashboard Time Window - If youhave saved your dashboard with “Storetime with dashboard” in kibana thenyou can get the scheduled report with


the stored time.

b) Time Window - To generate a reportfor a specific time window.

13. Report Layout /Filter Layout

Optional Based on the report type except Excel wecan configure the options available inReport Layout.Font Family: You can select the type offont in which the report need to begenerated.Paper Size: If the report type is “PDF”,you can configure the report paper sizewith the following options

a) Set the Paper or sheet size exampleLetter, legal, A4, A3, Tabloid orDefault size with Height: 1024 andWidth: 2048 in pixel

b) Choose Page orientation or layout(portrait or landscape)

14. Report Logo Optional The logo can be set for your generatedPDF report.

a) Default Logo: You can upload defaultlogo common to all your PDF reportfrom “Other Settings” inConfiguration page.

b) Custom Logo: You can also setcustom logo when you schedule a


report by uploading logo in logo field.

3 Access skedlerAfter installation, skedler can be accessed from the following URL if the skedler is using

the port 3000: http://<yourserver>:3000

4 Configure Email1. When you login for the first time, you would see the Email Configuration page.2. If you do not require your reports to be mailed, you can disable your mail settings

using switch “off”.3. If you require reports to be mailed, switch “on”. 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.

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

Gmail Service

o Enter the email id of the sender in the Sender’s Email ID field (this is theemaild id from which all the reports are sent) to configure the outgoingmail settings.

o Enter the password in the Password field.

Amazon SES Serviceo 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 outgoingmail settings

o Enter the username in the Username field.o Enter the password in the Password field.


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

6. Click “Save” button to save the configuration details.

7. Update time zone for scheduling your report using “TimeZone Setting” and click“Save”.


8. Optionally, You can upload default logo for your generated PDF report by uploadingimage using “Select image” and click “Save”. To reset image click “Reset”.


5 Schedule ReportsTo schedule your reports click the “Schedule Report” button.

Reports can be scheduled for Dashboard as mentioned in Schedule Report based onDashboard and Search as mentioned in Schedule Report based on Search.

6 Schedule Report based on Dashboard1. Fill the fields with the appropriate value to generate the report.

a) Report Details

1. A Scheduled Report Name of your choice2. Select the type Dashboard3. Choose a Dashboard that would be used to generate reports4. Choose a Filter, by default “No filter” option is selected. You can setup filter as

mention in Setup filter section and configure the filter for the scheduled reports.5. Choose the report type - PDF, PNG - Inline, PNG - Attachment or Excel. (when

email setting is disabled report type will be PDF or PNG)


6. Optionally, you can disable excel report. By default excel report is enabled, if thereport type is PDF, PNG - Inline, PNG - Attachment.

7. Optionally, you can set the Folder location for storing your scheduled reports.

Click “Next” once the mandatory fields are filled.

b) Layout Details

8. Set report title for your generated PDF report.9. Optionally, you can set the Report Layout based on the report type as mentioned

in point 13 and 14 in Skedler Concepts.Click “Next” once the mandatory fields are filled.


c) Schedule Details

10. Set up the schedule for the report by selecting the Frequency type Hourly, Daily,Weekly, Monthly, or Yearly with scheduled time and start time for the report tobe generated.

11. Optionally, If your Dashboard is saved with “Store time with dashboard” inkibana then “Use dashboard time window” is enabled by default. This willschedule report for the stored time. If “Use dashboard time window” is unchecked,“Time Window” is enabled which allows generating report for a specific timewindow.



d) Email Details

You can generate reports using “Generate now” when your email setting switch is“off” in email configuration page.You can also schedule the email for you report if email setting switch is “on” inconfiguration page as mentioned in Configure Email section.12. Optionally, you can merge parameter names in Subject and Message for the


email with the generated report13. Optionally, type in a Subject for the email with the generated report14. Optionally, type in an introductory message for the email with the generated

report15. Enter the email addresses for the To field (as in emails)16. Optionally, once the filters are setup as mention in Set up Filters section, check

the “Include Recipients in Filter” to send the generated reports to the recipientscorresponding to a filter.

17. Optionally, enter the email addresses for the CC field (as in emails)18. If you would like to send a copy of the report instantly, click on “Mail Now”.

After adding the schedule details for the report click “Save” button to save thescheduled report.

2. Once the report is scheduled, you can see the scheduled report for the dashboard indetails as follows.


3. To edit the scheduled report. Click “Edit” icon.

4. To delete the scheduled reports. Click “X” icon.


5. To clone the existing scheduled report. Click “Clone” icon. Schedule the reportname and click “clone” button.


6. To pause the scheduled reports. Click “Pause” icon. When you pause a scheduledreport, the reports will no longer be generated/emailed until resumed.


To resume the scheduled report, click on “Resume” icon

Note: For Hourly reports, the reports will start generating from the given start time. Ifneeded to generate from next hour please update the start time.


6.1 Preview Dashboard ReportTo preview the dashboard. Click “Preview” icon. Select the preview type along with thepreview time window (hourly, daily, weekly, monthly, yearly or dashboard time window)and , based on the preview type the Filter Layout options as mentioned in point 13 and 14in Skedler Concepts can be selected and click “Preview” button to preview the report.Optionally, you can also Mail the report by specifying the email address in “Mail To”field.

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

Optionally, If “Use dashboard time window” is unchecked, “Time Window” is enabledwhich allows generating report for a specific time window.


7 Schedule Report based on Search1. Fill the fields with the appropriate value to generate the report.


a) Report Details

1. A Scheduled Report Name of your choice2. Select the type Search3. Choose a Search that would be used to generate reports4. Choose a Filter, by default “No filter” option is selected. You can setup filter as

mention in Setup filter section and configure the filter for the scheduled reports.5. Choose the report type PDF or Excel6. Optionally, you can disable excel report. By default excel report is enabled, if the

report type is PDF7. Optionally, you can set the Folder location for storing your scheduled reports.

Note: As Search cannot be stored with time in kibana , skedler do not have the optionto schedule report with “Use dashboard time window”.Click “Next” once the mandatory fields are filled.

b) Layout Details

8. Set report title for your generated report.9. Optionally, you can set the Report Layout based on the report type as mentioned

in point 13 and 14 in Skedler Concepts.Click “Next” once the mandatory fields are filled.


c) Schedule Details

10. Set up the schedule for the report by selecting the Frequency type Hourly, Daily,Weekly, Monthly, or Yearly with scheduled time and start time for the report tobe generated.

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



d) Email Details

You can generate reports using “Generate now” when your email setting switch is“off” in email configuration page.You can also schedule the email for you report if email setting switch is “on” inconfiguration page as mentioned in Configure Email section.12. Optionally, you can merge parameter names in Subject and Message for the

email with the generated report13. Optionally, type in a Subject for the email with the generated report14. Optionally, type in an introductory message for the email with the generated

report15. Enter the email addresses for the To field (as in emails)16. Optionally, once the filters are setup as mention in Set up Filters section, check

the “Include Recipients in Filter” to send the generated reports to the recipientscorresponding to a filter.

17. Optionally, enter the email addresses for the CC field (as in emails)18. If you would like to send a copy of the report instantly, click “Mail Now”.

After adding the schedule details for the report click “Save” button to save thescheduled report.

2. Once the report is scheduled, you can see the scheduled report for search in details asfollows.


3. To edit the scheduled report. Click “Edit” icon.

4. To delete the scheduled reports. Click “Delete” icon.


5. To clone the existing scheduled report. Click “Clone” icon. Schedule the reportname and click “clone” button.


6. To pause the scheduled search report. Click “Pause” icon. When you pause ascheduled report, the reports will no longer be generated/emailed until resumed.


To resume the scheduled search report, click “Resume” icon

Note: For Hourly reports, the reports will start generating from the given start time. Ifneeded to generate from next hour please update the start time.


7.1 Preview Search ReportTo preview the dashboard. Click “Preview” icon. Select the preview type along with thepreview time window (hourly, daily, weekly, monthly, yearly) and , based on the previewtype the Filter Layout options as mentioned in point 13 and 14 in Skedler Concepts canbe selected and click “Preview” button to preview the report. Optionally, you can alsoMail the report by specifying the email address in “Mail To” field.

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


8 NotificationSkedler notifications let you know the following so that you can keep track of the failurereports. The notification gets added to the notification list. Click “Notification” icon toview the notification list.

a) When elasticsearch cluster is down.


b) When there is a failure in sending mail for the scheduled report.

c) When there is a failure in a generating report.


9 Grid ViewTo change the view to a grid. Click “Grid” icon in Scheduler home page.


10 Set up FiltersSetting up Filters is optional. Filters are used to generate and send custom reports basedon a single dashboard. For example, you can create a generic Kibana dashboard todisplay the Web traffic

for all your customers. Then you can apply a dynamic filter CustomerID:”1001” to theKibana dashboard to view the web traffic for CustomerID 1001 and email it only to thatcustomer. You can reuse the filter on other Kibana Dashboards. For example, you canapply the same filter to the Sales Dashboard to view the sales information for a specificcustomer.

10.1 Set up Filter listsA filter list is a collection of filters. An example is a list of pre-defined filters based onCustomerID and custom email recipients for each filter.

1. To create filter list click “Add New Filter List” button.


2. Fill the field with the filter list name of your choice and click “Create” button tocreate a filter list with zero filters (you can add filters later) or you can upload excelfile using “Upload Filters from Excel” and click “Create” button to create the filterlist.

i. A sample Excel file format with filters, recipients and folder is given below.The recipients could be individual email addresses or email mailing lists.Also, can be left empty.


3. To edit a filter list, click “Edit” icon.


4. To delete a filter list, click “Delete” icon.


10.2 Set up Filters1. To set up or edit Report filters click “Edit” icon in the Filter List.

2. Editing report filters can be done by uploading excel file or through UI


a) You can Add or Overwrite the report filters using “Upload Report Filters fromExcel” button. “Add” adds the uploaded report filters to the existing report filters.“Overwrite” replaces the existing filters with uploaded report filters. Click“Create” button to create the Report filter list.


b) Alternatively, you can add report filters through UI using “Add Report Filters”button and click “Save” icon to save the report filter.


3. To edit report filter. Click “Edit” icon.

4. To delete a report filter, click “X” icon.


10.3 Preview Reports with FiltersReport Filters can be applied to any Kibana dashboards you created in your Kibanainstallation. If the filters are relevant for that Kibana dashboard, a dashboard with thefiltered data will be displayed.

1. Click “Preview” icon. Select on the type, based on the type Skedler automaticallydiscover all the existing kibana dashboards/searches for you. Select thedashboard/search and preview type along with the preview time window (hourly,daily, weekly, monthly, yearly or dashboard time window) and based on the previewtype the Filter Layout options as mentioned in point 13 and 14 in Skedler Conceptscan be selected and click “Proceed” button.

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


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

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


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

11 FeedbackWe welcome and appreciate your feedback regarding the skedler. Please email us [email protected] with your feedback.

mailto:[email protected]

skedler areportschedulerfor kibana userguide dashboard to view the web traffic for customerid 1001...

Documents