Skedler A Report Scheduler for Kibana

Size: px

Start display at page:

Download "Skedler A Report Scheduler for Kibana"

Jonathan Curtis
5 years ago
Views:

2 Table of Contents 1 Introduction Skedler Concepts Access skedler Configure Schedule Reports Schedule Report based on Dashboard Preview Dashboard Report Schedule Report based on Search Preview Search Report Notification Grid View Set up Filters Set up Filter lists Set up Filters Preview Dashboards with Filters Feedback...44 Copyright 2016 Guidanz Inc. 2

3 1 Introduction Skedler is easy to use report scheduling and distribution application for Kibana that will allow 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. Managers and stakeholders appreciate the convenience of Kibana reports delivered automatically to their inbox, as they can open and read at their convenience either from mobile or desktop clients. Report Scheduler saves money for IT departments, both capital and operational expenses, by eliminating redundant reporting systems for Elasticsearch since you can now drive both analysis and reporting from the Kibana Platform. This document provides information on configuring reports using the Report Scheduler for Kibana 4 releases. For information regarding installing Report Scheduler for Kibana 4, please refer to the Skedler Installation Guide. 2 Skedler Concepts A 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 Copyright 2016 Guidanz Inc. 3

4 Name 2. Kibana Dashboard/ Search Mandatory for the scheduled report The kibana dashboard/search forms the basis of the scheduled report. Skedler will automatically discover all the existing kibana dashboards/search for you. You just 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 5. Filter (Report Recipients Optional Optional A report filter is a dynamic elasticsearch query filter that will be applied to a dashboard to create the report. It is the same query that you would use in Kibana for filters. An example is zip: AND city: Fremont The targeted addresses who would receive the report corresponding to a specific filter. 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 path is set in Filter -> Folder Path, the reports are stored in the specified path(filter level) else if path is Copyright 2016 Guidanz Inc. 4

5 set in Schedule Report -> Folder Path, then 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 addresses that will receive the scheduled report. addresses are separated by a comma. 8. Parameters Optional You can set parameters in Subject and Message. An example is you can select the parameter name Dashboard Url and copy paste the parameter ${{DashboardUrl}} in the required place. 9. Subject Optional Subject for the which has the report as an attachment 10. Message Optional An introductory message for the which has the report as an attachment 11. Schedule Optional An hourly, daily, weekly, monthly, or yearly schedule when the reports should be generated and sent. 12. Report Time Window Optional a) Dashboard Time Window - If you have saved your dashboard with Store time with dashboard in kibana then you can get the scheduled report with Copyright 2016 Guidanz Inc. 5

6 the stored time. 13. Report Layout / Filter Layout Optional b) Time Window - To generate a report for a specific time window. Based on the report type except Excel we can configure the options available in Report Layout. Font Family: You can select the type of font in which the report need to be generated. Paper Size: If the report type is PDF, you can configure the report paper size with the following options a) Set the Paper or sheet size example Letter, legal, A4, A3, Tabloid or Default size with Height: 1024 and Width: 2048 in pixel b) Choose Page orientation or layout (portrait or landscape) 14. Report Logo Optional The logo can be set for your generated PDF report. a) Default Logo: You can upload default logo common to all your PDF report from Other Settings in Configuration page. b) Custom Logo: You can also set custom logo when you schedule a Copyright 2016 Guidanz Inc. 6

7 report by uploading logo in logo field. 3 Access skedler After installation, skedler can be accessed from the following URL if the skedler is using the port 3000: 4 Configure 1. When you login for the first time, you would see the 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 id of the sender in the Sender s ID field (this is the d 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 o Enter the id of the sender in the Sender s ID field (this is the d id from which all the reports are sent) to configure the outgoing mail settings. Enter the password in the Password field. Amazon SES Service o Enter the id of the sender in the Sender s ID field (this is the d id from which all the reports are sent) to configure the outgoing mail settings o Enter the username in the Username field. o Enter the password in the Password field. Copyright 2016 Guidanz Inc. 7

8 5. Enter the "Admin " field to which a warning message will be sent if the reports 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. Copyright 2016 Guidanz Inc. 8

10 5 Schedule Reports To schedule your reports click the Schedule Report button. Reports can be scheduled for Dashboard as mentioned in Schedule Report based on Dashboard and Search as mentioned in Schedule Report based on Search. 6 Schedule Report based on Dashboard 1. Fill the fields with the appropriate value to generate the report. a) Report Details 1. A Scheduled Report Name of your choice 2. Select the type Dashboard 3. Choose a Dashboard that would be used to generate reports 4. 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 setting is disabled report type will be PDF or PNG) Copyright 2016 Guidanz Inc. 10

11 6. Optionally, you can disable excel report. By default excel report is enabled, if the report 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. Copyright 2016 Guidanz Inc. 11

12 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 to be generated. 11. Optionally, If your Dashboard is saved with Store time with dashboard in kibana then Use dashboard time window is enabled by default. This will schedule report for the stored time. If Use dashboard time window is unchecked, Time Window is enabled which allows generating report for a specific time window. Click Next once the mandatory fields are filled. Copyright 2016 Guidanz Inc. 12

13 d) Details You can generate reports using Generate now when your setting switch is off in configuration page. You can also schedule the for you report if setting switch is on in configuration page as mentioned in Configure section. 12. Optionally, you can merge parameter names in Subject and Message for the Copyright 2016 Guidanz Inc. 13

