Docs

1. Introduction

1 Manual structure

2 What is Zabbix

3 Zabbix features

4 Zabbix overview

5 What's new in Zabbix 5.2.0

6 What's new in Zabbix 5.2.1

7 What's new in Zabbix 5.2.2

8 What's new in Zabbix 5.2.3

9 What's new in Zabbix 5.2.4

10 What's new in Zabbix 5.2.5

11 What's new in Zabbix 5.2.6

15 What's new in Zabbix 5.2.7

3. Zabbix processes

- Setup from sources

2 Setup from RHEL/CentOS packages

3 Setup from Debian/Ubuntu packages

6 Sender

7 Get

8 JS

2 Agent

agent.md

3 Agent 2

agent2.md

4 Proxy

proxy.md

1 Server

server.md

4. Installation

1 Getting Zabbix

Best practices for secure Zabbix setup

3 Installation from sources

Building Zabbix agent 2 on Windows

Building Zabbix agent on Windows

Building Zabbix agent on macOS

4 Installation from packages

6 Mac OS agent installation from PKG

2 Debian/Ubuntu/Raspbian

debian_ubuntu.md

1 Red Hat Enterprise Linux/CentOS

3 SUSE Linux Enterprise Server

suse.md

4 Windows agent installation from MSI

win_msi.md

5 Installation from containers

6 Web interface installation

Debian/Ubuntu frontend installation

7 Upgrade procedure

Upgrade from packages

1 Red Hat Enterprise Linux/CentOS

2 Debian/Ubuntu

Upgrade from sources

9 Template changes

10 Upgrade notes for 5.2.0

11 Upgrade notes for 5.2.1

12 Upgrade notes for 5.2.2

13 Upgrade notes for 5.2.3

14 Upgrade notes for 5.2.4

15 Upgrade notes for 5.2.5

16 Upgrade notes for 5.2.6

17 Upgrade notes for 5.2.7

1 Login and configuring user

2 New host

3 New item

5 Receiving problem notification

6. Zabbix appliance

7. Configuration

1 Trigger event generation

2 Other event sources

3 Manual closing of problems

1 Hosts and host groups

1 Configuring a host

2 Items

1 Creating an item

1 Item key format

2 Custom intervals

Windows-specific item keys

1 Dynamic indexes

5 Simple checks

1 VMware monitoring item keys

6 Log file monitoring

7 Calculated items

8 Internal checks

10 Telnet checks

11 External checks

12 Aggregate checks

13 Trapper items

14 JMX monitoring

15 ODBC monitoring

1 Recommended UnixODBC settings for MySQL

2 Recommended UnixODBC settings for PostgreSQL

3 Recommended UnixODBC settings for Oracle

4 Recommended UnixODBC settings for MSSQL

16 Dependent items

18 Prometheus checks

19 Script items

4 History and trends

5 User parameters

1 Extending Zabbix agents

6 Loadable modules

7 Windows performance counters

9 Value mapping

10 Applications

11 Queue

14 Plugins

15 Restricting agent checks

2 Item value preprocessing

preprocessing.md

3 JSONPath functionality

Escaping special characters from LLD macro values in JSONPath

4 JavaScript preprocessing

Additional JavaScript objects

5 CSV to JSON preprocessing

1 Usage examples

2 Preprocessing details

preprocessing_details.md

3 Triggers

1 Configuring a trigger

2 Trigger expression

3 Trigger dependencies

4 Trigger severity

5 Customizing trigger severities

7 Predictive trigger functions

5 Event correlation

1 Trigger-based event correlation

Event tags

2 Global event correlation

6 Visualization

1 Graphs

1 Simple graphs

2 Custom graphs

3 Ad-hoc graphs

4 Aggregation in graphs

1 Configuring a network map

2 Host group elements

3 Link indicators

3 Screens

1 Screen elements

6 Host dashboards

1 Configuring a template

2 Linking/unlinking

3 Nesting

8 Templates out of the box

HTTP template operation

