Zabbix Documentation 2.4

3.04.04.4 (current)| In development:5.0 (devel)| Unsupported:1.82.02.22.43.23.44.2Guidelines

User Tools

Site Tools


manual:config:visualisation:maps:map

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
manual:config:visualisation:maps:map [2014/02/20 09:11]
martins-v adding application field info in map element properties
manual:config:visualisation:maps:map [2016/11/02 14:20]
martins-v specifying which macro is supported for link label
Line 9: Line 9:
 Icons are used to represent map elements. You can define the information that will be displayed with the icons and set that recent problems are displayed in a special way. You can link the icons and define information to be displayed on the links. Icons are used to represent map elements. You can define the information that will be displayed with the icons and set that recent problems are displayed in a special way. You can link the icons and define information to be displayed on the links.
  
-Maps that are ready can be viewed in //​Monitoring -> Maps//. In the monitoring view you can click on the icons and take advantage of the links to some scripts and URLs.+Maps that are ready can be viewed in //​Monitoring// -> //​[[manual:​web_interface:​frontend_sections:​monitoring:​maps|Maps]]//. In the monitoring view you can click on the icons and take advantage of the links to some scripts and URLs.
  
 You can add custom URLs to be accessible by clicking on the icons. Thus you may link a host icon to host properties or a map icon to another map. You can add custom URLs to be accessible by clicking on the icons. Thus you may link a host icon to host properties or a map icon to another map.
Line 20: Line 20:
   * Edit general map attributes   * Edit general map attributes
  
-{{:2.4/manual/config/visualisation/map_config.png?​600|}}+{{manual:config:visualisation:map_config.png?​600|}}
  
 General map attributes: General map attributes:
Line 30: Line 30:
 |//​Background image// ​ |Use background image:\\ **No image** - no background image (white background)\\ **Image** - selected image to be used as a background image. No scaling is performed. You may use a geographical map or any other image to enhance your map.| |//​Background image// ​ |Use background image:\\ **No image** - no background image (white background)\\ **Image** - selected image to be used as a background image. No scaling is performed. You may use a geographical map or any other image to enhance your map.|
 |//​Automatic icon mapping// ​ |You can set to use an automatic icon mapping, configured in //​Administration -> General -> Icon mapping//. Icon mapping allows to map certain icons against certain host inventory fields. ​ | |//​Automatic icon mapping// ​ |You can set to use an automatic icon mapping, configured in //​Administration -> General -> Icon mapping//. Icon mapping allows to map certain icons against certain host inventory fields. ​ |
-|//Icon highlighting// ​ |If you check this box, icons will receive highlighting. ​If the element has an active trigger, it will receive a round background, ​having ​the same colour as the highest severity trigger. ​If element status is "​disabled"​ or "in maintenance"​square background ​will be used. |+|//Icon highlighting// ​ |If you check this box, icons will receive highlighting.\\ Elements with an active trigger will receive a round background, ​in the same colour as the highest severity trigger. ​Moreover, a thick green line will be displayed around the circle, if all problems are acknowledged.\\ Elements with "​disabled"​ or "in maintenance" ​status will get a square background, gray and orange respectively |
 |//Mark elements on trigger status change// ​ |A recent change of trigger status (recent problem or resolution) will be highlighted with markers (inward-pointing red triangles) on the three sides of the element icon that are free of the label. Markers are displayed for 30 minutes.| |//Mark elements on trigger status change// ​ |A recent change of trigger status (recent problem or resolution) will be highlighted with markers (inward-pointing red triangles) on the three sides of the element icon that are free of the label. Markers are displayed for 30 minutes.|
 |//Expand single problem// ​ | If a map element (host, host group or another map) has one single problem, this option controls whether the problem (trigger) name is displayed, or problem count. If marked, problem name is used. | |//Expand single problem// ​ | If a map element (host, host group or another map) has one single problem, this option controls whether the problem (trigger) name is displayed, or problem count. If marked, problem name is used. |
Line 38: Line 38:
 |//Problem display// ​ |Display problem count as:\\ **All** - full problem count will be displayed\\ **Separated** - unacknowledged problem count will be displayed separated as a number of the total problem count\\ **Unacknowledged only** - only the unacknowledged problem count will be displayed| |//Problem display// ​ |Display problem count as:\\ **All** - full problem count will be displayed\\ **Separated** - unacknowledged problem count will be displayed separated as a number of the total problem count\\ **Unacknowledged only** - only the unacknowledged problem count will be displayed|
 |//Minimum trigger severity// ​ |Problems below the selected minimum severity level will not be displayed in the map.\\ For example, with //Warning// selected, changes with //​Information//​ and //Not classified//​ level triggers will not be reflected in the map.\\ This parameter is supported starting with Zabbix 2.2.  | |//Minimum trigger severity// ​ |Problems below the selected minimum severity level will not be displayed in the map.\\ For example, with //Warning// selected, changes with //​Information//​ and //Not classified//​ level triggers will not be reflected in the map.\\ This parameter is supported starting with Zabbix 2.2.  |
