Zabbix Documentation 5.2

3.04.05.0 (current)| In development:5.2 (devel)| Unsupported:1.82.02.22.43.23.44.24.4Guidelines

User Tools

Site Tools


manual:config:items:item

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
Next revision Both sides next revision
manual:config:items:item [2020/02/13 08:39]
martins-v vmware simple checks cannot be tested
manual:config:items:item [2020/04/22 08:46]
martins-v update interval can only be set to 0 if flexible or scheduled intervals exist with a non-zero value (ZBX-17601)
Line 25: Line 25:
 |//​Key// ​ |Item key (up to 2048 characters).\\ The supported [[itemtypes|item keys]] can be found in individual item type sections.\\ The key must be unique within a single host.\\ If key type is '​Zabbix agent',​ '​Zabbix agent (active)',​ '​Simple check' or '​Zabbix aggregate',​ the key value must be supported by Zabbix agent or Zabbix server.\\ See also: the correct [[manual:​config:​items:​item:​key|key format]]. ​ | |//​Key// ​ |Item key (up to 2048 characters).\\ The supported [[itemtypes|item keys]] can be found in individual item type sections.\\ The key must be unique within a single host.\\ If key type is '​Zabbix agent',​ '​Zabbix agent (active)',​ '​Simple check' or '​Zabbix aggregate',​ the key value must be supported by Zabbix agent or Zabbix server.\\ See also: the correct [[manual:​config:​items:​item:​key|key format]]. ​ |
 |//Host interface// |Select the host interface. This field is available when editing an item on the host level. | |//Host interface// |Select the host interface. This field is available when editing an item on the host level. |
-|//Type of information// ​ |Type of data as stored in the database after performing conversions,​ if any.\\ **Numeric (unsigned)** - 64bit unsigned integer\\ **Numeric (float)** - floating point number\\ ​Negative values can be stored.\\ Allowed ​range-999999999999.9999 to 999999999999.9999.\\ Starting with Zabbix 2.2, receiving ​values in scientific notation is also supported. E.g. 1e+7, 1e-4.\\ **Character** - short text data\\ **Log** - long text data with optional log related properties (timestamp, source, severity, logeventid)\\ **Text** - long text data. See also [[#​Text_data_limits|text data limits]]. ​ |+|//Type of information// ​ |Type of data as stored in the database after performing conversions,​ if any.\\ **Numeric (unsigned)** - 64bit unsigned integer\\ **Numeric (float)** - 64bit floating point number\\ ​This type will allow precision of approximately 15 digits and range from approximately ​-1.79E+308 ​to 1.79E+308 (with exception of [[:​manual/​installation/​known_issues#​floating_point_values|PostgreSQL 11 and earlier versions]]).\\ Receiving ​values in scientific notation is also supported. E.g. 1.23E+7, 1e308, 1.1E-4.\\ **Character** - short text data\\ **Log** - long text data with optional log related properties (timestamp, source, severity, logeventid)\\ **Text** - long text data. See also [[#​Text_data_limits|text data limits]]. ​ |
 |//​Units// ​ |If a unit symbol is set, Zabbix will add post processing to the received value and display it with the set unit postfix.\\ By default, if the raw value exceeds 1000, it is divided by 1000 and displayed accordingly. For example, if you set //bps// and receive a value of 881764, it will be displayed as 881.76 Kbps. \\ Special processing is used for **B** (byte), **Bps** (bytes per second) units, which are divided by 1024. Thus, if units are set to **B** or **Bps** Zabbix will display:\\ 1 as 1B/1Bps\\ 1024 as 1KB/1KBps\\ 1536 as 1.5KB/​1.5KBps\\ Special processing is used if the following time-related units are used:\\ **unixtime** - translated to "​yyyy.mm.dd hh:​mm:​ss"​. To translate correctly, the received value must be a //Numeric (unsigned)//​ type of information.\\ **uptime** - translated to "​hh:​mm:​ss"​ or "N days, hh:​mm:​ss"​\\ For example, if you receive the value as 881764 (seconds), it will be displayed as "10 days, 04:​56:​04"​\\ **s** - translated to "yyy mmm ddd hhh mmm sss ms"; parameter is treated as number of seconds.\\ For example, if you receive the value as 881764 (seconds), it will be displayed as "10d 4h 56m"\\ Only 3 upper major units are shown, like "1m 15d 5h" or "2h 4m 46s". If there are no days to display, only two levels are displayed - "1m 5h" (no minutes, seconds or milliseconds are shown). Will be translated to "< 1 ms" if the value is less than 0.001.\\ //Note// that if a unit is prefixed with ''​!'',​ then no unit prefixes/​processing is applied to item values. See [[#​unit_blacklisting|unit blacklisting]]. ​ | |//​Units// ​ |If a unit symbol is set, Zabbix will add post processing to the received value and display it with the set unit postfix.\\ By default, if the raw value exceeds 1000, it is divided by 1000 and displayed accordingly. For example, if you set //bps// and receive a value of 881764, it will be displayed as 881.76 Kbps. \\ Special processing is used for **B** (byte), **Bps** (bytes per second) units, which are divided by 1024. Thus, if units are set to **B** or **Bps** Zabbix will display:\\ 1 as 1B/1Bps\\ 1024 as 1KB/1KBps\\ 1536 as 1.5KB/​1.5KBps\\ Special processing is used if the following time-related units are used:\\ **unixtime** - translated to "​yyyy.mm.dd hh:​mm:​ss"​. To translate correctly, the received value must be a //Numeric (unsigned)//​ type of information.\\ **uptime** - translated to "​hh:​mm:​ss"​ or "N days, hh:​mm:​ss"​\\ For example, if you receive the value as 881764 (seconds), it will be displayed as "10 days, 04:​56:​04"​\\ **s** - translated to "yyy mmm ddd hhh mmm sss ms"; parameter is treated as number of seconds.\\ For example, if you receive the value as 881764 (seconds), it will be displayed as "10d 4h 56m"\\ Only 3 upper major units are shown, like "1m 15d 5h" or "2h 4m 46s". If there are no days to display, only two levels are displayed - "1m 5h" (no minutes, seconds or milliseconds are shown). Will be translated to "< 1 ms" if the value is less than 0.001.\\ //Note// that if a unit is prefixed with ''​!'',​ then no unit prefixes/​processing is applied to item values. See [[#​unit_blacklisting|unit blacklisting]]. ​ |