IPMI template operation

JMX template operation

ODBC template operation

Zabbix agent 2 template operation

Zabbix agent template operation

Standardized templates for network devices

network_devices.md

9 Notifications upon events

10 Macros

1 Macro functions

3 User macros with context

4 Low-level discovery macros

11 Users and user groups

1 Configuring a user

12 Storage of secrets

8. Service monitoring

9. Web monitoring

1 Web monitoring items

2 Real life scenario

10. Virtual machine monitoring

1 Virtual machine discovery key fields

11. Maintenance

12. Regular expressions

13. Problem acknowledgment

14. Configuration export/import

3 Hosts

5 Screens

1 Network discovery

1 Configuring a network discovery rule

2 Active agent autoregistration

3 Low-level discovery

5 Discovery rules

1 Discovery of mounted filesystems

2 Discovery of network interfaces

3 Discovery of CPUs and CPU cores

4 Discovery of SNMP OIDs

5 Discovery of JMX objects

6 Discovery of IPMI sensors

7 Discovery of systemd services

8 Discovery of Windows services

9 Discovery of Windows performance counter instances

10 Discovery using WMI queries

11 Discovery using ODBC SQL queries

12 Discovery using Prometheus data

13 Discovery of block devices

14 Discovery of host interfaces in Zabbix

3 Graph prototypes

graph_prototypes.md

1 Item prototypes

item_prototypes.md

4 Notes on low-level discovery

notes.md

2 Trigger prototypes

trigger_prototypes.md

16. Distributed monitoring

1 Proxies

1 Using certificates

2 Using pre-shared keys

3 Troubleshooting

1 Connection type or permission problems

2 Certificate problems

18. Web interface

1 Menu

2 Frontend sections

1 Dashboard widgets

3 Hosts

1 Graphs

2 Web scenarios

4 Overview

6 Screens

7 Maps

9 Services

2 Problems

1 Overview

2 Hosts

3 Reports

1 System information

2 Availability report

3 Triggers top 100

4 Audit

6 Notifications

4 Configuration

3 Hosts

2 Items

3 Triggers

4 Graphs

5 Discovery rules

6 Web scenarios

5 Actions

6 Event correlation

8 Services

5 Administration

1 General

2 Proxies

3 Authentication

6 Users

8 Scripts

9 Queue

1 Global notifications

2 Sound in browsers

4 Global search

5 Frontend maintenance mode

6 Page parameters

8 Creating your own theme

10 Cookies used by Zabbix

19. API

Appendix 1. Reference commentary

Appendix 2. Changes from 5.0 to 5.2

Method reference

API info

apiinfo.version

Action

action.get

Alert

alert.get

Application object

application.create

application.delete

application.get

application.massadd

application.update

Audit log

Audit log object

Authentication object

authentication.get

authentication.update

Autoregistration

Autoregistration object

autoregistration.get

autoregistration.update

configuration.export

configuration.import

Correlation object

correlation.create

correlation.delete

correlation.get

correlation.update

Dashboard

Dashboard object

dashboard.create

dashboard.delete

dashboard.update

Discovered host

Discovered host object

dhost.get

Discovered service

Discovered service object

Discovery check

Discovery check object

dcheck.get

Discovery rule object

drule.get

Event

event.acknowledge

event.get

Graph

graph.get

Graph item

Graph item object

Graph prototype

Graph prototype object

graphprototype.create

graphprototype.delete

graphprototype.get

graphprototype.update

History

Host

host.get

host.massremove

host.massupdate

Host group

Host group object

hostgroup.create

hostgroup.delete

hostgroup.massadd

hostgroup.massremove

hostgroup.massupdate

hostgroup.update

Host interface object

hostinterface.create

hostinterface.delete

hostinterface.get

hostinterface.massadd

hostinterface.massremove

hostinterface.replacehostinterfaces

hostinterface.update

Host prototype object

hostprototype.create

hostprototype.delete

hostprototype.get

hostprototype.update

Housekeeping object

