Reports


1. Reports

In Check_MK, a report is a compilation of diverse elements – views, availability tables, graphs, text, logos, etc., into a printable PDF document.

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 as PDF button.

The ‘Export as PDF’ button is found in every view – when the ‘Check_MK Enterprise Edition’ is being used.

2. Report elements for the sidebar

A quick access of all reports, and The Report Scheduler is available via the report element in the side bar.

In this element three buttons can be found:

Change Timerange Changes the time range for instant reports.
Scheduler Opens the Report Scheduler.
Edit Opens a list of available reports.

3. Basic settings for reports

The basic settings for reports can be configured over WATO ➳ Global Settings ➳ Reporting.

4. Customising existing reports

As with views and dashboards, Check_MK-supplied reports cannot be changed – an existing report must be cloned, and the clone can then be customised as desired.

Starting with the Edit button in the side bar, a list of all available reports can be opened.

On the left side these symbols are ready to use for the editing:

Copy report
Open preview
Plan periodic reporting

4.1. Basic settings

Clicking on opens a window for editing the basic settings for the new report:

Enter the values for Title and Theme. If the report should be available for all users, activate Make this report available for all users, and if the report should not be available for selection in the side bar, select the Hide this report from the sidebar option.

Switch to the Report Properties section. Here values for font, page format, time and date settings, the report's layout and the file names for downloads can be defined.

In the following Context / Search Filters section search and filter values can be specified.

Once all values have been defined as required, continue with one of the three buttons:

Save Save the report
Save and go to elements Save the report, and proceed to the configuration of the report's elements
Save and go to Generate Save and immediately generate the report

After saving the new report will appear in the list.

When creating/customising your own reports you can make use of these functions:

Copy report
Delete report
Edit report definitions
Edit report contents
Display preview
Schedule periodic report

4.2. Report elements

Clicking on the symbol opens an overview of the selected report.

On the left side a preview of the report is shown. To the right the report's elements are listed. With the symbols these elements can be edited , copied , deleted and rearranged .

New elements can be included in a report via the Add content and Add page element buttons. These types can be selected:

Content Page Element
View Text lines
Table Border around the report
Heading Image
Paragraph Horizontal line
History graph
Text macro
Vertical interspacing

4.3. Adding 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.

On this page detailed settings such as position, file name and size are selected.

When all of the settings have been defined, complete this process by clicking on Save. This will return to the report overview in which the added image will be visible in the report's preview.

4.4. Changing a report's logo

Copy the desired company logo into the local/share/check_mk/reporting/images folder, and save it as the file logo_mk.png. The logo will with immediate effect begin to appear on all reports.

5. Creating new reports

The creation of a new report begins with the Edit button in the side bar element. Proceed with New ➳ Continue. Customise the values in the selection options General Properties, Report Properties and Context / Search Filters in the screen template according to your requirements.

The new report will be stored with a click on Save. How to quickly add elements to this report can learned below in the Adding views and history graphs to reports chapter.

6. Making reports available for other users

If you have the permission to publish reports, you can also define whether other users can access your reports. How to allow others access to a report: Click on the Edit button in the side bar. With the symbol open the edit dialogue for the desired report, and activate the Make this report available for all users option.

7. Adding views and history graphs to reports

When a view or a history graph is displayed, the action symbol will be found on the screen window's lower frame. Clicking on this symbol will open a menu with which the target report can be selected.

8. The Report Scheduler

The report scheduler is accessed by clicking on the Scheduler in the side bar. Click on New Entry to open the report selection. The Reports button opens the list of already existing reports.

On this page the desired report can be selected from the list, followed by Proceed.

In the General Options section, basic settings like report title, creation time, report time frame, recipient and email settings will be found. When these options have been completed, go to the Context / Search Filters section – here the report's links and search settings can be configured. Once all of the settings are complete, store the definition with Save. This will then take you to the list of scheduled reports.

In this list can be found information on the last time the report was created/dispatched, whether an error occurred, and when the next creation/dispatch is planned. Entries in the list can be managed with the five action symbols at the top of the list.

The symbols and their functions:

Edit report settings
Copy report settings
Cancel scheduled report
Send report immediately
Display report preview

Dispatched reports are not saved in the instance.