Zabbix Documentation 3.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 [2017/05/18 07:19]
martins-v grammar fix
manual:config:visualisation:maps:map [2018/08/30 05:53] (current)
martins-v adding link to map viewing information
Line 1: Line 1:
-==== - #1 Configuring a network map ====+==== 1 Configuring a network map ====
  
 === Overview === === Overview ===
Line 13: Line 13:
 Maps are managed in //​Monitoring//​ -> //​[[manual:​web_interface:​frontend_sections:​monitoring:​maps|Maps]]//,​ where they can be configured, managed and viewed. In the monitoring view you can click on the icons and take advantage of the links to some scripts and URLs.  Maps are managed in //​Monitoring//​ -> //​[[manual:​web_interface:​frontend_sections:​monitoring:​maps|Maps]]//,​ where they can be configured, managed and viewed. In the monitoring view you can click on the icons and take advantage of the links to some scripts and URLs. 
  
-All users in Zabbix ​(including non-admin userscan create network mapsMaps have an owner - the user who created them.+Network maps are based on vector graphics ​(SVGsince Zabbix 3.4.
  
-Maps can be made public or private. ​Public maps are visible to all users, however, they must have at least read permissions to all map elements to see it. To add an element to the map the user must also have at least read permission to it.+=== Public ​and private ​maps ===
  
-Private maps are visible only to their owner. Private maps can be shared by the owner to other users and user groups. Regular ​(non-Super adminusers can only share with the groups and users they are member ofPrivate maps will be visible to their owner and the users the map is shared with as long as they have read permissions to all map elementsAdmin level users, as long as they have read permissions to all map elements, ​can see and edit private ​maps regardless of being the owner or belonging to the shared user list.+All users in Zabbix ​(including ​non-admin userscan create network mapsMaps have an owner the user who created themMaps can be made public or private. ​
  
-Network ​maps are based on vector graphics ​(SVGsince Zabbix 3.4.+  * //​Public// ​maps are visible to all users, although to see it the user must have read access to at least one map element. Public maps can be edited in case a user/ user group has read-write permissions for this map and at least read permissions to all elements of the corresponding map including triggers in the links. ​  
 + 
 +  * //Private// maps are visible only to their owner and the users/user groups the map is [[:​manual/​config/​visualisation/​maps/​map|shared]] with by the owner. Regular ​(non-Super adminusers can only share with the groups and users they are member of. Admin level users can see private maps regardless of being the owner or belonging to the shared user list. Private maps can be edited by the owner of the map and in case a user/ user group has read-write permissions for this map and at least read permissions to all elements of the corresponding map including triggers in the links. 
 + 
 +Map elements that the user does not have read permission to are displayed with a greyed out icon and all textual information on the element is hidden. However, trigger label is visible even if the user has no permission to the trigger. 
 + 
 +To add an element to the map the user must also have at least read permission to it.
  
 === Creating a map === === Creating a map ===
Line 43: Line 49:
 |//​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.\\ 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. ​ |+|//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.\\ See also: [[:​manual/​web_interface/​frontend_sections/​monitoring/​maps#​viewing_maps|Viewing maps]] ​ |
 |//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.|
 |//Display problems// ​ |Select how problems are displayed with a map element:\\ **Expand single problem** - if a map element has one single problem, the problem (trigger) name is displayed\\ **Number of problems** - the total number of problems is displayed\\ **Number of problems and expand most critical one** - problem (trigger) name is displayed for the most critical one and the total number of problems is displayed. 'Most critical'​ is determined based on:\\ //For trigger map element// - trigger severity and trigger position in the trigger list;\\ //For other map elements// - trigger severity and trigger ID.  | |//Display problems// ​ |Select how problems are displayed with a map element:\\ **Expand single problem** - if a map element has one single problem, the problem (trigger) name is displayed\\ **Number of problems** - the total number of problems is displayed\\ **Number of problems and expand most critical one** - problem (trigger) name is displayed for the most critical one and the total number of problems is displayed. 'Most critical'​ is determined based on:\\ //For trigger map element// - trigger severity and trigger position in the trigger list;\\ //For other map elements// - trigger severity and trigger ID.  |
-|//Advanced labels// ​ |If you check this box you will be able to define separate label types for separate element types.|+|//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 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| |//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|
Line 52: Line 58:
 |//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 map viewing mode.\\ [[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 map viewing mode.\\ [[manual:​config:​macros|Macros]] that can be used in map URLs: {MAP.ID}, {HOSTGROUP.ID},​ {HOST.ID}, {TRIGGER.ID}|
 +
 +=== Sharing ===
  
 The **Sharing** tab contains the map type as well as sharing options (user groups, users) for private maps: The **Sharing** tab contains the map type as well as sharing options (user groups, users) for private maps:
Line 77: Line 85:
  
 ^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 one or more triggers\\ Note that, starting with Zabbix 3.4.3, if multiple triggers are selected, {HOST.*} macros will be resolved based on the first trigger in the list (which is based on trigger ​priority).\\ **[[manual:​config:​visualisation:​maps:​host_groups|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.\\ [[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. ​ |
 |//​Map// ​ |Select the map, if the element type is '​Map'​. ​ | |//​Map// ​ |Select the map, if the element type is '​Map'​. ​ |
-|//​Triggers// ​ |If the element type is '​Trigger',​ select one or more triggers in the //New triggers// field below and click on //Add//.\\ The order of selected triggers can be changed, but only within the same severity of triggers. ​ |+|//​Triggers// ​  ​|If the element type is '​Trigger',​ select one or more triggers in the //New triggers// field below and click on //Add//.\\ The order of selected triggers can be changed, but only within the same severity of triggers. ​Since Zabbix 3.4.3, multiple trigger selection also affects {HOST.*} macro resolution both in the construction and view modes.\\ // 1 In construction mode// the first displayed {HOST.*} macros will be resolved depending on the first trigger in the list (based on trigger severity).\\ // 2 View mode// depends on the [[manual:​config:​visualisation:​maps:​map#​creating_a_map|Display problems]] parameter in General map attributes.\\ * If //Expand single problem// mode is chosen the first  displayed {HOST.*} macros will be resolved depending on the latest detected problem trigger (not mattering the severity) or the first trigger in the list (in case no problem detected);​\\ * If //Number of problems and expand most critical one// mode is chosen the first displayed ​ {HOST.*} macros will be resolved depending on the trigger severity. ​ \\   |
 |//Host group// ​ |Enter the host group, if the element type is 'Host group'​. This field is auto-complete so starting to type the name of a group will offer a dropdown of matching groups. Scroll down to select. Click on '​x'​ to remove the selected. ​ | |//Host group// ​ |Enter the host group, if the element type is 'Host group'​. This field is auto-complete so starting to type the name of a group will offer a dropdown of matching groups. Scroll down to select. Click on '​x'​ to remove the selected. ​ |
 |//​Application// ​ |You can select an application,​ allowing to only display problems of triggers that belong to the given application.\\ This field is available for host and host group element types, and supported since Zabbix **2.4.0**. ​ | |//​Application// ​ |You can select an application,​ allowing to only display problems of triggers that belong to the given application.\\ This field is available for host and host group element types, and supported since Zabbix **2.4.0**. ​ |
Line 141: Line 149:
  
 To add a shape, click on //Add// next to Shape. The new shape will appear at the top left corner of the map. Drag and drop it wherever you like.  To add a shape, click on //Add// next to Shape. The new shape will appear at the top left corner of the map. Drag and drop it wherever you like. 
- 
-Note that with the Grid option "​On",​ shapes will always align to the grid (you can pick various grid sizes from the dropdown, also hide/show the grid). If you want to put shapes anywhere without alignment, turn the option to "​Off"​. (Random shapes can later again be aligned to the grid with the //Align icons// button.) ​ 
  
 A new shape is added with default colours. By clicking on the shape, a form is displayed and you can customize the way a shape looks, add text, etc. A new shape is added with default colours. By clicking on the shape, a form is displayed and you can customize the way a shape looks, add text, etc.
Line 157: Line 163:
  
 If hyperlinks are used in the text, they become clickable when viewing the map. If hyperlinks are used in the text, they become clickable when viewing the map.
 +
 +Line wrapping for text is always "​on"​ within shapes. However, within an ellipse the lines are wrapped as though the ellipse were a rectangle. Word wrapping is not implemented,​ so long words (words that do not fit the shape) are not wrapped, but are masked (constructor page) or clipped (other pages with maps).
 === Adding lines === === Adding lines ===
  
Line 163: Line 171:
 To add a line, click on //Add// next to Shape. A new shape will appear at the top left corner of the map. Select it and click on //Line// in the editing form to change the shape into a line. Then adjust line properties, such as line type, width, colour, etc. To add a line, click on //Add// next to Shape. A new shape will appear at the top left corner of the map. Select it and click on //Line// in the editing form to change the shape into a line. Then adjust line properties, such as line type, width, colour, etc.
  
-{{:​manual:​config:​visualisation:​map_line.png}}+{{:​manual:​config:​visualisation:​map_line.png?600}}
  
 === Ordering shapes and lines === === Ordering shapes and lines ===