1. What are reports?
In Checkmk, a report is a compilation of diverse elements — views, availability tables, graphs, text, logos, etc., into a printable PDF document.
You can use reports in the Checkmk Enterprise Editions.
1.1. Characteristics of reports
No external tool such as Jasper, DB, or similar is necessary.
The PDF file is cleanly rendered with vector graphics.
Reports can be managed using templates and by basing them on preformatted master copies.
The report scheduler can send reports periodically as required.
Instant reports can be produced using the Export > This view as PDF menu item.
2. The Reporting snapin in the sidebar
Via the Reporting snapin in the sidebar you get quick access to all reports and to the report scheduler.
There are three buttons in this snapin:
Change Timerange | Change the time range for instant reports |
Scheduler | Open the report scheduler |
Edit | Open a list of available reports |
3. Global defaults for reports
You configure the global defaults for reports via Setup > Global settings > Reporting.
4. Customizing existing reports
As with table views and dashboards, supplied standard reports cannot be changed – however an existing report can be cloned, and the clone can then be customised as desired.
You can get to the list of all available reports via Customize > Business reporting > Reports:
On the left side these icons are ready to use for the editing:
| Copy report |
| Open preview |
| Open the report scheduler |
4.1. Basic settings
Clicking the 
will clone the report and open a menu for editing the basic settings for the new report:
As a minimum, enter values for Unique ID and Title. If you want to make the report available for other users, enable the Make this report available for other users option. You can then share the report with all users or only with members of specific contact groups. If you do not want the report to be available for selection in the main navigation, use the Hide this report in the monitor menu option.
Switch to the Report Properties box. Here values for font, page format, time and date settings, the report’s layout and the file name for downloads can be defined.
In the final Context / Search Filters box, you have extensive filtering options as usual, from specific hosts, to individual Docker containers, to values from Oracle monitoring.
Once all values have been defined as required, continue with one of the items from the Report > Save this report and go to menu.
List of reports | Save configuration and go back to the report list |
Elements | Save configuration and go to report elements configuration |
Generate | Save configuration and generate report immediately |
After saving your report will be displayed in the list.
For editing your own reports you can use the following functions:
| Copy report |
| Delete report |
| Edit report settings |
| Edit report contents |
| Display preview |
| Open the report scheduler |
4.2. Report elements
Clicking 
opens an overview
of the selected report.
On the left side a preview of the report is shown, here for the report of Report of Host cloned.
To the right the report’s elements are listed.
These elements are edited with the icons 
, copied , deleted 
and reordered 
.
Tip: In the preview, you will see red lines and error messages instead of real data — because, of course, the report in the editor lacks context, here in this example, the specification of a host, which would only be revealed by calling the report from an appropriate view. If you want to see a usable preview, simply filter for a specific host in the report settings in the Context / Search Filters area in the meantime: this makes designing much easier:
Add new elements to the report using the Reports menu with the Add content and Add page element items. The latter are pure design elements for pages: Horizontal line, image, page border and a single line of text. You can display these elements on all or specific pages of your report.
You add the actual content via Add content — for example tables, graphs, tables of contents or texts (also via macros or HTTP). These contents appear one after the other and thus also determine the final length of the report.
4.3. Inserting an image
Images which are to be included in a report must be in the local/share/check_mk/reporting/images folder.
Click on the Add page element button, then select Embedded image as type, and finally Continue.
The following dialogs are used to define detail settings such as position, file name and size.
Once all of the settings have been defined, complete this process by clicking Save. This will return to the report overview in which the added image will be visible in the report’s preview.
4.4. Changing the report’s logo
Copy your company logo into the local/share/check_mk/reporting/images folder and save it as file logo_mk.png.
The logo will with immediate effect begin to appear on all reports.
5. Creating new reports
You create a new report on the Edit Reports page via Reports > Add report.
In the first step, you can set a filter and limit the report to a specific host or data source from the start, such as network interfaces, BI aggregates, sensors, and so on:
Usually you will be able to use the default No restrictions to specific objects.
After that, only what you already know comes up — further customization of the report is the same as in customizing existing reports shown above.
6. Inserting views and history graphs into reports
Now, if you want to include a history graph or view in one of your reports, simply call the view you want and filter on the results you want, if necessary. Then all you have to do is call up your report via the Export menu and you will end up directly in the PDF.
7. The report scheduler
You can use the report scheduler to automatically create and send existing reports. You can reach the scheduler on the Edit Reports page via Reports > Scheduler.
Create a new schedule with Add schedule, then select the report and click Continue.
In the General Options box you specify basic settings which can be defined, such as title, creation time, report time frame, recipient and so on:
Under Context / Search Filters you will then again find the usual filter options, depending on the report you have selected. Then save the report to return to the list of your scheduled reports.
In the list you will also find information on when the report was last generated/sent, whether an error occurred, when it will next be generated/sent, and more (slightly shortened here):
Entries in the list are managed using the five icons at the beginning of the list:
| Edit report settings |
| Copy report settings |
| Delete scheduled report |
| Create report |
| Display preview |
Note: Dispatched reports are not saved in the site.
8. Files and directories
| Path/file | Function |
|---|---|
| The customized and non-buitin reports are stored in the respective path of the owner of the report. |