[ZBX-8811] agent item listing consistency issues Created: 2014 Sep 23  Updated: 2017 May 30  Resolved: 2015 Apr 02

Status: Closed
Project: ZABBIX BUGS AND ISSUES
Component/s: Documentation (D)
Affects Version/s: None
Fix Version/s: None

Type: Incident report Priority: Trivial
Reporter: richlv Assignee: Unassigned
Resolution: Fixed Votes: 0
Labels: items
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

some inconsistencies in the item section at https://www.zabbix.com/documentation/2.4/manual/config/items/itemtypes/zabbix_agent

a) empty parameters sometimes are denoted with an empty cell, sometimes with a single dash "-"

b) "Return value" sometimes is just a description like "Integer", but sometimes a full sentence like "Returns '1' if agent is available, nothing if unavailable." - probably should be changed to "'1' if agent is available, nothing if unavailable."

all item type pages should be reviewed for all versions



 Comments   
Comment by richlv [ 2014 Dec 25 ]

overall, it should be decided what should "Return value" describe. just the type of the value (integer, string etc) or actually what is in there ("version", "unix timestamp of system boot time" etc

Comment by Martins Valkovskis [ 2015 Feb 11 ]

The emphasis is on the type of value (integer, float, text), however, in cases where more specific information is of benefit (say, when a set of values, like "0" or "1" is returned), that is presented.

Return value content has been improved in:

Comment by richlv [ 2015 Mar 25 ]

(1) thanks for the improvements - looking much better. one more inconsistency
at least two different forms are used :

  • default is all
  • default is “all”

martins-v Unified to all. RESOLVED.

<richlv> very neat, thanks -> CLOSED

Comment by richlv [ 2015 Mar 25 ]

(2) as discussed, in the "Return value" column, let's get rid of the ending dots for all cells;
for multiple entries, let's separate them with one extra newline

martins-v RESOLVED.

<richlv> thanks, looks good - CLOSED

Comment by richlv [ 2015 Mar 25 ]

(3) for keys that can return 0 or 1, in some entries we list 0 first, in some - 1 goes first

martins-v Reordered (in agent.ping and vfs.file.exists) to list the 'smaller' value first (Nothing/0) as in all the other cases. RESOLVED.

<richlv> thanks, looks good -> CLOSED

Comment by richlv [ 2015 Mar 26 ]

(4) in https://www.zabbix.com/documentation/3.0/manual/config/items/itemtypes/zabbix_agent/win_keys and older versions :

  • perf_counter - "see also" should be moved to the comments column
  • perf_counter - parameters should be moved from the description to the param column
  • service_state - param description should be moved from the description to the param column
  • net.if.list - description is confusing
  • services - description seems to be covering return value quite a bit
  • proc_info says that it returns "Double", but we do not seem to use that term in other item pages; same for wmi.get (see subissue 6 below)

martins-v RESOLVED.

<richlv> looks good, CLOSED

Comment by richlv [ 2015 Mar 27 ]

(5)

  • net.tcp.port and vfs.file.exists use "Check", others - "Checks". let's unify this (and verify other places)
  • proc.mem, proc.num mention state & user in the description - let's remove those references and get rid of the parenthesis in proc.mem
  • system.stat - let's remove "(see parameter details)"
  • system.localtime - let's specify when it's integer, when it's float like for other items

martins-v RESOLVED.

<richlv> system.localtime is still missing info on when it's float, when it's integer (other issues seem to be good)

martins-v It seems like it's integer or string (rather than 'float') unless i'm missing something.

<richlv> oh, right - sorry
we should specify that it's int for utc and string for localtime

martins-v Done that. RESOLVED.

<richlv> neat, CLOSED

Comment by richlv [ 2015 Mar 27 ]

(6) it has been decided to replace all instances of "Double" with "Float"

martins-v RESOLVED.

<richlv> thanks, CLOSED

Comment by richlv [ 2015 Apr 01 ]

(7) the item listings are much more clear now - thanks. that also makes some minor issues stand out more
in https://www.zabbix.com/documentation/3.0/manual/config/items/itemtypes/zabbix_agent/win_keys

  • net.if.list - return value has more information than usually, looking more like a description. maybe we can change description to "Network interface list (includes interface type, status, IPv4 address, description)." and return value to "Text" ? would be a bit shorter, too
  • perf_counter - "return value" now partially duplicates parameter column. to be consistent, we should probably change it to "Integer, float, string or text (depending on the request)" and clarify in the param column that it's "last n seconds" for the interval

martins-v RESOLVED.

<richlv> thanks, CLOSED

Comment by richlv [ 2015 Apr 01 ]

(8) system.stat description says "Virtual memory statistics.", but apparently it can also return information about faults, cpu stats etc

martins-v Changed to "System statistics". RESOLVED.

<richlv> thanks, CLOSED

Generated at Fri Mar 29 15:13:52 EET 2024 using Jira 9.12.4#9120004-sha1:625303b708afdb767e17cb2838290c41888e9ff0.