-|//Update interval// ​ |Retrieve a new value for this item every N seconds. Maximum allowed update interval is 86400 seconds (1 day).\\ [[:​manual/​appendix/​suffixes|Time suffixes]] are supported, e.g. 30s, 1m, 2h, 1d.\\ [[:​manual/​config/​macros/​usermacros|User macros]] are supported.\\ A single macro has to fill the whole field. Multiple macros in a field or macros mixed with text are not supported.\\ //Note//: If set to %%"%%0%%"%%the item will not be polled. However, if a custom interval (flexible/schedulingalso exists with a non-zero value, the item will be polled during the custom interval duration.\\ ​ //Note// that the first item poll after the item became active or after update interval change might occur earlier than the configured value.\\ An existing passive item can be polled for value immediately by pushing the //Check now// [[#​form_buttons|button]]. ​ |+|//Update interval// ​ |Retrieve a new value for this item every N seconds. Maximum allowed update interval is 86400 seconds (1 day).\\ [[:​manual/​appendix/​suffixes|Time suffixes]] are supported, e.g. 30s, 1m, 2h, 1d.\\ [[:​manual/​config/​macros/​usermacros|User macros]] are supported.\\ A single macro has to fill the whole field. Multiple macros in a field or macros mixed with text are not supported.\\ //​Note//: ​The update interval can only be set to '​0'​ if custom intervals exist with a non-zero value. ​If set to '0'and a custom interval (flexible ​or scheduled) exists with a non-zero value, the item will be polled during the custom interval duration.\\ //Note// that the first item poll after the item became active or after update interval change might occur earlier than the configured value.\\ An existing passive item can be polled for value immediately by pushing the //Check now// [[#​form_buttons|button]]. ​ |
 |//Custom intervals// ​ |You can create custom rules for checking the item:\\ **Flexible** - create an exception to the //Update interval// (interval with different frequency)\\ **Scheduling** - create a custom polling schedule.\\ For detailed information see [[manual:​config:​items:​item:​custom_intervals|Custom intervals]].\\ [[:​manual/​appendix/​suffixes|Time suffixes]] are supported in the //​Interval//​ field, e.g. 30s, 1m, 2h, 1d.\\ [[:​manual/​config/​macros/​usermacros|User macros]] are supported.\\ A single macro has to fill the whole field. Multiple macros in a field or macros mixed with text are not supported.\\ Scheduling is supported since Zabix 3.0.0.\\ //Note//: Not available for Zabbix agent active items. ​ | |//Custom intervals// ​ |You can create custom rules for checking the item:\\ **Flexible** - create an exception to the //Update interval// (interval with different frequency)\\ **Scheduling** - create a custom polling schedule.\\ For detailed information see [[manual:​config:​items:​item:​custom_intervals|Custom intervals]].\\ [[:​manual/​appendix/​suffixes|Time suffixes]] are supported in the //​Interval//​ field, e.g. 30s, 1m, 2h, 1d.\\ [[:​manual/​config/​macros/​usermacros|User macros]] are supported.\\ A single macro has to fill the whole field. Multiple macros in a field or macros mixed with text are not supported.\\ Scheduling is supported since Zabix 3.0.0.\\ //Note//: Not available for Zabbix agent active items. ​ |
 |//History storage period// ​ |Select either:\\ **Do not keep history** - item history is not stored. Useful for master items if only dependent items need to keep history.\\ This setting cannot be overridden by global housekeeper [[manual:​web_interface:​frontend_sections:​administration:​general#​housekeeper|settings]].\\ **Storage period** - specify the duration of keeping detailed history in the database (1 hour to 25 years). Older data will be removed by the housekeeper. Stored in seconds.\\ [[:​manual/​appendix/​suffixes|Time suffixes]] are supported, e.g. 2h, 1d. [[:​manual/​config/​macros/​usermacros|User macros]] are supported.\\ The //Storage period// value can be overridden globally in //​Administration -> General -> [[manual:​web_interface:​frontend_sections:​administration:​general#​housekeeper|Housekeeper]]//​.\\ If a global overriding setting exists, a green {{manual:​config:​info.png|}} info icon is displayed. If you position your mouse on it, a warning message is displayed, e. g. //​Overridden by global housekeeper settings (1d)//.\\ It is recommended to keep the recorded values for the smallest possible time to reduce the size of value history in the database. Instead of keeping a long history of values, you can keep longer data of trends.\\ See also [[:​manual/​config/​items/​history_and_trends|History and trends]]. ​ | |//History storage period// ​ |Select either:\\ **Do not keep history** - item history is not stored. Useful for master items if only dependent items need to keep history.\\ This setting cannot be overridden by global housekeeper [[manual:​web_interface:​frontend_sections:​administration:​general#​housekeeper|settings]].\\ **Storage period** - specify the duration of keeping detailed history in the database (1 hour to 25 years). Older data will be removed by the housekeeper. Stored in seconds.\\ [[:​manual/​appendix/​suffixes|Time suffixes]] are supported, e.g. 2h, 1d. [[:​manual/​config/​macros/​usermacros|User macros]] are supported.\\ The //Storage period// value can be overridden globally in //​Administration -> General -> [[manual:​web_interface:​frontend_sections:​administration:​general#​housekeeper|Housekeeper]]//​.\\ If a global overriding setting exists, a green {{manual:​config:​info.png|}} info icon is displayed. If you position your mouse on it, a warning message is displayed, e. g. //​Overridden by global housekeeper settings (1d)//.\\ It is recommended to keep the recorded values for the smallest possible time to reduce the size of value history in the database. Instead of keeping a long history of values, you can keep longer data of trends.\\ See also [[:​manual/​config/​items/​history_and_trends|History and trends]]. ​ |