housekeeping.get

housekeeping.update

Icon map

Icon map object

Image

image.get

Item

item.get

Item prototype object

itemprototype.create

itemprototype.delete

itemprototype.get

itemprototype.update

LLD rule

LLD rule object

discoveryrule.copy

discoveryrule.create

discoveryrule.delete

discoveryrule.get

discoveryrule.update

Maintenance object

maintenance.create

maintenance.delete

maintenance.get

maintenance.update

Map

Map object

map.create

map.delete

map.get

map.update

Media type

Media type object

mediatype.create

mediatype.delete

mediatype.update

Problem

Proxy

proxy.get

Role

role.get

Screen

screen.get

Screen item object

screenitem.create

screenitem.delete

screenitem.update

screenitem.updatebyposition

Script

script.get

script.getscriptsbyhosts

Service

service.adddependencies

service.addtimes

service.deletedependencies

service.deletetimes

Settings

Settings object

settings.getglobal

settings.update

Task

task.get

Template

Template object

template.create

template.delete

template.massadd

template.massremove

template.massupdate

template.update

Template dashboard

Template dashboard object

templatedashboard.create

templatedashboard.delete

templatedashboard.get

templatedashboard.update

Trend

trend.get

Trigger

trigger.adddependencies

trigger.deletedependencies

Trigger prototype

Trigger prototype object

triggerprototype.create

triggerprototype.delete

triggerprototype.get

triggerprototype.update

User

user.checkAuthentication

user.get

user.login

User group

User group object

usergroup.create

usergroup.delete

usergroup.update

User macro

User macro object

usermacro.create

usermacro.createglobal

usermacro.delete

usermacro.deleteglobal

usermacro.update

usermacro.updateglobal

Value map

Value map object

valuemap.create

valuemap.delete

valuemap.update

Web scenario object

httptest.create

httptest.delete

httptest.update

Zabbix API changes in 5.2

1 Frequently asked questions / Troubleshooting

2 Installation and setup

3 Secure connection to the database

1 MySQL encryption configuration

2 PostgreSQL encryption configuration

4 TimescaleDB setup

5 Elasticsearch setup

6 Real-time export of events, item values, trends

7 Distribution-specific notes on setting up Nginx for Zabbix

8 Running agent as root

9 Zabbix agent on Microsoft Windows

10 Zabbix agent 2 on Microsoft Windows

11 SAML setup with Okta

12 Additional frontend languages

2 Repairing Zabbix database character set and collation

db_charset_coll.md

1 Database creation

3 Process configuration

1 Zabbix server

3 Zabbix agent (UNIX)

4 Zabbix agent 2 (UNIX)

5 Zabbix agent (Windows)

6 Zabbix agent 2 (Windows)

7 Zabbix Java gateway

1 Server-proxy data exchange protocol

2 Zabbix agent protocol

3 Zabbix sender protocol

4 Header

5 Real-time export protocol

5 Items

1 Items supported by platform

2 vm.memory.size parameters

3 Passive and active agent checks

4 Trapper items

5 Minimum permission level for Windows agent items

6 Encoding of returned values

7 Large file support

8 Sensor

9 Notes on memtype parameter in proc.mem items

10 Notes on selecting processes in proc.mem and proc.num items

11 Implementation details of net.tcp.service and net.udp.service checks

12 Unreachable/unavailable host settings

13 Remote monitoring of Zabbix stats

14 Configuring Kerberos with Zabbix

15 modbus.get parameters

6 Triggers

1 Supported trigger functions

7 Macros

1 Supported macros

2 User macros supported by location

9 Time period syntax

10 Command execution

11 Recipes for monitoring

12 Performance tuning

13 Version compatibility

14 Database error handling

15 Zabbix sender dynamic link library for Windows

16 Issues with SELinux

17 Other issues

18 Agent vs agent 2 comparison

Zabbix manpages

zabbix_get

zabbix_js

On this page

7 Macros

7 Macros

What’s next?

1 Supported macros