[ZBXNEXT-2791] sync agent item key helper from manual Created: 2015 Apr 22  Updated: 2015 May 11  Resolved: 2015 May 11

Status: Closed
Project: ZABBIX FEATURE REQUESTS
Component/s: Frontend (F)
Affects Version/s: None
Fix Version/s: None

Type: Change Request Priority: Minor
Reporter: richlv Assignee: Unassigned
Resolution: Fixed Votes: 0
Labels: itemkeyhelper
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

item key helper has outdated descriptions, some item keys are completely missing and there are other issues.

these strings should be changed as little as possible to reduce workload for translators. additionally, it would be bad to have the descriptions different from the manual as double effort would mean one of them becoming outdated (as evident by the current situation in the frontend).

it has been decided to sync its contents from the manual, including "description" and "return value" columns only, otherwise the content would be too long.

ZBXNEXT-2668 deals with providing even more information in the key helper

note that this issue deals with agent items only, other item types to be handled in separate issues. note that all manual pages should be pedantically cleaned up before syncing them to reduce changes in translated strings (like it was done in ZBX-8811)



 Comments   
Comment by richlv [ 2015 Apr 24 ]

agent keys synced in the development branch at svn://svn.zabbix.com/branches/dev/ZBXNEXT-2791

  • columns "description" and "return value" are used.
  • "description" is used as is
  • first letter of "return value" is lowercased and prefixed with "Returns "
  • some exceptions apply to lowercasing (like "JSON")
  • newlines are replaced with "; "
  • fancy quotes are replaced with plain doublequotes

keys have been synced from these two pages :

Comment by richlv [ 2015 May 05 ]

synced to the manual in r53477 to add net.udp.service

Comment by richlv [ 2015 May 08 ]

(1) string changes

strings added :

  • Agent availability check. Returns nothing - unavailable; 1 - available
  • Agent host name. Returns string
  • CPU information. Returns string or integer
  • CPU load. Returns float
  • CPU utilisation in percent. Returns float
  • Chassis information. Returns string
  • Checks if DNS service is up. Returns 0 - DNS is down (server did not respond or DNS resolution failed); 1 - DNS is up
  • Checks if file exists. Returns 0 - not found; 1 - regular file or a link (symbolic or hard) to regular file exists
  • Checks if it is possible to make TCP connection to specified port. Returns 0 - cannot connect; 1 - can connect
  • Checks if service is running and accepting TCP connections. Returns 0 - service is down; 1 - service is running
  • Checks if service is running and responding to UDP requests. Returns 0 - service is down; 1 - service is running
  • Checks if this TCP port is in LISTEN state. Returns 0 - it is not in LISTEN state; 1 - it is in LISTEN state
  • Checks if this UDP port is in LISTEN state. Returns 0 - it is not in LISTEN state; 1 - it is in LISTEN state
  • Checks performance of service. Returns 0 - service is down; seconds - the number of seconds spent waiting for response from the service
  • Checks performance of service. Returns 0 - service is down; seconds - the number of seconds spent while connecting to the service
  • Count of context switches. Returns integer
  • Detailed host information. Returns string
  • Device interrupts. Returns integer
  • Different information about specific process(es). Returns float
  • Disk read statistics. Returns integer with type in sectors, operations, bytes; float with type in sps, ops, bps
  • Disk space in bytes or in percentage from total. Returns integer for bytes; float for percentage
  • Disk write statistics. Returns integer with type in sectors, operations, bytes; float with type in sps, ops, bps
  • Event log monitoring. Returns log
  • Execute WMI query and return the first selected object. Returns integer, float, string or text (depending on the request)
  • File checksum, calculated by the UNIX cksum algorithm. Returns integer
  • File size (in bytes). Returns integer
  • File time information. Returns integer (Unix timestamp)
  • Find string in a file. Returns 0 - match not found; 1 - found
  • Find string in a file. Returns the line containing the matched string, or as specified by the optional output parameter
  • Find string on a web page. Returns the matched string, or as specified by the optional output parameter
  • Get content of web page. Returns web page source as text
  • Hardware sensor reading. Returns float
  • Incoming traffic statistics on network interface. Returns integer
  • Listing of MAC addresses. Returns string
  • Listing of PCI or USB devices. Returns text
  • Listing of installed packages. Returns text
  • Listing of services. Returns 0 - if empty; text - list of services separated by a newline
  • Loading time of full web page (in seconds). Returns float
  • Log file monitoring with log rotation support. Returns log
  • Log file monitoring. Returns log
  • MD5 checksum of file. Returns character string (MD5 hash of the file)
  • Maximum number of opened files supported by OS. Returns integer
  • Maximum number of processes supported by OS. Returns integer
  • Memory size in bytes or in percentage from total. Returns integer for bytes; float for percentage
  • Memory used by process in bytes. Returns integer
  • Network interface list (includes interface type, status, IPv4 address, description). Returns text
  • Number of CPUs. Returns integer
  • Number of out-of-window collisions. Returns integer
  • Number of users logged in. Returns integer
  • Number or percentage of inodes. Returns integer for number; float for percentage
  • Operating system information. Returns string
  • Outgoing traffic statistics on network interface. Returns integer
  • Performs a DNS query. Returns character string with the required type of information
  • Retrieving contents of a file. Returns text
  • Run specified command on the host. Returns text result of the command
  • Software architecture information. Returns string
  • State of a service. Returns 0 - running; 1 - paused; 2 - start pending; 3 - pause pending; 4 - continue pending; 5 - stop pending; 6 - stopped; 7 - unknown; 255 - no such service
  • Sum of incoming and outgoing traffic statistics on network interface. Returns integer
  • Swap in (from device into memory) statistics. Returns integer
  • Swap out (from memory onto device) statistics. Returns integer
  • Swap space size in bytes or in percentage from total. Returns integer for bytes; float for percentage
  • System boot time. Returns integer (Unix timestamp)
  • System host name. Returns string
  • System statistics. Returns integer or float
  • System time. Returns integer with type as utc; string - with type as local
  • System uptime in seconds. Returns integer
  • The number of processes. Returns integer
  • Value of any Windows performance counter. Returns integer, float, string or text (depending on the request)
  • Version of Zabbix agent. Returns string