Line 48: Line 48:
 === Testing === === Testing ===
  
-It is possible to test the item, even before saving, ​and, if configured correctly, get a real value in return.+It is possible to test an item and, if configured correctly, get a real value in return. Testing can occur even before an item is saved. 
 + 
 +Testing is available for host and template items, item prototypes and low-level discovery rules. Testing is not available for active items.
  
 Item testing is available for the following passive item types: Item testing is available for the following passive item types:
Line 58: Line 60:
   * Telnet checks   * Telnet checks
   * JMX agent   * JMX agent
-  * Simple checks (except ''​vmware.*''​ items)+  * Simple checks (except ​''​icmpping*'', ​''​vmware.*''​ items)
   * Zabbix internal   * Zabbix internal
   * Zabbix aggregate   * Zabbix aggregate
Line 66: Line 68:
   * HTTP agent   * HTTP agent
  
-To test an item, click on the //Test// button at the bottom of the item configuration form. +To test an item, click on the //Test// button at the bottom of the item configuration form. Note that the //Test// button will be disabled for items that cannot be tested (like active checks, excluded simple checks).
  
 {{:​manual:​config:​items:​item_test_button.png|}} {{:​manual:​config:​items:​item_test_button.png|}}
  
-When the item testing form opens it will have the required host parameters (interface, port, proxy name/no proxy) filled ​automatically. To test the item, click on //Get value//. If the value is retrieved successfully,​ it will fill the //Value// field.+The item testing form has fields for the required host parameters (host address, port, proxy name/no proxy). These fields are context aware: 
 + 
 +  * The values are pre-filled ​when possible, i.e. for items requiring an agent, by taking the information from the selected agent interface of the host 
 +  * The values have to be filled manually for template items 
 +  * The fields are disabled when not needed in the context of the item type (e.g. the host address field is disabled for calculated and aggregate items, the proxy field is disabled for calculated items) 
 + 
 +To test the item, click on //Get value//. If the value is retrieved successfully,​ it will fill the //Value// field, moving the current value (if any) to the //Previous value// field while also calculating the //Prev. time// field, i.e. the time difference between the two values (clicks) and trying to detect an EOL sequence and switch to CRLF if detecting %%"​%%\n\r%%"​%% in retrieved value.
  
 {{:​manual:​config:​items:​item_test.png?​600|}} {{:​manual:​config:​items:​item_test.png?​600|}}