Skip to content

Commit 0986fdc

Browse files
bili123Mattias Schlenker
authored andcommitted
only-en qualiweeks pick-24 added captions
1 parent 890aed4 commit 0986fdc

File tree

6 files changed

+49
-5
lines changed

6 files changed

+49
-5
lines changed

src/common/en/dashboards.asciidoc

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ On the {CMK} start page you will see the [.guihint]#Main dashboard,# which can b
6262
ifdef::onprem[]
6363
{RE} and commercial editions each come with their own individual standard dashboards, so here is a look at the commercial editions variant first:
6464

65+
.The standard dashboard of a commercial edition with the host overview
6566
image::dashboard_main_numbered.png[alt="The standard dashboard of the commercial editions with numbers for the detailed description."]
6667

6768
[cols="7,~,<.>~", options="header"]
@@ -85,12 +86,14 @@ If you move the mouse pointer over the graphs or the host symbols in the [.guihi
8586

8687
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:
8788

89+
.The dashboard of the Open Source version showing service issues
8890
image::dashboard_main_numbered_raw.png[alt="The {RE} standard dashboard with numbers for the detailed description."]
8991
endif::[]
9092

9193
ifdef::saas[]
9294
The main dashboard shows unresolved problems and current events in the form of a list:
9395

96+
.The standard dashboard of {CE}
9497
image::dashboard_main_numbered_saas.png[alt="The standard dashboard with numbers for the detailed description."]
9598
endif::[]
9699

@@ -180,18 +183,21 @@ all with automatic height, the side ones also with automatic width
180183
-- the dashlets at the top and bottom get the setting [.guihint]#max width#.
181184
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.
182185

186+
.Manually positioned and scaled matrix dashlet
183187
image::dashboard_layout_example_1.png[alt="A host matrix dashlet in the dashboard center."]
184188

185189
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
186190
-- because they automatically grow from their anchors towards the central host matrix dashlet.
187191

188192
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.
189193

194+
.Dashlets with [.guihint]#auto width/height# adjust to fit automatically
190195
image::dashboard_layout_example_2.png[alt="The host matrix dashlet, moved to the bottom left."]
191196

192197
If you now switch the lower dashlet from [.guihint]#max width# to [.guihint]#auto width# it no longer extends over the entire width
193198
-- because the automatic height of the right dashlet is rendered before the automatic width of the lower dashlet.
194199

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.
195201
image::dashboard_layout_example_3.png[alt="The bottom dashlet with shortened width."]
196202

197203
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
206212
You will see the dashboard configuration automatically when you create a new dashboard,
207213
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.
208214

215+
.Layout and configuration can be edited separately
209216
image::dashboard_config_dashboard.png[alt="The 'Dashboard' menu with the 'Properties' entry selected.",width=60%]
210217

211218
The properties of the dashboard itself are trivial;
212219
only metadata such as name, menu item or visibility are defined here, as well as context filters if required.
213220
Context filters simply restrict dashboards and dashlets to certain hosts and/or services.
214221

222+
.Where and for whom is the dashboard visible?
215223
image::dashboard_config_example_dashboard.png[alt="General properties of the dashboard."]
216224

217225

@@ -221,6 +229,7 @@ image::dashboard_config_example_dashboard.png[alt="General properties of the das
221229
You will see the configuration of individual dashlets automatically when you add them to a dashboard;
222230
later you can call them up directly via a dashlet's 'cogwheel' icon in the layout mode.
223231

232+
.Opening the Dashlet configuration menu
224233
image::dashboard_config_dashlet.png[alt="The icon for calling up the properties of a dashlet.",width=60%]
225234

226235
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
229238
And finally, some dashlets offer options for the precise design of the visualization, for example via limit values.
230239
As an example, here is the [.guihint]#Properties# box of the [.guihint]#Gauge# dashlet:
231240

241+
.The [.guihint]#Gauge# dashlets' features can be used to visualize a wide variety of data.
232242
image::dashboard_config_example_dashlet.png[alt="Properties of the 'Gauge' dashlet."]
233243

234244

@@ -240,6 +250,7 @@ Even away from the dashboard and dashlet configuration, there are important sett
240250
Under [.guihint]#Setup > Users > Roles & permissions > Edit role user# you can simply filter for `dashboard` to list all options.
241251
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.
242252

253+
.Dashboards may contain sensitive information -- not every user role needs all rights here
243254
image::dashboard_config_permissions.png[alt="User role with the permissions for dashboards."]
244255
endif::[]
245256

@@ -261,6 +272,7 @@ and the [.guihint]#Scheduled downtimes# view lists xref:glossar#scheduled_downti
261272

262273
And this is what the finished dashboard will look like:
263274

275+
.A dashboard with four dashlets -- for CPU usage, file system, notification statistics, and scheduled maintenance times
264276
image::dashboard_example_view.png[alt="The example dashboard created below."]
265277

266278

@@ -272,6 +284,7 @@ image::dashboard_example_view.png[alt="The example dashboard created below."]
272284
First create a dashboard via [.guihint]#Customize > Visualization > Dashboards > Add dashboard#.
273285
This will immediately take you to the first basic setting:
274286

287+
.This first filter determines which data will be available to the dashboard.
275288
image::dashboard_example_1.png[alt="Selection of object types for the dashboard."]
276289

277290
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.
280293

281294
Then use [.guihint]#Continue# to access the properties of the dashboard to be created.
282295

296+
.This second filter option determines which data is displayed by default in the dashboard
283297
image::dashboard_example_2.png[alt="General properties of the dashboard with the necessary input for ID and title."]
284298

285299
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
310324
As with many input fields in {CMK}, this can be done more conveniently via macros: `$HOST_NAME$: $SERVICE_DESCRIPTION$`
311325
Which macros you can use may be found in the help texts, which you can display with [.guihint]#Help > Show inline help#.
312326

327+
.An interesting line: [.guihint]#Show information of single ... hosts, service# provides information about available data
313328
image::dashboard_example_3.png[alt="General settings of the 'Performance graph' dashlet."]
314329

315330
In the box for the context filters, enter the host name and the desired file system.
316331
In both input fields you can simply enter the first letter and then scroll through the possible entries with the down arrow key.
317332

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.
318334
image::dashboard_example_4.png[alt="Context filter of the 'Performance graph' dashlet."]
319335

320336
In the third box, [.guihint]#Properties#, the two filters are automatically adopted for the setting [.guihint]#Graph#.
321337
You only have to select the desired graph, here [.guihint]#Size and used space#.
322338
You can leave the other display options unaltered.
323339

340+
.The fourth filter option: A specific metric is selected from the host services that have already been filtered
324341
image::dashboard_example_5.png[alt="Properties of the 'Performance graph' dashlet."]
325342

326343
If you now save the dashlet, you will arrive in layout mode.
327344
Since the dashlet should run across the entire width, click [.guihint]#manual width#, to switch the manual width to [.guihint]#auto width#.
328345
The anchor can remain in its default position at the top left.
329346

347+
.Manual, automatic, maximum extension -- trying these out helps you to understand their functions!
330348
image::dashboard_example_6.png[alt="The 'Performance graph' dashlet in the layout mode of the dashboard."]
331349

332350

@@ -346,13 +364,15 @@ However, this time you have to define another setting, namely the maximum of the
346364
Here select [.guihint]#Floating point number# and set the maximum to `10`.
347365
Without this you will get an error message.
348366

367+
.This dashlet can also indicate service status -- useful for critical elements.
349368
image::dashboard_example_7.png[alt="Properties of the 'Gauge' dashlet."]
350369

351370
After saving, you return to layout mode and can place the dashlet below the performance graph (which is initially overlaid by the new dashlet!).
352371
Manual width and height can be used here.
353372
You can determine the desired size by dragging the dashlet edges with the mouse.
354373
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.
355374

375+
.Dashlets can be cloned directly in the layout mode -- handy for creating an initial overall layout
356376
image::dashboard_example_8.png[alt="The 'Gauge' dashlet in the layout mode of the dashboard."]
357377

358378

@@ -368,15 +388,18 @@ Data from several hosts and services should now end up in this dashlet -- hence
368388
To get all alerts from all hosts that start with `my`, set the host name filter to `^my`.
369389
With this dashlet, it is often a good idea to dispense with filters completely in order to evaluate all hosts.
370390

391+
.Regular expressions enable the creation of graphs with precisely filtered metrics from multiple hosts
371392
image::dashboard_example_9a.png[alt="Context filter of the 'Alert timeline' dashlet."]
372393

373394
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.
374395

396+
.Information such as a time period is also useful for descriptive dashlet titles
375397
image::dashboard_example_9b.png[alt="Properties of the 'Alert timeline' dashlet."]
376398

377399
After saving, place the dashlet back on the dashboard.
378400
Again an automatic width with manual height is a good way to fill the row with the [.guihint]#Gauge# dashlet.
379401

402+
.In this setup, [.guihint]#max width# would have the same effect in the Alert Dashlet
380403
image::dashboard_example_9c.png[alt="The 'Alert timeline' dashlet in the layout mode of the dashboard."]
381404

382405

@@ -388,10 +411,12 @@ This works via [.guihint]#Add > Link to existing view#, but also via the views t
388411
To add the xref:glossar#scheduled_downtime[scheduled downtimes] view, for example, call it up via [.guihint]#Monitor > Overview > Scheduled downtimes#.
389412
Then add this view to your dashboard via [.guihint]#Export > Add to dashboard#
390413

414+
.All table displays in {CMK} can be exported to dashboards
391415
image::dashboard_example_10.png[alt="The 'Export' menu of the 'Scheduled downtimes' view.",width=55%]
392416

393417
Select your dashboard.
394418

419+
.Dashboard selection by name/ID -- another incentive to use descriptive names
395420
image::dashboard_example_10a.png[alt="Selection of the dashboard for the view."]
396421

397422
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
402427

403428
With that, your example dashboard is ready, shown here again completely in layout mode:
404429

430+
.The exported [guihint]#Scheduled downtimes# view fills the rest of the dashboard
405431
image::dashboard_example_11.png[alt="The complete example dashboard in layout mode."]
406432

407433

@@ -425,6 +451,7 @@ The [.guihint]#Required context filters# can also be found in the dashboard prop
425451
They are only set as required filters.
426452
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.
427453

454+
.These filters must be filled in by viewers in the monitoring system itself
428455
image::dashboard_example_mandatory.png[alt="Filter bar with mandatory context when opening the dashboard.",width=60%]
429456

430457

@@ -562,11 +589,13 @@ For your own dashboards, you can also create links to other dashboards by linkin
562589
Let's take a concrete example:
563590
Here you see a dashboard that shows information on the CPU, RAM and file systems of all hosts that start with `my`.
564591

592+
.Top-down dashboards are implemented via links, here in the graph’s title
565593
image::dashboard_topdown1.png[alt="Example dashboard of all hosts starting with 'my'."]
566594

567595
In this example the title of the CPU graph links to another dashboard that visualizes the CPU information for each host individually.
568596
In this dashboard, there is again a link at the top back to the overview, simply achieved using a [.guihint]#Static text# dashlet.
569597

598+
.The return path in the top-down dashboard is via manually-edited text links
570599
image::dashboard_topdown2.png[alt="Link to return to the calling dashboard."]
571600

572601
With such cross-links, you can develop complex research tools via dashboards.
@@ -603,7 +632,8 @@ The solution to this problem is trivial
603632
-- alter the service filter and the selected metric in the dashlet configuration.
604633
Of course, this also applies to all other dashlet variants.
605634

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
607637
ifdef::onprem[]
608638
[#host_problems]
609639
=== Empty dashlets: Total host/service problems
@@ -628,3 +658,4 @@ This ensures that the correct data is actually output.
628658
The solution is simple:
629659
Create a new connection with the correct ID.
630660
endif::[]
661+
////

src/common/en/intro_gui.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,11 @@ locations on the {CMK} interface, such as in the [.guihint]#Overview# or here on
8787
right in the first line of the [.guihint]#Monitor# menu:
8888

8989
ifdef::onprem[]
90+
.Three points (...) are used to reduce complexity in {CMK}.
9091
image::intro_monitor_menu_showmore.png[alt="First line of the Monitor menu with search input field and Show more symbol."]
9192
endif::[]
9293
ifdef::saas[]
94+
.Three points (...) are used to reduce complexity in {CMK}.
9395
image::intro_monitor_menu_showmore_saas.png[alt="First line of the Monitor menu with search input field and Show more symbol."]
9496
endif::[]
9597

src/common/en/user_interface.asciidoc

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -153,10 +153,10 @@ endif::[]
153153
You can customize and extend elements of the graphical user interface that are useful for monitoring in the [.guihint]#Customize# menu:
154154

155155
ifdef::onprem[]
156-
.The [.guihint]#Customize# menu of {CE} in Show more mode
156+
.The [.guihint]#Customize# menu of {CE} in show more mode
157157
endif::[]
158158
ifdef::saas[]
159-
.The [.guihint]#Customize# menu in Show more mode
159+
.The [.guihint]#Customize# menu in show more mode
160160
endif::[]
161161
image::customize_menu_more.png[alt="Customize menu in the navigation bar.",width=65%]
162162

@@ -182,11 +182,11 @@ In some lists you will find _built-in_ objects delivered with {CMK} that you can
182182
Your entry point to the xref:wato#[configuration of {CMK}] is the [.guihint]#Setup# menu, which you can open via the navigation bar:
183183

184184
ifdef::onprem[]
185-
.The [.guihint]#Setup# menu of {RE} in Show less mode
185+
.The [.guihint]#Setup# menu of {RE} in show less mode
186186
image::setup_menu.png[alt="Setup menu in the navigation bar."]
187187
endif::[]
188188
ifdef::saas[]
189-
.The [.guihint]#Setup# menu in Show less mode
189+
.The [.guihint]#Setup# menu in show less mode
190190
image::setup_menu_saas.png[alt="Setup menu in the navigation bar."]
191191
endif::[]
192192

@@ -213,6 +213,7 @@ include::include_searching_in_the_configuration_environment.asciidoc[]
213213

214214
In the [.guihint]#User# menu you can change personal settings that are valid for your user account:
215215

216+
.Changing personal settings in the [.guihint]#User# menu
216217
ifdef::onprem[]
217218
image::user_menu.png[alt="User menu in the navigation bar.",width=65%]
218219
endif::[]
@@ -287,6 +288,7 @@ After logging in, you will first see the standard or main dashboard.
287288
The content of the main page changes depending on your selection in the navigation bar and also in the sidebar.
288289
For example, if you select [.guihint]#Hosts > All hosts# in the [.guihint]#Monitor# menu, the list of hosts will be displayed on the main page:
289290

291+
.Opening the host overview in the [.guihint]#Monitor# menu
290292
image::mainpage_all_hosts.png[alt="Main page with list of all hosts."]
291293

292294
Regardless of which page is currently displayed, you will usually find the following elements on the main page:
@@ -372,10 +374,12 @@ Every user can nonetheless still create and manage their own bookmarks.
372374

373375
With the [.guihint]#Bookmarks# snap-in you can access the management of the bookmark lists:
374376

377+
.Managing the bookmark list via the [guihint]#Bookmarks# snap-in
375378
image::user_interface_bookmark_lists.png[alt="Bookmark lists."]
376379

377380
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#:
378381

382+
.Adding a new bookmark
379383
image::user_interface_new_bookmark_list_general_properties.png[alt="Dialog with properties when creating a bookmark list."]
380384

381385
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
389393

390394
In the [.guihint]#Bookmarks# box you can now define the new bookmarks with a title and URL:
391395

396+
.Creating new bookmarks in the [.guihint]#Bookmarks#
392397
image::user_interface_new_bookmark_list_bookmarks.png[alt="Dialog for setting the properties for the new bookmarks."]
393398

394399
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#.
397402

398403
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:
399404

405+
.Personal navigation via bookmarks
400406
image::user_interface_bookmarks.png[alt="Bookmarks snap-in with the three newly created bookmarks.",width=50%]
401407

402408

src/includes/en/include_searching_in_the_configuration_environment.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,10 @@ You do not need to pay attention to upper and lower case.
1010
The search results are displayed as you type:
1111

1212
ifdef::onprem[]
13+
.Free text search in the configuration environment
1314
image::gui_setup_menu_search.png[alt="Setup menu with search results.", width=65%]
1415
endif::[]
1516
ifdef::saas[]
17+
.Free text search in the configuration environment
1618
image::gui_setup_menu_search_saas.png[[alt="Setup menu with search results.", width=65%]
1719
endif::[]

src/includes/en/include_searching_in_the_monitoring_environment.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ include::global_attr.adoc[]
33
In the [.guihint]#Monitor# menu, you can search for hosts, services and [.guihint]#Monitor# menu entries.
44
The search is interactive, so as soon as you have typed something, you will immediately see the results matching your input below the search field:
55

6+
.Interactive search in the [.guihint]#Monitor# menu
67
image::gui_monitor_menu_search.png[alt="Monitor menu with search results.",width=65%]
78

89
The search function in the [.guihint]#Monitor# menu is identical to that offered to you by the [.guihint]#Quicksearch# snap-in.

0 commit comments

Comments
 (0)