strings removed :

  • Agent host name defined in the configuration file. String value.
  • Amount of memory size in bytes. If mode is missing total is used.
  • CPU info - lists full info for all CPUs by default
  • CPU(s) load. Processor load. The cpu and mode are optional. If cpu is missing all is used. If mode is missing avg1 is used. Note that this is not percentage.
  • CPU(s) utilisation. Processor load in percents. The cpu, type and mode are optional. If cpu is missing all is used. If type is missing user is used. If mode is missing avg1 is used.
  • Calculate MD5 check sum of a given file. String MD5 hash of the file. Can be used for files less than 64MB, unsupported otherwise. Example: vfs.file.md5sum[/usr/local/etc/zabbix_agentd.conf]
  • Calculate check sum of a given file. Check sum of the file calculate by standard algorithm used by UNIX utility cksum. Example: vfs.file.cksum[/etc/passwd]
  • Calculate disk space for a given volume. Disk space in KB. If mode is missing total is used. In case of mounted volume, unused disk space for local file system is returned. Example: vfs.fs.size[/tmp,free].
  • Chassis info - returns full info by default
  • Checks if DNS service is up. 0 - DNS is down (server did not respond or DNS resolution failed), 1 - DNS is up.
  • Checks if this port is in LISTEN state. 0 - it is not, 1 - it is in LISTEN state.
  • Check if file exists. 0 - file does not exist, 1 - file exists
  • Check if service is available. 0 - service is down, 1 - service is running. If IP is missing 127.0.0.1 is used. If port number is missing, default service port is used. Example: net.tcp.service[ftp,,45].
  • Check performance of service "service". 0 - service is down, sec - number of seconds spent on connection to the service. If IP is missing 127.0.0.1 is used. If port number is missing, default service port is used.
  • Check the agent usability. Always return 1. Can be used as a TCP ping.
  • Check, if it is possible to make TCP connection to the port number. 0 - cannot connect, 1 - can connect. IP address is optional. If IP is missing, 127.0.0.1 is used. Example: net.tcp.port[,80]
  • Context switches.
  • Current OS - returns full info by default
  • Device interrupts.
  • Device list - lists PCI devices by default
  • Device read statistics.
  • Device write statistics.
  • Different information about specific process(es)
  • Execute WMI query and return the first selected object.
  • File time information. Number of seconds.The mode is optional. If mode is missing modify is used.
  • Find string in a file. 0 - expression not found, 1 - found
  • Find string in a file. Matched string
  • Get contents of a given file.
  • Get content of web page. Default path is /
  • Get first occurrence of regexp in web page. Default path is /
  • Get timing of loading full web page. Default path is /
  • List of network interfaces. Text value.
  • MAC address - lists all MAC addresses with interface names by default
  • Maximum number of opened files supported by OS.
  • Maximum number of processes supported by OS.
  • Memory used by a process. <name> process name (default: "all processes"). <user> user name (default: "all users"). <mode> possible values: avg, max, min, sum (default). <cmdline> filter by command line (supports regex). <memtype> type of process memory (supported on some platforms, see documentation). Example: proc.mem[,root].
  • Monitoring of Windows event logs. pattern, severity, eventid - regular expressions
  • Monitoring of log file with rotation. fileformat - [path][regexp], pattern - regular expression
  • Monitoring of log file. pattern - regular expression
  • Network interface input statistic. Integer value. If mode is missing bytes is used.
  • Network interface output statistic. Integer value. If mode is missing bytes is used.
  • Number of available processors.
  • Number of inodes for a given volume. If mode is missing total is used.
  • Number of processes. <name> and <user> same as in proc.mem item. <state> all (default), run, sleep, zomb. <cmdline> filter by command line (supports regex). Example: proc.num[apache2,www-data]. On Windows, only <name> and <user> are supported.
  • Number of users connected. Command who is used on agent side.
  • Out-of-window collision. Collisions count.
  • Performs a DNS query. On success returns a character string with the required type of information.
  • Returns detailed host information. String value
  • Returns hostname (or NetBIOS name (by default) on Windows). String value. Example of returned value: www.zabbix.com
  • Run specified command on the host.
  • Size of a given file. Size in bytes. File must have read permissions for user zabbix. Example: vfs.file.size[/var/log/syslog]
  • Software architecture
  • Software package list - lists all packages for all supported package managers by default
  • State of service. 0 - running, 1 - paused, 2 - start pending, 3 - pause pending, 4 - continue pending, 5 - stop pending, 6 - stopped, 7 - unknown, 255 - no such service
  • Sum of network interface incoming and outgoing statistics. Integer value. Mode - one of bytes (default), packets, errors or dropped
  • Swap in. If type is count - swapins is returned. If type is pages - pages swapped in is returned. If swap is missing all is used.
  • Swap out. If type is count - swapouts is returned. If type is pages - pages swapped in is returned. If swap is missing all is used.
  • Swap space. Number of bytes. If swap is missing all is used. If mode is missing free is used.
  • System local time. Time in seconds.
  • System uptime in seconds.
  • Timestamp of system boot.
  • Value of any performance counter, where "counter" parameter is the counter path and "interval" parameter is a number of last seconds, for which the agent returns an average value.
  • Version of zabbix_agent(d) running on monitored host. String value. Example of returned value: 1.1
  • Virtual memory statistics.

asaveljevs CLOSED

Comment by richlv [ 2015 May 08 ]

(2) added a small note that item key helper agent keys should be synced from the manual now at https://www.zabbix.org/wiki/PHP_coding_guidelines#Item_key_helper

asaveljevs CLOSED

Comment by richlv [ 2015 May 08 ]

for the record, r53513 both added the changelog entry and regenerated po files. both changes were supposed to go in, but in separate commits

Comment by richlv [ 2015 May 08 ]

merged to trunk in r53514.

Generated at Sat Apr 20 05:32:51 EEST 2024 using Jira 9.12.4#9120004-sha1:625303b708afdb767e17cb2838290c41888e9ff0.