14 with the generated report 13. Optionally, type in a Subject for the with the generated report 14. Optionally, type in an introductory message for the with the generated report 15. Enter the addresses for the To field (as in s) 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 recipients corresponding to a filter. 17. Optionally, enter the addresses for the CC field (as in s) 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 the scheduled report. 2. Once the report is scheduled, you can see the scheduled report for the dashboard in details as follows. Copyright 2016 Guidanz Inc. 14

6. To pause the scheduled reports. Click Pause icon.

19 To resume the scheduled report, click on Resume icon Note: For Hourly reports, the reports will start generating from the given start time. If needed to generate from next hour please update the start time. Copyright 2016 Guidanz Inc. 19

20 6.1 Preview Dashboard Report To preview the dashboard. Click Preview icon. Select the 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 point 13 and 14 in Skedler Concepts can be selected and click Preview button to preview the report. Optionally, you can also Mail the report by specifying the address in Mail To field. If the dashboard is saved with Store time with dashboard option in kibana, then the dashboard can be previewed with the stored time by selecting dashboard time window. Optionally, If Use dashboard time window is unchecked, Time Window is enabled which allows generating report for a specific time window. Copyright 2016 Guidanz Inc. 20

22 a) Report Details 1. A Scheduled Report Name of your choice 2. Select the type Search 3. Choose a Search that would be used to generate reports 4. 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 Excel 6. Optionally, you can disable excel report. By default excel report is enabled, if the report type is PDF 7. 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 option to 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. Copyright 2016 Guidanz Inc. 22

23 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 to be generated. 11. Time Window allows generating report for a specific time window. Click Next once the mandatory fields are filled. Copyright 2016 Guidanz Inc. 23

24 d) Details You can generate reports using Generate now when your setting switch is off in configuration page. You can also schedule the for you report if setting switch is on in configuration page as mentioned in Configure section. 12. Optionally, you can merge parameter names in Subject and Message for the with the generated report 13. Optionally, type in a Subject for the with the generated report 14. Optionally, type in an introductory message for the with the generated report 15. Enter the addresses for the To field (as in s) 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 recipients corresponding to a filter. 17. Optionally, enter the addresses for the CC field (as in s) 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 the scheduled report. 2. Once the report is scheduled, you can see the scheduled report for search in details as follows. Copyright 2016 Guidanz Inc. 24

6. To pause the scheduled search report.

When you pause a scheduled report, the reports

29 To resume the scheduled search report, click Resume icon Note: For Hourly reports, the reports will start generating from the given start time. If needed to generate from next hour please update the start time. Copyright 2016 Guidanz Inc. 29

30 7.1 Preview Search Report To preview the dashboard. Click Preview icon. Select the preview type along with the preview time window (hourly, daily, weekly, monthly, yearly) and, based on the preview type the Filter Layout options as mentioned in point 13 and 14 in Skedler Concepts can be selected and click Preview button to preview the report. Optionally, you can also Mail the report by specifying the address in Mail To field. Time Window allows generating report for a specific time window. Copyright 2016 Guidanz Inc. 30

31 8 Notification Skedler notifications let you know the following so that you can keep track of the failure reports. The notification gets added to the notification list. Click Notification icon to view the notification list. a) When elasticsearch cluster is down. Copyright 2016 Guidanz Inc. 31

9 Grid View To change the view to a grid.

34 10 Set up Filters Setting up Filters is optional. 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. Then you can apply a dynamic filter CustomerID: 1001 to the Kibana dashboard to view the web traffic for CustomerID 1001 and it 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 Set up Filter lists A filter list is a collection of filters. An example is a list of pre-defined filters based on CustomerID and custom recipients for each filter. 1. To create filter list click Add New Filter List button. Copyright 2016 Guidanz Inc. 34

35 2. Fill the field with the filter list name of your choice and click Create button to create a filter list with zero filters (you can add filters later) or you can upload excel file using Upload Filters from Excel and click Create button to create the filter list. i. A sample Excel file format with filters, recipients and folder is given below. The recipients could be individual addresses or mailing lists. Also, can be left empty. Copyright 2016 Guidanz Inc. 35

38 10.2 Set up Filters 1. 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 Copyright 2016 Guidanz Inc. 38

39 a) You can Add or Overwrite the report filters using Upload Report Filters from Excel 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. Copyright 2016 Guidanz Inc. 39

42 10.3 Preview Reports with Filters Report Filters can be applied to any Kibana dashboards you created in your Kibana installation. If the filters are relevant for that Kibana dashboard, a dashboard with the filtered data will be displayed. 1. Click Preview icon. 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 point 13 and 14 in Skedler Concepts can be selected and click Proceed button. If the dashboard is saved with Store time with dashboard option in kibana, then the dashboard can be previewed with the stored time by selecting dashboard time window. Copyright 2016 Guidanz Inc. 42

a) Preview for Type Dashboard and click Proceed b) Preview

44 2. Report Filter is applied to the selected Dashboard in kibana and preview of type PNG looks as shown below: 11 Feedback We welcome and appreciate your feedback regarding the skedler. Please us at with your feedback. Copyright 2016 Guidanz Inc. 44

Barracuda NextGen Report Creator

Barracuda NextGen Report Creator The creates customized reports using statistics and logs collected on Barracuda NextGen F-Series Firewalls. Each report can be configured to use multiple appliances, custom or predefined report data templates,