1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
|
<?php
/*
** Zabbix
** Copyright (C) 2001-2019 Zabbix SIA
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**/
/**
* Class containing information about help items.
*/
class CHelpItems {
/**
* A list of all available help items grouped by item type.
*
* @see CHelpItems::getItems() for a description of the structure
*
* @var array
*/
protected $items = [];
public function __construct() {
$this->items = $this->getItems();
}
/**
* Returns the help items available for the given item type.
*
* @param int $type
*
* @return array
*/
public function getByType($type) {
return $this->items[$type];
}
/**
* Get list of all available help items grouped by item type.
*
* Each help item has the following properties:
* - key - default key
* - description - description of the item
*
* @return array
*/
protected function getItems() {
return [
ITEM_TYPE_ZABBIX => [
[
'key' => 'agent.hostname',
'description' => _('Agent host name. Returns string')
],
[
'key' => 'agent.ping',
'description' => _('Agent availability check. Returns nothing - unavailable; 1 - available')
],
[
'key' => 'agent.version',
'description' => _('Version of Zabbix agent. Returns string')
],
[
'key' => 'kernel.maxfiles',
'description' => _('Maximum number of opened files supported by OS. Returns integer')
],
[
'key' => 'kernel.maxproc',
'description' => _('Maximum number of processes supported by OS. Returns integer')
],
[
'key' => 'net.dns[<ip>,name,<type>,<timeout>,<count>,<protocol>]',
'description' => _('Checks if DNS service is up. Returns 0 - DNS is down (server did not respond or DNS resolution failed); 1 - DNS is up')
],
[
'key' => 'net.dns.record[<ip>,name,<type>,<timeout>,<count>,<protocol>]',
'description' => _('Performs a DNS query. Returns character string with the required type of information')
],
[
'key' => 'net.if.collisions[if]',
'description' => _('Number of out-of-window collisions. Returns integer')
],
[
'key' => 'net.if.in[if,<mode>]',
'description' => _('Incoming traffic statistics on network interface. Returns integer')
],
[
'key' => 'net.if.list',
'description' => _('Network interface list (includes interface type, status, IPv4 address, description). Returns text')
],
[
'key' => 'net.if.out[if,<mode>]',
'description' => _('Outgoing traffic statistics on network interface. Returns integer')
],
[
'key' => 'net.if.total[if,<mode>]',
'description' => _('Sum of incoming and outgoing traffic statistics on network interface. Returns integer')
],
[
'key' => 'net.tcp.listen[port]',
'description' => _('Checks if this TCP port is in LISTEN state. Returns 0 - it is not in LISTEN state; 1 - it is in LISTEN state')
],
[
'key' => 'net.tcp.port[<ip>,port]',
'description' => _('Checks if it is possible to make TCP connection to specified port. Returns 0 - cannot connect; 1 - can connect')
],
[
'key' => 'net.tcp.service[service,<ip>,<port>]',
'description' => _('Checks if service is running and accepting TCP connections. Returns 0 - service is down; 1 - service is running')
],
[
'key' => 'net.tcp.service.perf[service,<ip>,<port>]',
'description' => _('Checks performance of TCP service. Returns 0 - service is down; seconds - the number of seconds spent while connecting to the service')
],
[
'key' => 'net.udp.listen[port]',
'description' => _('Checks if this UDP port is in LISTEN state. Returns 0 - it is not in LISTEN state; 1 - it is in LISTEN state')
],
[
'key' => 'net.udp.service[service,<ip>,<port>]',
'description' => _('Checks if service is running and responding to UDP requests. Returns 0 - service is down; 1 - service is running')
],
[
'key' => 'net.udp.service.perf[service,<ip>,<port>]',
'description' => _('Checks performance of UDP service. Returns 0 - service is down; seconds - the number of seconds spent waiting for response from the service')
],
[
'key' => 'perf_counter[counter,<interval>]',
'description' => _('Value of any Windows performance counter. Returns integer, float, string or text (depending on the request)')
],
[
'key' => 'proc.cpu.util[<name>,<user>,<type>,<cmdline>,<mode>,<zone>]',
'description' => _('Process CPU utilisation percentage. Returns float')
],
[
'key' => 'proc.mem[<name>,<user>,<mode>,<cmdline>,<memtype>]',
'description' => _('Memory used by process in bytes. Returns integer')
],
[
'key' => 'proc.num[<name>,<user>,<state>,<cmdline>]',
'description' => _('The number of processes. Returns integer')
],
[
'key' => 'proc_info[process,<attribute>,<type>]',
'description' => _('Various information about specific process(es). Returns float')
],
[
'key' => 'sensor[device,sensor,<mode>]',
'description' => _('Hardware sensor reading. Returns float')
],
[
'key' => 'service.info[service,<param>]',
'description' => _('Information about a service. Returns integer with param as state, startup; string - with param as displayname, path, user; text - with param as description; Specifically for state: 0 - running, 1 - paused, 2 - start pending, 3 - pause pending, 4 - continue pending, 5 - stop pending, 6 - stopped, 7 - unknown, 255 - no such service; Specifically for startup: 0 - automatic, 1 - automatic delayed, 2 - manual, 3 - disabled, 4 - unknown')
],
[
'key' => 'services[<type>,<state>,<exclude>]',
'description' => _('Listing of services. Returns 0 - if empty; text - list of services separated by a newline')
],
[
'key' => 'system.boottime',
'description' => _('System boot time. Returns integer (Unix timestamp)')
],
[
'key' => 'system.cpu.intr',
'description' => _('Device interrupts. Returns integer')
],
[
'key' => 'system.cpu.load[<cpu>,<mode>]',
'description' => _('CPU load. Returns float')
],
[
'key' => 'system.cpu.num[<type>]',
'description' => _('Number of CPUs. Returns integer')
],
[
'key' => 'system.cpu.switches',
'description' => _('Count of context switches. Returns integer')
],
[
'key' => 'system.cpu.util[<cpu>,<type>,<mode>]',
'description' => _('CPU utilisation percentage. Returns float')
],
[
'key' => 'system.hostname[<type>]',
'description' => _('System host name. Returns string')
],
[
'key' => 'system.hw.chassis[<info>]',
'description' => _('Chassis information. Returns string')
],
[
'key' => 'system.hw.cpu[<cpu>,<info>]',
'description' => _('CPU information. Returns string or integer')
],
[
'key' => 'system.hw.devices[<type>]',
'description' => _('Listing of PCI or USB devices. Returns text')
],
[
'key' => 'system.hw.macaddr[<interface>,<format>]',
'description' => _('Listing of MAC addresses. Returns string')
],
[
'key' => 'system.localtime[<type>]',
'description' => _('System time. Returns integer with type as utc; string - with type as local')
],
[
'key' => 'system.run[command,<mode>]',
'description' => _('Run specified command on the host. Returns text result of the command; 1 - with mode as nowait (regardless of command result)')
],
[
'key' => 'system.stat[resource,<type>]',
'description' => _('System statistics. Returns integer or float')
],
[
'key' => 'system.sw.arch',
'description' => _('Software architecture information. Returns string')
],
[
'key' => 'system.sw.os[<info>]',
'description' => _('Operating system information. Returns string')
],
[
'key' => 'system.sw.packages[<package>,<manager>,<format>]',
'description' => _('Listing of installed packages. Returns text')
],
[
'key' => 'system.swap.in[<device>,<type>]',
'description' => _('Swap in (from device into memory) statistics. Returns integer')
],
[
'key' => 'system.swap.out[<device>,<type>]',
'description' => _('Swap out (from memory onto device) statistics. Returns integer')
],
[
'key' => 'system.swap.size[<device>,<type>]',
'description' => _('Swap space size in bytes or in percentage from total. Returns integer for bytes; float for percentage')
],
[
'key' => 'system.uname',
'description' => _('Identification of the system. Returns string')
],
[
'key' => 'system.uptime',
'description' => _('System uptime in seconds. Returns integer')
],
[
'key' => 'system.users.num',
'description' => _('Number of users logged in. Returns integer')
],
[
'key' => 'vfs.dev.read[<device>,<type>,<mode>]',
'description' => _('Disk read statistics. Returns integer with type in sectors, operations, bytes; float with type in sps, ops, bps')
],
[
'key' => 'vfs.dev.write[<device>,<type>,<mode>]',
'description' => _('Disk write statistics. Returns integer with type in sectors, operations, bytes; float with type in sps, ops, bps')
],
[
'key' => 'vfs.dir.count[dir,<regex_incl>,<regex_excl>,<types_incl>,<types_excl>,<max_depth>,<min_size>,<max_size>,<min_age>,<max_age>]',
'description' => _('Count of directory entries, recursively. Returns integer')
],
[
'key' => 'vfs.dir.size[dir,<regex_incl>,<regex_excl>,<mode>,<max_depth>]',
'description' => _('Directory size (in bytes). Returns integer')
],
[
'key' => 'vfs.file.cksum[file]',
'description' => _('File checksum, calculated by the UNIX cksum algorithm. Returns integer')
],
[
'key' => 'vfs.file.contents[file,<encoding>]',
'description' => _('Retrieving contents of a file. Returns text')
],
[
'key' => 'vfs.file.exists[file]',
'description' => _('Checks if file exists. Returns 0 - not found; 1 - regular file or a link (symbolic or hard) to regular file exists')
],
[
'key' => 'vfs.file.md5sum[file]',
'description' => _('MD5 checksum of file. Returns character string (MD5 hash of the file)')
],
[
'key' => 'vfs.file.regexp[file,regexp,<encoding>,<start line>,<end line>,<output>]',
'description' => _('Find string in a file. Returns the line containing the matched string, or as specified by the optional output parameter')
],
[
'key' => 'vfs.file.regmatch[file,regexp,<encoding>,<start line>,<end line>]',
'description' => _('Find string in a file. Returns 0 - match not found; 1 - found')
],
[
'key' => 'vfs.file.size[file]',
'description' => _('File size (in bytes). Returns integer')
],
[
'key' => 'vfs.file.time[file,<mode>]',
'description' => _('File time information. Returns integer (Unix timestamp)')
],
[
'key' => 'vfs.fs.inode[fs,<mode>]',
'description' => _('Number or percentage of inodes. Returns integer for number; float for percentage')
],
[
'key' => 'vfs.fs.size[fs,<mode>]',
'description' => _('Disk space in bytes or in percentage from total. Returns integer for bytes; float for percentage')
],
[
'key' => 'vm.memory.size[<mode>]',
'description' => _('Memory size in bytes or in percentage from total. Returns integer for bytes; float for percentage')
],
[
'key' => 'vm.vmemory.size[<type>]',
'description' => _('Virtual space size in bytes or in percentage from total. Returns integer for bytes; float for percentage')
],
[
'key' => 'web.page.get[host,<path>,<port>]',
'description' => _('Get content of web page. Returns web page source as text')
],
[
'key' => 'web.page.perf[host,<path>,<port>]',
'description' => _('Loading time of full web page (in seconds). Returns float')
],
[
'key' => 'web.page.regexp[host,<path>,<port>,regexp,<length>,<output>]',
'description' => _('Find string on a web page. Returns the matched string, or as specified by the optional output parameter')
],
[
'key' => 'wmi.get[<namespace>,<query>]',
'description' => _('Execute WMI query and return the first selected object. Returns integer, float, string or text (depending on the request)')
]
],
ITEM_TYPE_ZABBIX_ACTIVE => [
[
'key' => 'agent.hostname',
'description' => _('Agent host name. Returns string')
],
[
'key' => 'agent.ping',
'description' => _('Agent availability check. Returns nothing - unavailable; 1 - available')
],
[
'key' => 'agent.version',
'description' => _('Version of Zabbix agent. Returns string')
],
[
'key' => 'eventlog[name,<regexp>,<severity>,<source>,<eventid>,<maxlines>,<mode>]',
'description' => _('Event log monitoring. Returns log')
],
[
'key' => 'kernel.maxfiles',
'description' => _('Maximum number of opened files supported by OS. Returns integer')
],
[
'key' => 'kernel.maxproc',
'description' => _('Maximum number of processes supported by OS. Returns integer')
],
[
'key' => 'log[file,<regexp>,<encoding>,<maxlines>,<mode>,<output>,<maxdelay>]',
'description' => _('Log file monitoring. Returns log')
],
[
'key' => 'log.count[file,<regexp>,<encoding>,<maxproclines>,<mode>,<maxdelay>]',
'description' => _('Count of matched lines in log file monitoring. Returns integer')
],
[
'key' => 'logrt[file_regexp,<regexp>,<encoding>,<maxlines>,<mode>,<output>,<maxdelay>,<options>]',
'description' => _('Log file monitoring with log rotation support. Returns log')
],
[
'key' => 'logrt.count[file_regexp,<regexp>,<encoding>,<maxproclines>,<mode>,<maxdelay>,<options>]',
'description' => _('Count of matched lines in log file monitoring with log rotation support. Returns integer')
],
[
'key' => 'net.dns[<ip>,name,<type>,<timeout>,<count>,<protocol>]',
'description' => _('Checks if DNS service is up. Returns 0 - DNS is down (server did not respond or DNS resolution failed); 1 - DNS is up')
],
[
'key' => 'net.dns.record[<ip>,name,<type>,<timeout>,<count>,<protocol>]',
'description' => _('Performs a DNS query. Returns character string with the required type of information')
],
[
'key' => 'net.if.collisions[if]',
'description' => _('Number of out-of-window collisions. Returns integer')
],
[
'key' => 'net.if.in[if,<mode>]',
'description' => _('Incoming traffic statistics on network interface. Returns integer')
],
[
'key' => 'net.if.list',
'description' => _('Network interface list (includes interface type, status, IPv4 address, description). Returns text')
],
[
'key' => 'net.if.out[if,<mode>]',
'description' => _('Outgoing traffic statistics on network interface. Returns integer')
],
[
'key' => 'net.if.total[if,<mode>]',
'description' => _('Sum of incoming and outgoing traffic statistics on network interface. Returns integer')
],
[
'key' => 'net.tcp.listen[port]',
'description' => _('Checks if this TCP port is in LISTEN state. Returns 0 - it is not in LISTEN state; 1 - it is in LISTEN state')
],
[
'key' => 'net.tcp.port[<ip>,port]',
'description' => _('Checks if it is possible to make TCP connection to specified port. Returns 0 - cannot connect; 1 - can connect')
],
[
'key' => 'net.tcp.service[service,<ip>,<port>]',
'description' => _('Checks if service is running and accepting TCP connections. Returns 0 - service is down; 1 - service is running')
],
[
'key' => 'net.tcp.service.perf[service,<ip>,<port>]',
'description' => _('Checks performance of TCP service. Returns 0 - service is down; seconds - the number of seconds spent while connecting to the service')
],
[
'key' => 'net.udp.listen[port]',
'description' => _('Checks if this UDP port is in LISTEN state. Returns 0 - it is not in LISTEN state; 1 - it is in LISTEN state')
],
[
'key' => 'net.udp.service[service,<ip>,<port>]',
'description' => _('Checks if service is running and responding to UDP requests. Returns 0 - service is down; 1 - service is running')
],
[
'key' => 'net.udp.service.perf[service,<ip>,<port>]',
'description' => _('Checks performance of UDP service. Returns 0 - service is down; seconds - the number of seconds spent waiting for response from the service')
],
[
'key' => 'perf_counter[counter,<interval>]',
'description' => _('Value of any Windows performance counter. Returns integer, float, string or text (depending on the request)')
],
[
'key' => 'proc.cpu.util[<name>,<user>,<type>,<cmdline>,<mode>,<zone>]',
'description' => _('Process CPU utilisation percentage. Returns float')
],
[
'key' => 'proc.mem[<name>,<user>,<mode>,<cmdline>,<memtype>]',
'description' => _('Memory used by process in bytes. Returns integer')
],
[
'key' => 'proc.num[<name>,<user>,<state>,<cmdline>]',
'description' => _('The number of processes. Returns integer')
],
[
'key' => 'proc_info[process,<attribute>,<type>]',
'description' => _('Various information about specific process(es). Returns float')
],
[
'key' => 'sensor[device,sensor,<mode>]',
'description' => _('Hardware sensor reading. Returns float')
],
[
'key' => 'service.info[service,<param>]',
'description' => _('Information about a service. Returns integer with param as state, startup; string - with param as displayname, path, user; text - with param as description; Specifically for state: 0 - running, 1 - paused, 2 - start pending, 3 - pause pending, 4 - continue pending, 5 - stop pending, 6 - stopped, 7 - unknown, 255 - no such service; Specifically for startup: 0 - automatic, 1 - automatic delayed, 2 - manual, 3 - disabled, 4 - unknown')
],
[
'key' => 'services[<type>,<state>,<exclude>]',
'description' => _('Listing of services. Returns 0 - if empty; text - list of services separated by a newline')
],
[
'key' => 'system.boottime',
'description' => _('System boot time. Returns integer (Unix timestamp)')
],
[
'key' => 'system.cpu.intr',
'description' => _('Device interrupts. Returns integer')
],
[
'key' => 'system.cpu.load[<cpu>,<mode>]',
'description' => _('CPU load. Returns float')
],
[
'key' => 'system.cpu.num[<type>]',
'description' => _('Number of CPUs. Returns integer')
],
[
'key' => 'system.cpu.switches',
'description' => _('Count of context switches. Returns integer')
],
[
'key' => 'system.cpu.util[<cpu>,<type>,<mode>]',
'description' => _('CPU utilisation percentage. Returns float')
],
[
'key' => 'system.hostname[<type>]',
'description' => _('System host name. Returns string')
],
[
'key' => 'system.hw.chassis[<info>]',
'description' => _('Chassis information. Returns string')
],
[
'key' => 'system.hw.cpu[<cpu>,<info>]',
'description' => _('CPU information. Returns string or integer')
],
[
'key' => 'system.hw.devices[<type>]',
'description' => _('Listing of PCI or USB devices. Returns text')
],
[
'key' => 'system.hw.macaddr[<interface>,<format>]',
'description' => _('Listing of MAC addresses. Returns string')
],
[
'key' => 'system.localtime[<type>]',
'description' => _('System time. Returns integer with type as utc; string - with type as local')
],
[
'key' => 'system.run[command,<mode>]',
'description' => _('Run specified command on the host. Returns text result of the command; 1 - with mode as nowait (regardless of command result)')
],
[
'key' => 'system.stat[resource,<type>]',
'description' => _('System statistics. Returns integer or float')
],
[
'key' => 'system.sw.arch',
'description' => _('Software architecture information. Returns string')
],
[
'key' => 'system.sw.os[<info>]',
'description' => _('Operating system information. Returns string')
],
[
'key' => 'system.sw.packages[<package>,<manager>,<format>]',
'description' => _('Listing of installed packages. Returns text')
],
[
'key' => 'system.swap.in[<device>,<type>]',
'description' => _('Swap in (from device into memory) statistics. Returns integer')
],
[
'key' => 'system.swap.out[<device>,<type>]',
'description' => _('Swap out (from memory onto device) statistics. Returns integer')
],
[
'key' => 'system.swap.size[<device>,<type>]',
'description' => _('Swap space size in bytes or in percentage from total. Returns integer for bytes; float for percentage')
],
[
'key' => 'system.uname',
'description' => _('Identification of the system. Returns string')
],
[
'key' => 'system.uptime',
'description' => _('System uptime in seconds. Returns integer')
],
[
'key' => 'system.users.num',
'description' => _('Number of users logged in. Returns integer')
],
[
'key' => 'vfs.dev.read[<device>,<type>,<mode>]',
'description' => _('Disk read statistics. Returns integer with type in sectors, operations, bytes; float with type in sps, ops, bps')
],
[
'key' => 'vfs.dev.write[<device>,<type>,<mode>]',
'description' => _('Disk write statistics. Returns integer with type in sectors, operations, bytes; float with type in sps, ops, bps')
],
[
'key' => 'vfs.dir.count[dir,<regex_incl>,<regex_excl>,<types_incl>,<types_excl>,<max_depth>,<min_size>,<max_size>,<min_age>,<max_age>]',
'description' => _('Count of directory entries, recursively. Returns integer')
],
[
'key' => 'vfs.dir.size[dir,<regex_incl>,<regex_excl>,<mode>,<max_depth>]',
'description' => _('Directory size (in bytes). Returns integer')
],
[
'key' => 'vfs.file.cksum[file]',
'description' => _('File checksum, calculated by the UNIX cksum algorithm. Returns integer')
],
[
'key' => 'vfs.file.contents[file,<encoding>]',
'description' => _('Retrieving contents of a file. Returns text')
],
[
'key' => 'vfs.file.exists[file]',
'description' => _('Checks if file exists. Returns 0 - not found; 1 - regular file or a link (symbolic or hard) to regular file exists')
],
[
'key' => 'vfs.file.md5sum[file]',
'description' => _('MD5 checksum of file. Returns character string (MD5 hash of the file)')
],
[
'key' => 'vfs.file.regexp[file,regexp,<encoding>,<start line>,<end line>,<output>]',
'description' => _('Find string in a file. Returns the line containing the matched string, or as specified by the optional output parameter')
],
[
'key' => 'vfs.file.regmatch[file,regexp,<encoding>,<start line>,<end line>]',
'description' => _('Find string in a file. Returns 0 - match not found; 1 - found')
],
[
'key' => 'vfs.file.size[file]',
'description' => _('File size (in bytes). Returns integer')
],
[
'key' => 'vfs.file.time[file,<mode>]',
'description' => _('File time information. Returns integer (Unix timestamp)')
],
[
'key' => 'vfs.fs.inode[fs,<mode>]',
'description' => _('Number or percentage of inodes. Returns integer for number; float for percentage')
],
[
'key' => 'vfs.fs.size[fs,<mode>]',
'description' => _('Disk space in bytes or in percentage from total. Returns integer for bytes; float for percentage')
],
[
'key' => 'vm.memory.size[<mode>]',
'description' => _('Memory size in bytes or in percentage from total. Returns integer for bytes; float for percentage')
],
[
'key' => 'vm.vmemory.size[<type>]',
'description' => _('Virtual space size in bytes or in percentage from total. Returns integer for bytes; float for percentage')
],
[
'key' => 'web.page.get[host,<path>,<port>]',
'description' => _('Get content of web page. Returns web page source as text')
],
[
'key' => 'web.page.perf[host,<path>,<port>]',
'description' => _('Loading time of full web page (in seconds). Returns float')
],
[
'key' => 'web.page.regexp[host,<path>,<port>,regexp,<length>,<output>]',
'description' => _('Find string on a web page. Returns the matched string, or as specified by the optional output parameter')
],
[
'key' => 'wmi.get[<namespace>,<query>]',
'description' => _('Execute WMI query and return the first selected object. Returns integer, float, string or text (depending on the request)')
]
],
ITEM_TYPE_AGGREGATE => [
[
'key' => 'grpfunc[group,key,func,<param>]',
'description' => _('Aggregate checks do not require any agent running on a host being monitored. Zabbix server collects aggregate information by doing direct database queries. See Zabbix Manual.')
]
],
ITEM_TYPE_SIMPLE => [
[
'key' => 'icmpping[<target>,<packets>,<interval>,<size>,<timeout>]',
'description' => _('Checks if server is accessible by ICMP ping. 0 - ICMP ping fails. 1 - ICMP ping successful.')
],
[
'key' => 'icmppingloss[<target>,<packets>,<interval>,<size>,<timeout>]',
'description' => _('Returns percentage of lost ICMP ping packets.')
],
[
'key' => 'icmppingsec[<target>,<packets>,<interval>,<size>,<timeout>,<mode>]',
'description' => _('Returns ICMP ping response time in seconds. Example: 0.02')
],
[
'key' => 'net.tcp.service[service,<ip>,<port>]',
'description' => _('Checks if service is running and accepting TCP connections. Returns 0 - service is down; 1 - service is running')
],
[
'key' => 'net.tcp.service.perf[service,<ip>,<port>]',
'description' => _('Checks performance of TCP service. Returns 0 - service is down; seconds - the number of seconds spent while connecting to the service')
],
[
'key' => 'net.udp.service[service,<ip>,<port>]',
'description' => _('Checks if service is running and responding to UDP requests. Returns 0 - service is down; 1 - service is running')
],
[
'key' => 'net.udp.service.perf[service,<ip>,<port>]',
'description' => _('Checks performance of UDP service. Returns 0 - service is down; seconds - the number of seconds spent waiting for response from the service')
],
[
'key' => 'vmware.cluster.status[<url>,<name>]',
'description' => _('VMware cluster status, <url> - VMware service URL, <name> - VMware cluster name')
],
[
'key' => 'vmware.eventlog[<url>]',
'description' => _('VMware event log, <url> - VMware service URL')
],
[
'key' => 'vmware.fullname[<url>]',
'description' => _('VMware service full name, <url> - VMware service URL')
],
[
'key' => 'vmware.hv.cluster.name[<url>,<uuid>]',
'description' => _('VMware hypervisor cluster name, <url> - VMware service URL, <uuid> - VMware hypervisor host name')
],
[
'key' => 'vmware.hv.cpu.usage[<url>,<uuid>]',
'description' => _('VMware hypervisor processor usage in Hz, <url> - VMware service URL, <uuid> - VMware hypervisor host name')
],
[
'key' => 'vmware.hv.datastore.read[<url>,<uuid>,<datastore>,<mode>]',
'description' => _('VMware hypervisor datastore read statistics, <url> - VMware service URL, <uuid> - VMware hypervisor host name, <datastore> - datastore name, <mode> - latency')
],
[
'key' => 'vmware.hv.datastore.size[<url>,<uuid>,<datastore>,<mode>]',
'description' => _('VMware datastore capacity statistics in bytes or in percentage from total. Returns integer for bytes; float for percentage')
],
[
'key' => 'vmware.hv.datastore.write[<url>,<uuid>,<datastore>,<mode>]',
'description' => _('VMware hypervisor datastore write statistics, <url> - VMware service URL, <uuid> - VMware hypervisor host name, <datastore> - datastore name, <mode> - latency')
],
[
'key' => 'vmware.hv.full.name[<url>,<uuid>]',
'description' => _('VMware hypervisor name, <url> - VMware service URL, <uuid> - VMware hypervisor host name')
],
[
'key' => 'vmware.hv.hw.cpu.freq[<url>,<uuid>]',
'description' => _('VMware hypervisor processor frequency, <url> - VMware service URL, <uuid> - VMware hypervisor host name')
],
[
'key' => 'vmware.hv.hw.cpu.model[<url>,<uuid>]',
'description' => _('VMware hypervisor processor model, <url> - VMware service URL, <uuid> - VMware hypervisor host name')
],
[
'key' => 'vmware.hv.hw.cpu.num[<url>,<uuid>]',
'description' => _('Number of processor cores on VMware hypervisor, <url> - VMware service URL, <uuid> - VMware hypervisor host name')
],
[
'key' => 'vmware.hv.hw.cpu.threads[<url>,<uuid>]',
'description' => _('Number of processor threads on VMware hypervisor, <url> - VMware service URL, <uuid> - VMware hypervisor host name')
],
[
'key' => 'vmware.hv.hw.memory[<url>,<uuid>]',
'description' => _('VMware hypervisor total memory size, <url> - VMware service URL, <uuid> - VMware hypervisor host name')
],
[
'key' => 'vmware.hv.hw.model[<url>,<uuid>]',
'description' => _('VMware hypervisor model, <url> - VMware service URL, <uuid> - VMware hypervisor host name')
],
[
'key' => 'vmware.hv.hw.uuid[<url>,<uuid>]',
'description' => _('VMware hypervisor BIOS uuid, <url> - VMware service URL, <uuid> - VMware hypervisor host name')
],
[
'key' => 'vmware.hv.hw.vendor[<url>,<uuid>]',
'description' => _('VMware hypervisor vendor name, <url> - VMware service URL, <uuid> - VMware hypervisor host name')
],
[
'key' => 'vmware.hv.memory.size.ballooned[<url>,<uuid>]',
'description' => _('VMware hypervisor ballooned memory size, <url> - VMware service URL, <uuid> - VMware hypervisor host name')
],
[
'key' => 'vmware.hv.memory.used[<url>,<uuid>]',
'description' => _('VMware hypervisor used memory size, <url> - VMware service URL, <uuid> - VMware hypervisor host name')
],
[
'key' => 'vmware.hv.network.in[<url>,<uuid>,<mode>]',
'description' => _('VMware hypervisor network input statistics, <url> - VMware service URL, <uuid> - VMware hypervisor host name, <mode> - bps')
],
[
'key' => 'vmware.hv.network.out[<url>,<uuid>,<mode>]',
'description' => _('VMware hypervisor network output statistics, <url> - VMware service URL, <uuid> - VMware hypervisor host name, <mode> - bps')
],
[
'key' => 'vmware.hv.perfcounter[<url>,<uuid>,<path>,<instance>]',
'description' => _('VMware hypervisor performance counter, <url> - VMware service URL, <uuid> - VMware hypervisor host name, <path> - performance counter path, <instance> - performance counter instance')
],
[
'key' => 'vmware.hv.status[<url>,<uuid>]',
'description' => _('VMware hypervisor status, <url> - VMware service URL, <uuid> - VMware hypervisor host name')
],
[
'key' => 'vmware.hv.uptime[<url>,<uuid>]',
'description' => _('VMware hypervisor uptime, <url> - VMware service URL, <uuid> - VMware hypervisor host name')
],
[
'key' => 'vmware.hv.version[<url>,<uuid>]',
'description' => _('VMware hypervisor version, <url> - VMware service URL, <uuid> - VMware hypervisor host name')
],
[
'key' => 'vmware.hv.vm.num[<url>,<uuid>]',
'description' => _('Number of virtual machines on VMware hypervisor, <url> - VMware service URL, <uuid> - VMware hypervisor host name')
],
[
'key' => 'vmware.version[<url>]',
'description' => _('VMware service version, <url> - VMware service URL')
],
[
'key' => 'vmware.vm.cluster.name[<url>,<uuid>]',
'description' => _('VMware virtual machine name, <url> - VMware service URL, <uuid> - VMware virtual machine host name')
],
[
'key' => 'vmware.vm.cpu.num[<url>,<uuid>]',
'description' => _('Number of processors on VMware virtual machine, <url> - VMware service URL, <uuid> - VMware virtual machine host name')
],
[
'key' => 'vmware.vm.cpu.ready[<url>,<uuid>]',
'description' => _('VMware virtual machine processor ready time ms, <url> - VMware service URL, <uuid> - VMware virtual machine host name')
],
[
'key' => 'vmware.vm.cpu.usage[<url>,<uuid>]',
'description' => _('VMware virtual machine processor usage in Hz, <url> - VMware service URL, <uuid> - VMware virtual machine host name')
],
[
'key' => 'vmware.vm.hv.name[<url>,<uuid>]',
'description' => _('VMware virtual machine hypervisor name, <url> - VMware service URL, <uuid> - VMware virtual machine host name')
],
[
'key' => 'vmware.vm.memory.size.ballooned[<url>,<uuid>]',
'description' => _('VMware virtual machine ballooned memory size, <url> - VMware service URL, <uuid> - VMware virtual machine host name')
],
[
'key' => 'vmware.vm.memory.size.compressed[<url>,<uuid>]',
'description' => _('VMware virtual machine compressed memory size, <url> - VMware service URL, <uuid> - VMware virtual machine host name')
],
[
'key' => 'vmware.vm.memory.size.private[<url>,<uuid>]',
'description' => _('VMware virtual machine private memory size, <url> - VMware service URL, <uuid> - VMware virtual machine host name')
],
[
'key' => 'vmware.vm.memory.size.shared[<url>,<uuid>]',
'description' => _('VMware virtual machine shared memory size, <url> - VMware service URL, <uuid> - VMware virtual machine host name')
],
[
'key' => 'vmware.vm.memory.size.swapped[<url>,<uuid>]',
'description' => _('VMware virtual machine swapped memory size, <url> - VMware service URL, <uuid> - VMware virtual machine host name')
],
[
'key' => 'vmware.vm.memory.size.usage.guest[<url>,<uuid>]',
'description' => _('VMware virtual machine guest memory usage, <url> - VMware service URL, <uuid> - VMware virtual machine host name')
],
[
'key' => 'vmware.vm.memory.size.usage.host[<url>,<uuid>]',
'description' => _('VMware virtual machine host memory usage, <url> - VMware service URL, <uuid> - VMware virtual machine host name')
],
[
'key' => 'vmware.vm.memory.size[<url>,<uuid>]',
'description' => _('VMware virtual machine total memory size, <url> - VMware service URL, <uuid> - VMware virtual machine host name')
],
[
'key' => 'vmware.vm.net.if.in[<url>,<uuid>,<instance>,<mode>]',
'description' => _('VMware virtual machine network interface input statistics, <url> - VMware service URL, <uuid> - VMware virtual machine host name, <instance> - network interface instance, <mode> - bps/pps - bytes/packets per second')
],
[
'key' => 'vmware.vm.net.if.out[<url>,<uuid>,<instance>,<mode>]',
'description' => _('VMware virtual machine network interface output statistics, <url> - VMware service URL, <uuid> - VMware virtual machine host name, <instance> - network interface instance, <mode> - bps/pps - bytes/packets per second')
],
[
'key' => 'vmware.vm.perfcounter[<url>,<uuid>,<path>,<instance>]',
'description' => _('VMware virtual machine performance counter, <url> - VMware service URL, <uuid> - VMware virtual machine host name, <path> - performance counter path, <instance> - performance counter instance')
],
[
'key' => 'vmware.vm.powerstate[<url>,<uuid>]',
'description' => _('VMware virtual machine power state, <url> - VMware service URL, <uuid> - VMware virtual machine host name')
],
[
'key' => 'vmware.vm.storage.committed[<url>,<uuid>]',
'description' => _('VMware virtual machine committed storage space, <url> - VMware service URL, <uuid> - VMware virtual machine host name')
],
[
'key' => 'vmware.vm.storage.uncommitted[<url>,<uuid>]',
'description' => _('VMware virtual machine uncommitted storage space, <url> - VMware service URL, <uuid> - VMware virtual machine host name')
],
[
'key' => 'vmware.vm.storage.unshared[<url>,<uuid>]',
'description' => _('VMware virtual machine unshared storage space, <url> - VMware service URL, <uuid> - VMware virtual machine host name')
],
[
'key' => 'vmware.vm.uptime[<url>,<uuid>]',
'description' => _('VMware virtual machine uptime, <url> - VMware service URL, <uuid> - VMware virtual machine host name')
],
[
'key' => 'vmware.vm.vfs.dev.read[<url>,<uuid>,<instance>,<mode>]',
'description' => _('VMware virtual machine disk device read statistics, <url> - VMware service URL, <uuid> - VMware virtual machine host name, <instance> - disk device instance, <mode> - bps/ops - bytes/operations per second')
],
[
'key' => 'vmware.vm.vfs.dev.write[<url>,<uuid>,<instance>,<mode>]',
'description' => _('VMware virtual machine disk device write statistics, <url> - VMware service URL, <uuid> - VMware virtual machine host name, <instance> - disk device instance, <mode> - bps/ops - bytes/operations per second')
],
[
'key' => 'vmware.vm.vfs.fs.size[<url>,<uuid>,<fsname>,<mode>]',
'description' => _('VMware virtual machine file system statistics, <url> - VMware service URL, <uuid> - VMware virtual machine host name, <fsname> - file system name, <mode> - total/free/used/pfree/pused')
]
],
ITEM_TYPE_SNMPTRAP => [
[
'key' => 'snmptrap.fallback',
'description' => _('Catches all SNMP traps that were not caught by any of snmptrap[] items.')
],
[
'key' => 'snmptrap[<regex>]',
'description' => _('Catches all SNMP traps that match regex. If regexp is unspecified, catches any trap.')
]
],
ITEM_TYPE_INTERNAL => [
[
'key' => 'zabbix[boottime]',
'description' => _('Startup time of Zabbix server, Unix timestamp.')
],
[
'key' => 'zabbix[history]',
'description' => _('Number of values stored in table HISTORY.')
],
[
'key' => 'zabbix[history_log]',
'description' => _('Number of values stored in table HISTORY_LOG.')
],
[
'key' => 'zabbix[history_str]',
'description' => _('Number of values stored in table HISTORY_STR.')
],
[
'key' => 'zabbix[history_text]',
'description' => _('Number of values stored in table HISTORY_TEXT.')
],
[
'key' => 'zabbix[history_uint]',
'description' => _('Number of values stored in table HISTORY_UINT.')
],
[
'key' => 'zabbix[host,,items]',
'description' => _('Number of enabled items on the host.')
],
[
'key' => 'zabbix[host,,items_unsupported]',
'description' => _('Number of unsupported items on the host.')
],
[
'key' => 'zabbix[host,,maintenance]',
'description' => _('Returns current maintenance status of the host.')
],
[
'key' => 'zabbix[host,discovery,interfaces]',
'description' => _('Returns a JSON object describing the host network interfaces configured in Zabbix. Can be used for LLD.')
],
[
'key' => 'zabbix[host,<type>,available]',
'description' => _('Returns availability of a particular type of checks on the host. Value of this item corresponds to availability icons in the host list. Valid types are: agent, snmp, ipmi, jmx.')
],
[
'key' => 'zabbix[hosts]',
'description' => _('Number of monitored hosts')
],
[
'key' => 'zabbix[items]',
'description' => _('Number of items in Zabbix database.')
],
[
'key' => 'zabbix[items_unsupported]',
'description' => _('Number of unsupported items in Zabbix database.')
],
[
'key' => 'zabbix[java,,<param>]',
'description' => _('Returns information associated with Zabbix Java gateway. Valid params are: ping, version.')
],
[
'key' => 'zabbix[process,<type>,<mode>,<state>]',
'description' => _('Time a particular Zabbix process or a group of processes (identified by <type> and <mode>) spent in <state> in percentage.')
],
[
'key' => 'zabbix[proxy,<name>,<param>]',
'description' => _('Time of proxy last access. Name - proxy name. Param - lastaccess. Unix timestamp.')
],
[
'key' => 'zabbix[proxy_history]',
'description' => _('Number of items in proxy history that are not yet sent to the server')
],
[
'key' => 'zabbix[queue,<from>,<to>]',
'description' => _('Number of items in the queue which are delayed by from to to seconds, inclusive.')
],
[
'key' => 'zabbix[rcache,<cache>,<mode>]',
'description' => _('Configuration cache statistics. Cache - buffer (modes: pfree, total, used, free).')
],
[
'key' => 'zabbix[requiredperformance]',
'description' => _('Required performance of the Zabbix server, in new values per second expected.')
],
[
'key' => 'zabbix[trends]',
'description' => _('Number of values stored in table TRENDS.')
],
[
'key' => 'zabbix[trends_uint]',
'description' => _('Number of values stored in table TRENDS_UINT.')
],
[
'key' => 'zabbix[triggers]',
'description' => _('Number of triggers in Zabbix database.')
],
[
'key' => 'zabbix[uptime]',
'description' => _('Uptime of Zabbix server process in seconds.')
],
[
'key' => 'zabbix[vcache,buffer,<mode>]',
'description' => _('Value cache statistics. Valid modes are: total, free, pfree, used and pused.')
],
[
'key' => 'zabbix[vcache,cache,<parameter>]',
'description' => _('Value cache effectiveness. Valid parameters are: requests, hits and misses.')
],
[
'key' => 'zabbix[vmware,buffer,<mode>]',
'description' => _('VMware cache statistics. Valid modes are: total, free, pfree, used and pused.')
],
[
'key' => 'zabbix[wcache,<cache>,<mode>]',
'description' => _('Data cache statistics. Cache - one of values (modes: all, float, uint, str, log, text), history (modes: pfree, total, used, free), trend (modes: pfree, total, used, free), text (modes: pfree, total, used, free).')
]
],
ITEM_TYPE_DB_MONITOR => [
[
'key' => 'db.odbc.select[<unique short description>,<dsn>]',
'description' => _('Return first column of the first row of the SQL query result.')
],
[
'key' => 'db.odbc.discovery[<unique short description>,<dsn>]',
'description' => _('Transform SQL query result into a JSON object for low-level discovery.')
]
],
ITEM_TYPE_JMX => [
[
'key' => 'jmx[object_name,attribute_name]',
'description' => _('Return value of an attribute of MBean object.')
],
[
'key' => 'jmx.discovery[<discovery mode>,<object name>]',
'description' => _('Return a JSON object describing the MBean objects or their attributes. Can be used for LLD.')
]
]
];
}
}
|