Checkmk Conference #6 goes digital. Get your tickets here!
1. Customising dashboards
A dashboard combines various contents such as views, history graphs and other elements on a single page. What makes Checkmk’s dashboards special is that with the aid of an intelligent algorithm they can adapt themselves automatically to the user’s screen dimensions. In this way a user with a large screen can make optimal use of the screen’s area, but the dashboard can still function on a small screen. Here is an example of a Start Dashboard:
Besides this Main Overview-dashboard, Checkmk has the built-in variants Host & Services Problems and Network Topology. You find them in the sidebar under Views ➳ Overview. By default, the built-in dashboards are shared with all user roles. But you can also restrict them to certain roles under WATO ➳ Roles & Permissions ➳ Dashboards.
Checkmk includes a dashboard editor. The editing mode is accessed by clicking -- if you have the appriopiate access rights – on the gearwheel symbol (below right on the screen) and choosing Edit Dashboard in the menu that opens.
In the above image you can also see the layout mechanisms that exactly adjust the sizes of the elements to fit the available screen space:
- The element below right is anchored there and extends in both directions (indicated by the yellow arrows). That means it attempts to fill the available space.
- The element above right is anchored there, and has a fixed-height so that it remains graphically-justified to both globe elements (these cannot be altered). This element extends to the left (yellow arrow) in order to fill the available space.
- The lower left element is anchored at its top left to the globe element. It extends to the right (yellow arrow) and down (red arrow) to fill the available space.
1.1. Adding an element
Click on the gearwheel symbol and then select Add dashlet ➳ Static text:
The configuration dialogue for the new element will open:
This dialogue contains three sections:
- General Settings: This field is the same for all element types.
- Properties: The chosen element’s specific characteristics.
- Context/Search Filters: Filter for all element types.
A static text displays a default text to the user. This text can be changed via the text entry field in the element’s properties. Saving the element will take you to the dashboard.
The following symbols are displayed in edit mode:
|Delete this element.|
|Open the editing dialogue for this element.|
|The element is currently anchored to this corner of the dashboard|
|Click here to select this corner as the anchor point|
1.2. Adding elements via context menus
The reverse direction is also possible: With every view and graph there is a context menu via which you can add an element to the dashboard. Here is a history graph for example:
Clicking on the highlighted button opens the following selection menu:
1.3. How a dashboard adjusts itself to fit a screen
Dashboards have the unusual ability to dynamically-adjust themselves to diverse screen dimensions. The basic idea is that alongside elements with fixed dimensions, (such as e.g., Host Statistics and Service Statistics in the Main Overview dashboard), there are also those that can benefit from having more space. These dynamic elements scale themselves to make optimum use of the available space.
In order to simplify operation, a dashboard is generated as a raster composed of 10 x 10 pixel units. These units determine the dimensions of all elements:
- Pages with yellow arrows are initially created with size 1.
- Pages with red arrows are created by default with the maximum size.
- Pages with a fixed size (those with white bars) are positioned including the bars.
- All elements with yellow arrows then scale iuniformly in sync until they meet each other.
This procedure occurs not only on starting, but also whenever the browser window or its zoom setting is altered.
Use the mouse to interactively edit the elements’ sizes, positions and dimensions:
- Move the cursor on the element’s margin to alter its size.
- Press and hold the mouse button and drag the element to the desired position.
- In every corner there is an an anchor element . Only one anchor can be active . In the standard installation the active anchor is at top left.
- Indicators show active and inactive anchors. These indicators show the element’s size mode: grey (fixed size), yellow (element grows automatically), red (maximum size).
2. Creating a new Dashboard
To create a new dashboard, in the Views element click on EDIT in the sidebar. This will open a list of views. Proceed from here with the Dashboards button.
There click on the New button ...
... and you will be forwareded to ithe Select specific object type page:
You will generally not make any selections here, but proceed by clicking on Continue. You will thereby create a global dashboard without any specific context (e.g., a host).
In the subsequent window you can specify the basic characteristics such as name, title, etc. If this new dashboard is to be displayed with existing ones, then enter Overview in the topic field. On saving you will be taken to the dashboard list.
3. Making dashboards available for other users
If you have the access rights for publishing dashboards then you can also determine who else can access your dashboards.
To enable this open the dashboard’s configuration dialogue and activate the Make this dashboard available for other users option. Here you can either share the dashboard with all users (Publish to all users), or only with members of certain contact groups (Publish to members of contact groups).
4. Specifying a Start Dashboard
You can specify any existing dashboard as the Start URL when Checkmk opens. To do this, open the dialogue via WATO ➳ Global settings ➳ User interface. Click on the Start-URL to display in mainframe link. Substitute the existing content dashboard.py for the desired dashboard name prod like this: dashboard.py?name=prod. Complete this procedure by clicking on Save. The next time you start Checkmk this specified dashboard will be displayed.
Via the Personal settings section in the user setup you can define an individual start dashboard for every user.