-|//​URLs// ​ |URLs for each element type can be defined (with a label). These will be displayed as links when a user clicks on the element in the monitoring section.\\ [[:2.4/manual/config/macros|Macros]] that can be used in map URLs: {MAP.ID}, {HOSTGROUP.ID},​ {HOST.ID}, {TRIGGER.ID}|+|//​URLs// ​ |URLs for each element type can be defined (with a label). These will be displayed as links when a user clicks on the element in the monitoring section.\\ [[manual:config:macros|Macros]] that can be used in map URLs: {MAP.ID}, {HOSTGROUP.ID},​ {HOST.ID}, {TRIGGER.ID}|
  
-When you save this, you have created an empty map with a name, dimensions and certain preferences. Now you need to add some elements. For that, click on the map name in the list to open the editable area.+When you click on //Add// to save this, you have created an empty map with a name, dimensions and certain preferences. Now you need to add some elements. For that, click on the map name in the list to open the editable area.
  
 === Adding elements === === Adding elements ===
Line 50: Line 50:
 Now that you have some elements in place, you may want to start differentiating them by giving names etc. By clicking on the element, a form is displayed and you can set the element type, give a name, choose a different icon etc. Now that you have some elements in place, you may want to start differentiating them by giving names etc. By clicking on the element, a form is displayed and you can set the element type, give a name, choose a different icon etc.
  
-{{:2.4/manual/config/visualisation/map_element.png?600|}}+{{manual:config:visualisation:map_element.png|}}
  
 Map element attributes: Map element attributes:
Line 56: Line 56:
 ^Parameter^Description^ ^Parameter^Description^
 |//​Type// ​ |Type of the element:\\ **Host** - icon representing status of all triggers of the selected host\\ **Map** - icon representing status of all elements of a map\\ **Trigger** - icon representing status of a single trigger\\ **Host group** - icon representing status of all triggers of all hosts belonging to the selected group\\ **Image** - an icon, not linked to any resource ​ | |//​Type// ​ |Type of the element:\\ **Host** - icon representing status of all triggers of the selected host\\ **Map** - icon representing status of all elements of a map\\ **Trigger** - icon representing status of a single trigger\\ **Host group** - icon representing status of all triggers of all hosts belonging to the selected group\\ **Image** - an icon, not linked to any resource ​ |
-|//​Label// ​ |Icon label, any string.\\ [[:2.4/manual/config/macros|Macros]] and multi-line strings can be used in labels. ​ |+|//​Label// ​ |Icon label, any string.\\ [[manual:config:macros|Macros]] and multi-line strings can be used in labels. ​ |
 |//Label location// ​ |Label location in relation to the icon:\\ **Default** - map's default label location\\ **Bottom** - beneath the icon\\ **Left** - to the left\\ **Right** - to the right\\ **Top** - above the icon  | |//Label location// ​ |Label location in relation to the icon:\\ **Default** - map's default label location\\ **Bottom** - beneath the icon\\ **Left** - to the left\\ **Right** - to the right\\ **Top** - above the icon  |
 |//​Host// ​ |Enter the host, if the element type is '​Host'​. This field is auto-complete so starting to type the name of a host will offer a dropdown of matching hosts. Scroll down to select. Click on '​x'​ to remove the selected. ​ | |//​Host// ​ |Enter the host, if the element type is '​Host'​. This field is auto-complete so starting to type the name of a host will offer a dropdown of matching hosts. Scroll down to select. Click on '​x'​ to remove the selected. ​ |
Line 68: Line 68:
 |//​Coordinate X//  |X coordinate of the map element. ​ | |//​Coordinate X//  |X coordinate of the map element. ​ |
 |//​Coordinate Y//  |Y coordinate of the map element. ​ | |//​Coordinate Y//  |Y coordinate of the map element. ​ |
