Report scheduling will allow you to centrally schedule and distribute Kibana Dashboards or Search as hourly, daily, weekly, and monthly PDF/Excel/CSV reports. The Kibana search forms the basis of the search scheduled report. Skedler will automatically discover all the existing Kibana searches for you. You just need to select one search for your report.
Note: For Skedler v3.2 and below refer How to schedule a report based on Kibana Search
- A successful configuration of Skedler settings. Refer How to configure email settings, timezone settings and default logo for reports
To schedule the report, click the Schedule Report button.
Enter the appropriate values in the fields to generate the report.
1. Enter the name of the report in the Scheduled Report Name field.
2. Select the type as Search.NOTE: If you have multiple Spaces configured in Kibana, select the spaces from the Select Space drop-down. The search list will be discovered based on the selected space.
3. Select the required search from the Select Search field.
4. Optionally, enter the Report Output Directory it allows to store the scheduled reports in the Skedler server. You can also customize your report output directory by adding the custom parameters. To display the list of custom parameters created type $ in the Report Output Directory field. By default the Include Basepath is enabled Skedler will take the base path configured in the Advanced settings page and the report will be generated in that location. You can also override by unchecking the Include Basepath.
5. Optionally, enter the Report Tags which helps you to search the report based on the tags.
1. Select the required report format from the Select Format drop-down. The available options are PDF or Excel or CSV.
2. Optionally, if you chose PDF reports, you can select the Include Report type option to attach Excel or CSV report. By default option "None" is selected.
3. Select the required template from the Select Template drop-down. By default, "No Template" is selected.
Note: Custom template can be configured only for a PDF report.
4. Enter the title of the report generated in the Report Title field.
5. Optionally, you can configure the Report Layout based on the report type.
Note: Layout Configuration is applicable only to PDF reports.
- Font Family: You can select the type of font in which the report needs to be generated.
- Paper size: If the report type is PDF, you can configure the paper size of the report as follows:
- Set the paper or sheet size as Letter, Legal, A4, A3, Tabloid or Default size (Height as 1024 pixel and width as 2048 pixel)\
- Select the Page orientation (Landscape or Portrait)
6. Optionally, you can set a logo for the PDF report to be generated. By default "No Logo" is selected. The logo options are as follows:
- Default Logo: In the Configuration page you can upload the default logo to the PDF reports from "Other Settings"(This applies to all reports).
- Custom Logo: You can set custom logo for a specific report by uploading logo in the Logo field.
1. Select the Time Window option to generate the report for a specific time window.
Note: Kibana does not allow you to save Search with time, hence you cannot schedule a search based report using the “Use dashboard time window” option.
2.Select a filter from the Select Filter drop-down. By default, the “No filter” option is selected.
Refer How to use filters with scheduled reports to setup and configure the filter for the scheduled reports.
Optionally you can enable Schedule Details section. If you would like to schedule the reports enable the Schedule Details section check box and specify the following details, If you don't want your report to be generated uncheck the Schedule Details section checkbox.
1. Set up 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.
Optionally you can enable Report Actions section. If the Email Setting option is set to “on” in the Email configuration settings page.
You can find the two action buttons Mail and Slack. Click the respective action button to configure the details for the reports. By default, the Mail action tab is displayed if the Email Setting option is set to “on” in the Email configuration settings page.
1. Enter the recipient email address in the Email To field.
2. To send a copy of the email, enter the email addresses in the Email CC field.
3. 3. To send a copy of the email privately, enter the recipient email address in the Email BCC field.
4. If the generated report has no date for the specified Time Window then the email will be sent to recipient entered in the Warning Email field.
5. To send the generated 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.
6. Enter the subject of the email in the Subject field.
7. Enter the message for the email in the Message field.
8. Select the parameter name from the Merge Parameter Name field. You can merge the Custom parameter names in the Subject and Message fields for the email with the generated report.
9. To send a copy of the report instantly, click the Mail Now button.
10. To save the scheduled report, click Save.
11. If the Email Setting option is set to "off" in the Email Configuration page, you can generate the reports using the Generate now option.
You can also schedule the slack for the report if the Slack Setting option is set to “on” in the Slack configuration settings page.
1. Click the Slack action button. The Slack action tab is displayed.
2. Enter the Channel name or the user name or the user id in the Send To field to which the reports have to be sent.
3. Enter the message for the email in the Message field.
4. Select the parameter name from the Merge Parameter Name field. You can merge the parameter names in the Message fields for the slack with the generated report.
5. Additional Information lets you send the parameter name to the Slack message. By default, the Additional Information option is enabled with the default parameters.
6. To send a copy of the report instantly, click the Send Slack button.
7. If the Setting Setting option is set of "off" in the Slack Configuration page, you can generate the reports using the Generate now option.
8. Once the action tab details are configured click the Save button.
When the report is scheduled, you can view the scheduled report for the Search in the dashboard.