Zabbix Documentation 2.0

3.04.04.2 (current)In development:4.4 (devel)Unsupported:1.82.02.22.43.23.4

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

Next revision
Previous revision
manual:config:visualisation:maps:map [2011/10/26 14:27]
martins-v created, adding basic info
manual:config:visualisation:maps:map [2016/11/02 14:18] (current)
martins-v specifying which macro is supported for link label
Line 1: Line 1:
-<note tip>The content of this page is yet to be completely updated for 2.0.</​note>​ 
- 
 ==== - #1 Configuring a network map ==== ==== - #1 Configuring a network map ====
  
-=== General ​map attributes ​====+=== Overview === 
 + 
 +Configuring a map in Zabbix requires that you first create a map by defining its general parameters and then you start filling the actual map with elements and their links.  
 + 
 +You can populate the map with elements that are a host, a host group, a trigger, an image or another map.  
 + 
 +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//​ -> //​[[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. 
 + 
 +=== Creating a map ===
  
 To create a map, do the following: To create a map, do the following:
   * Go to //​Configuration -> Maps//   * Go to //​Configuration -> Maps//
-  * Click on //​Create ​Map//+  * Click on //​Create ​map//
   * Edit general map attributes   * Edit general map attributes
  
-{{:1.8:manual:web_interface:1.8.5_frontend_mapform1.png?450|}}+{{manual:config:visualisation:1.9.9_map_config.png?550|}}
  
 General map attributes: General map attributes:
Line 18: Line 28:
 |//​Width// ​ |Map width in pixels.| |//​Width// ​ |Map width in pixels.|
 |//​Height// ​ |Map height in pixels.| |//​Height// ​ |Map height in pixels.|
-|//​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.| +|//​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.
-|//Icon highlighting// ​ |Map elements ​will receive highlighting. ​If element has an active triggerround background ​will be usedhaving ​same colour as the highest severity trigger. ​If element status is "​disabled"​ or "in maintenance"​square background ​will be used. | +|//​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.  ​
-|//Mark elements on trigger status change// ​ |Elements that have a trigger status ​recently changed ​will be highlighted with markers. | +|//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 
-|//Expand single problem// ​ | If a map element (host, host group or another map) has single problem, this option controls whether problem (trigger) name is printed, or problem count. If marked, problem name is used. | +|//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.| 
-|//Icon label type// ​ |Label type used for all map icons:\\ **Label** - icon label only\\ **IP address** - IP address ​only\\ **Element name** - element name (for example, host name)\\ **Status only** - status only (OK or PROBLEM)\\ **Nothing** - no icon labels are displayed| +|//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. | 
-|//Icon label location// ​ |Display ​icon label on:\\ **Bottom** - bottom (under ​the icon)\\ **Left** - left side\\ **Right** - right side\\ **Top** - top of the icon|+|//Advanced labels// ​ |If you check this box you will be able to define separate label types for separate element types.| 
 +|//Icon label type// ​ |Label type used for icons:\\ **Label** - icon label\\ **IP address** - IP address\\ **Element name** - element name (for example, host name)\\ **Status only** - status only (OK or PROBLEM)\\ **Nothing** - no labels are displayed| 
 +|//Icon label location// ​ |Label location in relation to the icon:\\ **Bottom** - beneath ​the icon\\ **Left** - to the left\\ **Right** - to the right\\ **Top** - above the icon
 +|//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| 
 +|//​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 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.
Line 31: Line 45:
 To add an element, click on the "​+"​ next to Icon. The new element will appear at the top left corner of the map. Drag and drop it wherever you like.  To add an element, click on the "​+"​ next to Icon. The new element will appear at the top left corner of the map. Drag and drop it wherever you like. 
  
-Now that you have one element in the placeyou may want to add some more and start differentiating them by giving names etc. By clicking on the element, a form is displayed and you can set the element typegive a namechoose a different icon etc.+Note that with the Grid option "​On"​elements will always align to the grid (you can pick various grid sizes from the dropdownalso hide/show the grid). If you want to put elements anywhere without alignmentturn the option to "​Off"​. (Random elements can later again be aligned to the grid with the //Align icons// button.
  
-{{:1.8:manual:web_interface:1.8.5_frontend_mapform2.png?600|}}+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. 
 + 
 +{{manual:config:visualisation:1.9.9_map_element.png?600|}}
  
 Map element attributes: Map element attributes:
  
 ^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 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.\\ Macros and multi-line ​string ​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:\\ **Default** - Map's default label location\\ **Bottom** - bottom (under ​the icon)\\ **Left** - left side\\ **Right** - right side\\ **Top** - top of 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// ​ |Status of triggers for the selected ​host will be used.| +|//​Host// ​ |Select ​the host, if the element type is '​Host'​ 
-|//​Map// ​ |Status of all elements for the selected ​map will be used.| +|//​Map// ​ |Select ​the map, if the element type is '​Map'​ 
-|//​Trigger// ​ |Status of the selected ​trigger ​will be used.| +|//​Trigger// ​ |Select ​the trigger, if the element type is '​Trigger'​ 
-|//Host group// ​ |Status of all triggers for the selected ​host group will be used.| +|//Host group// ​ |Select ​the host group, if the element type is 'Host group' 
-|//Icon (default)// ​ |Icon to be used.| +|//Icon (default)// ​ |Icon to be used.  
-|//Use advanced icons//  | | +|//Automatic icon selection//  |In this case an icon mapping will be used to determine which icon to display. ​ | 
-|//​Coordinate X//  |X coordinate ​for the map element.| +|//​Icons// ​ |You can choose to display different icons for the element in these cases: default, problem, maintenance,​ disabled.  ​
-|//​Coordinate Y//  |Y coordinate ​for the map element.| +|//​Coordinate X//  |X coordinate ​of the map element. ​ 
-|//URL//  |If setthe URL will be used when a user clicks on the screen ​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 sectionIf 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.</​note>​+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. ​
  
-Once you have put some elements of your network on the map, it is time to start linking them.+Selected grid options are also saved with each map.</​note>​
  
-=== Linking ​elements ===+=== Selecting ​elements ===
  
-To link two elements ​in the map: +To select ​elements, select one and then hold down //Ctrl// (or //Shift//) to select ​the others.
  
-  * Select them both (first ​select ​one and then hold down //​Shift// ​(or //Ctrl//to select the other) +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).
-  * Click on the "​+"​ next to Link +
  
-form is displayed where you can probably see //Link1//Click on it and edit its attributes.+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 goTo 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).
  
-{{:1.8:manual:web_interface:1.8.5_frontend_mapform3.png?600|}}+{{manual:config:visualisation:1.9.9_map_update.png?600|}}
  
-Map link attributes:+=== Linking elements === 
 + 
 +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. 
 + 
 +{{manual:​config:​visualisation:​1.9.9_map_links.png?​600|}} 
 + 
 +Link attributes:
  
 ^Parameter^Description^ ^Parameter^Description^
-|//​Label// ​ |Label that will be rendered on top of the link. You can use [[2.0/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.  | 
-|//Element 1//  |First element that link connects.+|//Connect to//  |The element that the link connects to.  |
-|//Element 2//  |Second ​element that link connects.| +
-|//​[[2.0/​manual/​config/​visualisation/​maps/​links|Link status indicators]]// ​ |List of triggers linked ​to the link. In case if a trigger has status PROBLEM, its style is applied to the link.  |+
 |//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. ​ |
 +|//​[[links|Link indicators]]// ​ |List of triggers linked to the link. In case a trigger has status PROBLEM, its style is applied to the link.  |