You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/common/en/dashboards.asciidoc
+32-1Lines changed: 32 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,6 +62,7 @@ On the {CMK} start page you will see the [.guihint]#Main dashboard,# which can b
62
62
ifdef::onprem[]
63
63
{RE} and commercial editions each come with their own individual standard dashboards, so here is a look at the commercial editions variant first:
64
64
65
+
.The standard dashboard of a commercial edition with the host overview
65
66
image::dashboard_main_numbered.png[alt="The standard dashboard of the commercial editions with numbers for the detailed description."]
66
67
67
68
[cols="7,~,<.>~", options="header"]
@@ -85,12 +86,14 @@ If you move the mouse pointer over the graphs or the host symbols in the [.guihi
85
86
86
87
On {CRE}, however, the main dashboard on the start page is the [.guihint]#Problem Dashboard#, which can also be called up in the commercial editions via icon:icon_dashboard_problems[alt="Icon of the Problem dashboard."] and which, quite conventionally, shows unresolved problems and current events in the form of a list:
87
88
89
+
.The dashboard of the Open Source version showing service issues
88
90
image::dashboard_main_numbered_raw.png[alt="The {RE} standard dashboard with numbers for the detailed description."]
89
91
endif::[]
90
92
91
93
ifdef::saas[]
92
94
The main dashboard shows unresolved problems and current events in the form of a list:
93
95
96
+
.The standard dashboard of {CE}
94
97
image::dashboard_main_numbered_saas.png[alt="The standard dashboard with numbers for the detailed description."]
95
98
endif::[]
96
99
@@ -180,18 +183,21 @@ all with automatic height, the side ones also with automatic width
180
183
-- the dashlets at the top and bottom get the setting [.guihint]#max width#.
181
184
By default, the anchor is at the top left, but here the right dashlet gets the anchor at the top right and the bottom one at the bottom left.
182
185
186
+
.Manually positioned and scaled matrix dashlet
183
187
image::dashboard_layout_example_1.png[alt="A host matrix dashlet in the dashboard center."]
184
188
185
189
If you now move the host matrix dashlet further to the left and down, for example, the host overview dashlets on the left, right and bottom change
186
190
-- because they automatically grow from their anchors towards the central host matrix dashlet.
187
191
188
192
The top dashlet, on the other hand, remains as it is -- after all, it cannot grow downwards because the two side dashlets are anchored at the top.
189
193
194
+
.Dashlets with [.guihint]#auto width/height# adjust to fit automatically
190
195
image::dashboard_layout_example_2.png[alt="The host matrix dashlet, moved to the bottom left."]
191
196
192
197
If you now switch the lower dashlet from [.guihint]#max width# to [.guihint]#auto width# it no longer extends over the entire width
193
198
-- because the automatic height of the right dashlet is rendered before the automatic width of the lower dashlet.
194
199
200
+
.A question of hierarchy: The automatic height of the right-hand dashlets is set before the automatic widths of the bottom dashlets are set.
195
201
image::dashboard_layout_example_3.png[alt="The bottom dashlet with shortened width."]
196
202
197
203
If dashlets with automatic dimensions are competing for the same space, you can use the maximum setting to determine the winner, so to speak
@@ -206,12 +212,14 @@ The whole dynamic layout principle is easier to understand if you create such a
206
212
You will see the dashboard configuration automatically when you create a new dashboard,
207
213
later you can access it via the icons in the dashboard list ([.guihint]#Customize > Visualization > Dashboards#) or the [.guihint]#Dashboard > Properties# menu item in an open dashboard.
208
214
215
+
.Layout and configuration can be edited separately
209
216
image::dashboard_config_dashboard.png[alt="The 'Dashboard' menu with the 'Properties' entry selected.",width=60%]
210
217
211
218
The properties of the dashboard itself are trivial;
212
219
only metadata such as name, menu item or visibility are defined here, as well as context filters if required.
213
220
Context filters simply restrict dashboards and dashlets to certain hosts and/or services.
214
221
222
+
.Where and for whom is the dashboard visible?
215
223
image::dashboard_config_example_dashboard.png[alt="General properties of the dashboard."]
216
224
217
225
@@ -221,6 +229,7 @@ image::dashboard_config_example_dashboard.png[alt="General properties of the das
221
229
You will see the configuration of individual dashlets automatically when you add them to a dashboard;
222
230
later you can call them up directly via a dashlet's 'cogwheel' icon in the layout mode.
223
231
232
+
.Opening the Dashlet configuration menu
224
233
image::dashboard_config_dashlet.png[alt="The icon for calling up the properties of a dashlet.",width=60%]
225
234
226
235
The configuration of most dashlets is quite simple, as the dashlet with the host matrix from the screenshots above shows.
@@ -229,6 +238,7 @@ For all dashlets that refer to several or individual hosts and services, you wil
229
238
And finally, some dashlets offer options for the precise design of the visualization, for example via limit values.
230
239
As an example, here is the [.guihint]#Properties# box of the [.guihint]#Gauge# dashlet:
231
240
241
+
.The [.guihint]#Gauge# dashlets' features can be used to visualize a wide variety of data.
232
242
image::dashboard_config_example_dashlet.png[alt="Properties of the 'Gauge' dashlet."]
233
243
234
244
@@ -240,6 +250,7 @@ Even away from the dashboard and dashlet configuration, there are important sett
240
250
Under [.guihint]#Setup > Users > Roles & permissions > Edit role user# you can simply filter for `dashboard` to list all options.
241
251
Here for a xref:wato_user#roles[role] you can specify in detail which standard dashboards its assigned users can see and what exactly they are allowed to do with other dashboards.
242
252
253
+
.Dashboards may contain sensitive information -- not every user role needs all rights here
243
254
image::dashboard_config_permissions.png[alt="User role with the permissions for dashboards."]
244
255
endif::[]
245
256
@@ -261,6 +272,7 @@ and the [.guihint]#Scheduled downtimes# view lists xref:glossar#scheduled_downti
261
272
262
273
And this is what the finished dashboard will look like:
263
274
275
+
.A dashboard with four dashlets -- for CPU usage, file system, notification statistics, and scheduled maintenance times
264
276
image::dashboard_example_view.png[alt="The example dashboard created below."]
265
277
266
278
@@ -272,6 +284,7 @@ image::dashboard_example_view.png[alt="The example dashboard created below."]
272
284
First create a dashboard via [.guihint]#Customize > Visualization > Dashboards > Add dashboard#.
273
285
This will immediately take you to the first basic setting:
274
286
287
+
.This first filter determines which data will be available to the dashboard.
275
288
image::dashboard_example_1.png[alt="Selection of object types for the dashboard."]
276
289
277
290
With [.guihint]#Select specific object type# you can restrict the dashboard to certain hosts, services and even individual objects such as Docker images or fans.
@@ -280,6 +293,7 @@ You can still filter this later.
280
293
281
294
Then use [.guihint]#Continue# to access the properties of the dashboard to be created.
282
295
296
+
.This second filter option determines which data is displayed by default in the dashboard
283
297
image::dashboard_example_2.png[alt="General properties of the dashboard with the necessary input for ID and title."]
284
298
285
299
All that is required here is a name and title for the dashboard in the [.guihint]#General properties# box, here we have used `my_dashboard` and `My Dashboard`.
@@ -310,23 +324,27 @@ Since the root file system of the host `myhost` is to be visualized here, `My Ho
310
324
As with many input fields in {CMK}, this can be done more conveniently via macros: `$HOST_NAME$: $SERVICE_DESCRIPTION$`
311
325
Which macros you can use may be found in the help texts, which you can display with [.guihint]#Help > Show inline help#.
312
326
327
+
.An interesting line: [.guihint]#Show information of single ... hosts, service# provides information about available data
313
328
image::dashboard_example_3.png[alt="General settings of the 'Performance graph' dashlet."]
314
329
315
330
In the box for the context filters, enter the host name and the desired file system.
316
331
In both input fields you can simply enter the first letter and then scroll through the possible entries with the down arrow key.
317
332
333
+
.A third filtering option: Here, filtering is performed by host and/or service -- and it is determined which metric filters will be available in the next step.
318
334
image::dashboard_example_4.png[alt="Context filter of the 'Performance graph' dashlet."]
319
335
320
336
In the third box, [.guihint]#Properties#, the two filters are automatically adopted for the setting [.guihint]#Graph#.
321
337
You only have to select the desired graph, here [.guihint]#Size and used space#.
322
338
You can leave the other display options unaltered.
323
339
340
+
.The fourth filter option: A specific metric is selected from the host services that have already been filtered
324
341
image::dashboard_example_5.png[alt="Properties of the 'Performance graph' dashlet."]
325
342
326
343
If you now save the dashlet, you will arrive in layout mode.
327
344
Since the dashlet should run across the entire width, click [.guihint]#manual width#, to switch the manual width to [.guihint]#auto width#.
328
345
The anchor can remain in its default position at the top left.
329
346
347
+
.Manual, automatic, maximum extension -- trying these out helps you to understand their functions!
330
348
image::dashboard_example_6.png[alt="The 'Performance graph' dashlet in the layout mode of the dashboard."]
331
349
332
350
@@ -346,13 +364,15 @@ However, this time you have to define another setting, namely the maximum of the
346
364
Here select [.guihint]#Floating point number# and set the maximum to `10`.
347
365
Without this you will get an error message.
348
366
367
+
.This dashlet can also indicate service status -- useful for critical elements.
349
368
image::dashboard_example_7.png[alt="Properties of the 'Gauge' dashlet."]
350
369
351
370
After saving, you return to layout mode and can place the dashlet below the performance graph (which is initially overlaid by the new dashlet!).
352
371
Manual width and height can be used here.
353
372
You can determine the desired size by dragging the dashlet edges with the mouse.
354
373
At this point you could also set the graph dashlet to automatic height and then simply let the height be determined by the placement of the new gauge dashlet.
355
374
375
+
.Dashlets can be cloned directly in the layout mode -- handy for creating an initial overall layout
356
376
image::dashboard_example_8.png[alt="The 'Gauge' dashlet in the layout mode of the dashboard."]
357
377
358
378
@@ -368,15 +388,18 @@ Data from several hosts and services should now end up in this dashlet -- hence
368
388
To get all alerts from all hosts that start with `my`, set the host name filter to `^my`.
369
389
With this dashlet, it is often a good idea to dispense with filters completely in order to evaluate all hosts.
370
390
391
+
.Regular expressions enable the creation of graphs with precisely filtered metrics from multiple hosts
371
392
image::dashboard_example_9a.png[alt="Context filter of the 'Alert timeline' dashlet."]
372
393
373
394
For our example dashlet, the display [.guihint]#Bar chart# is kept, the time range is set to [.guihint]#The last 35 days#, and the resolution is set to whole days.
374
395
396
+
.Information such as a time period is also useful for descriptive dashlet titles
375
397
image::dashboard_example_9b.png[alt="Properties of the 'Alert timeline' dashlet."]
376
398
377
399
After saving, place the dashlet back on the dashboard.
378
400
Again an automatic width with manual height is a good way to fill the row with the [.guihint]#Gauge# dashlet.
379
401
402
+
.In this setup, [.guihint]#max width# would have the same effect in the Alert Dashlet
380
403
image::dashboard_example_9c.png[alt="The 'Alert timeline' dashlet in the layout mode of the dashboard."]
381
404
382
405
@@ -388,10 +411,12 @@ This works via [.guihint]#Add > Link to existing view#, but also via the views t
388
411
To add the xref:glossar#scheduled_downtime[scheduled downtimes] view, for example, call it up via [.guihint]#Monitor > Overview > Scheduled downtimes#.
389
412
Then add this view to your dashboard via [.guihint]#Export > Add to dashboard#
390
413
414
+
.All table displays in {CMK} can be exported to dashboards
391
415
image::dashboard_example_10.png[alt="The 'Export' menu of the 'Scheduled downtimes' view.",width=55%]
392
416
393
417
Select your dashboard.
394
418
419
+
.Dashboard selection by name/ID -- another incentive to use descriptive names
395
420
image::dashboard_example_10a.png[alt="Selection of the dashboard for the view."]
396
421
397
422
Place the dashlet as the last row.
@@ -402,6 +427,7 @@ If you now call up the icon:icon_dashlet_edit[alt="Icon for the properties."] da
402
427
403
428
With that, your example dashboard is ready, shown here again completely in layout mode:
404
429
430
+
.The exported [guihint]#Scheduled downtimes# view fills the rest of the dashboard
405
431
image::dashboard_example_11.png[alt="The complete example dashboard in layout mode."]
406
432
407
433
@@ -425,6 +451,7 @@ The [.guihint]#Required context filters# can also be found in the dashboard prop
425
451
They are only set as required filters.
426
452
A dashboard with such defaults appears in the dashboard view without information on hosts and services, but with the filter function open and the reference to this [.guihint]#Mandatory context#, which the user must set at runtime, so to speak.
427
453
454
+
.These filters must be filled in by viewers in the monitoring system itself
428
455
image::dashboard_example_mandatory.png[alt="Filter bar with mandatory context when opening the dashboard.",width=60%]
429
456
430
457
@@ -562,11 +589,13 @@ For your own dashboards, you can also create links to other dashboards by linkin
562
589
Let's take a concrete example:
563
590
Here you see a dashboard that shows information on the CPU, RAM and file systems of all hosts that start with `my`.
564
591
592
+
.Top-down dashboards are implemented via links, here in the graph’s title
565
593
image::dashboard_topdown1.png[alt="Example dashboard of all hosts starting with 'my'."]
566
594
567
595
In this example the title of the CPU graph links to another dashboard that visualizes the CPU information for each host individually.
568
596
In this dashboard, there is again a link at the top back to the overview, simply achieved using a [.guihint]#Static text# dashlet.
569
597
598
+
.The return path in the top-down dashboard is via manually-edited text links
570
599
image::dashboard_topdown2.png[alt="Link to return to the calling dashboard."]
571
600
572
601
With such cross-links, you can develop complex research tools via dashboards.
@@ -603,7 +632,8 @@ The solution to this problem is trivial
603
632
-- alter the service filter and the selected metric in the dashlet configuration.
604
633
Of course, this also applies to all other dashlet variants.
605
634
606
-
635
+
////
636
+
// ML: Den Fehler scheint es nicht mehr zu geben (Elemente bleiben einfach leer), es geht um Views, nicht Dashlets, die Namen haben sich geändert
607
637
ifdef::onprem[]
608
638
[#host_problems]
609
639
=== Empty dashlets: Total host/service problems
@@ -628,3 +658,4 @@ This ensures that the correct data is actually output.
You can now either edit an existing list with icon:icon_edit[alt="Icon for editing a list entry."] -- or create a new one with [.guihint]#Add list#:
378
381
382
+
.Adding a new bookmark
379
383
image::user_interface_new_bookmark_list_general_properties.png[alt="Dialog with properties when creating a bookmark list."]
380
384
381
385
In the [.guihint]#General properties# box you enter the internal ID and the title of the list -- whereby the [.guihint]#Title# is not important for the display of the bookmarks, it is only used for management.
@@ -389,6 +393,7 @@ The principle of visibility is used by {CMK} in many locations, and is explained
389
393
390
394
In the [.guihint]#Bookmarks# box you can now define the new bookmarks with a title and URL:
391
395
396
+
.Creating new bookmarks in the [.guihint]#Bookmarks#
392
397
image::user_interface_new_bookmark_list_bookmarks.png[alt="Dialog for setting the properties for the new bookmarks."]
393
398
394
399
Where the bookmarks are sorted is decided by the [.guihint]#Default Topic# in the list, or respectively by a bookmark’s [.guihint]#Individual Topic# -- if this has been set.
@@ -397,6 +402,7 @@ Finally, save the new list with [.guihint]#Save & view list#.
397
402
398
403
The new list created in this example now supplements the personal bookmarks under [.guihint]#My Bookmarks# for all users with three bookmarks on two new topics:
399
404
405
+
.Personal navigation via bookmarks
400
406
image::user_interface_bookmarks.png[alt="Bookmarks snap-in with the three newly created bookmarks.",width=50%]
0 commit comments