-|//​URLs// ​ |Element-specific URLs can be set for the element. These will be displayed as links when a user clicks on the element in the monitoring section. If the element has its own URLs and there are map level URLs for its type defined, they will be combined in the same menu.\\ [[:2.4/manual/config/macros|Macros]] that can be used in map URLs: {MAP.ID}, {HOSTGROUP.ID},​ {HOST.ID}, {TRIGGER.ID} ​ |+|//​URLs// ​ |Element-specific URLs can be set for the element. These will be displayed as links when a user clicks on the element in the monitoring section. If the element has its own URLs and there are map level URLs for its type defined, they will be combined in the same menu.\\ [[manual:config:macros|Macros]] that can be used in map URLs: {MAP.ID}, {HOSTGROUP.ID},​ {HOST.ID}, {TRIGGER.ID} ​ |
  
 <note important>​Added elements are not automatically saved. If you navigate away from the page, all changes may be lost. <note important>​Added elements are not automatically saved. If you navigate away from the page, all changes may be lost.
  
-Therefore it is a good idea to click on the **Save** button in the top right corner. Once clicked, the changes are saved regardless of what you choose in the following popup. ​+Therefore it is a good idea to click on the **Update** button in the top right corner. Once clicked, the changes are saved regardless of what you choose in the following popup. ​
  
 Selected grid options are also saved with each map.</​note>​ Selected grid options are also saved with each map.</​note>​
Line 78: Line 78:
 === Selecting elements === === Selecting elements ===
  
-To select elements, select one and then hold down //​Ctrl// ​(or //​Shift//​) ​to select the others.+To select elements, select one and then hold down //Ctrl// to select the others.
  
 You can also select multiple elements by dragging a rectangle in the editable area and selecting all elements in it (option available since Zabbix 2.0). You can also select multiple elements by dragging a rectangle in the editable area and selecting all elements in it (option available since Zabbix 2.0).
  
-Once you select more than one element, the element property form shifts to the mass-update mode so you can change attributes of selected elements in one go. To do so, mark the attribute using the checkbox and enter a new value for it. You may use macros here (such as, say, {HOSTNAME} for the element label).+Once you select more than one element, the element property form shifts to the mass-update mode so you can change attributes of selected elements in one go. To do so, mark the attribute using the checkbox and enter a new value for it. You may use macros here (such as, say, {HOST.NAME} for the element label).
  
-{{:2.4/manual/config/visualisation/​1.9.9_map_update.png?600|}}+{{manual:config:visualisation:map_update.png|}}
  
 === Linking elements === === Linking elements ===
Line 90: Line 90:
 Once you have put some elements on the map, it is time to start linking them. To link two elements you must first select them. With the elements selected, click on the "​+"​ next to Link. Once you have put some elements on the map, it is time to start linking them. To link two elements you must first select them. With the elements selected, click on the "​+"​ next to Link.
  
-With a link created, the single element form now contains an additional //Edit element ​links// section. Click on //Edit// before the link to edit its attributes.+With a link created, the single element form now contains an additional //Links for the selected ​element// section. Click on //Edit// before the link to edit its attributes.
  
-{{:2.4/manual/config/visualisation/​1.9.9_map_links.png?600|}}+{{manual:config:visualisation:map_links.png|}}
  
 Link attributes: Link attributes:
  
 ^Parameter^Description^ ^Parameter^Description^
-|//​Label// ​ |Label that will be rendered on top of the link. You can use [[:2.4/manual/config/macros|macros]] here.  |+|//​Label// ​ |Label that will be rendered on top of the link.\\ The [[:manual/appendix/macros/​supported_by_location|{host:​key.func(param)}]] macro is supported in this field, but only with ''​avg'',​ ''​last'',​ ''​min''​ and ''​max''​ trigger functions, with seconds as parameter.  |
 |//Connect to//  |The element that the link connects to.  | |//Connect to//  |The element that the link connects to.  |
 |//Type (OK)// ​ |Default link style:\\ **Line** - single line\\ **Bold line** - bold line\\ **Dot** - dots\\ **Dashed line** - dashed line  | |//Type (OK)// ​ |Default link style:\\ **Line** - single line\\ **Bold line** - bold line\\ **Dot** - dots\\ **Dashed line** - dashed line  |
 |//Colour (OK)// ​ |Default link colour. ​ | |//Colour (OK)// ​ |Default link colour. ​ |
-|//[[:​2.4/​manual/​config/​visualisation/​maps/​links|Link indicators]]// ​ |List of triggers linked to the link. In case a trigger has status PROBLEM, its style is applied to the link.  |+|//​[[links|Link indicators]]// ​ |List of triggers linked to the link. In case a trigger has status PROBLEM, its style is applied to the link.  |