Zabbix

https://www.zabbix.com/documentation/
Admin
Zabbix is an enterprise-grade monitoring and alerting platform that collects and analyzes real-time...
Tokens:1,120,241
Snippets:16,611
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Configure MSI Installation Parameters

Source: https://www.zabbix.com/documentation/current/en/manual/installation/install_from_packages/win_msi

Examples of parameters used to define components and installation paths during MSI deployment.

```text
ADDDEFAULT=MongodbPlugin,PostgresqlPlugin
```

```text
ADDLOCAL=MongodbPlugin,MssqlPlugin
```

```text
INSTALLFOLDER="C:\Program Files\Zabbix Agent 2"
```

--------------------------------

### Install a module via module.create

Source: https://www.zabbix.com/documentation/current/en/manual/api/reference/module/create

Example request and response for installing a module with an enabled status.

```json
{
    "jsonrpc": "2.0",
    "method": "module.create",
    "params": {
        "id": "example_module",
        "relative_path": "modules/example_module",
        "status": 1
    },
    "id": 1
}
```

```json
{
    "jsonrpc": "2.0",
    "result": {
        "moduleids": [
            "25"
        ]
    },
    "id": 1
}
```

--------------------------------

### Configure Startup Type

Source: https://www.zabbix.com/documentation/current/en/manual/installation/install_from_packages/win_msi

Example of setting the service startup type during installation.

```text
STARTUPTYPE=disabled
```

--------------------------------

### Install and Enable NetworkManager

Source: https://www.zabbix.com/documentation/current/en/manual/appliance

Commands to install, enable, and start the NetworkManager service.

```bash
dnf install NetworkManager
systemctl enable NetworkManager
systemctl start NetworkManager
```

--------------------------------

### Recompile and run server

Source: https://www.zabbix.com/documentation/guidelines/en/devel

Install the build and start the Zabbix server.

```bash
make install; cd ...; sbin/zabbix_server
```

--------------------------------

### Retrieve Installed Packages

Source: https://www.zabbix.com/documentation/current/en/manual/config/items/itemtypes/zabbix_agent

Example of the system.sw.packages key filtering by name, manager, and format.

```text
system.sw.packages[mini,dpkg,short] → python-minimal, python2.6-minimal, ubuntu-minimal
```

--------------------------------

### PostgreSQL Connection Example

Source: https://www.zabbix.com/documentation/current/en/manual/appendix/install/db_scripts

Example command for connecting to a PostgreSQL database.

```bash
psql -U <username>
```

--------------------------------

### Install build dependencies

Source: https://www.zabbix.com/documentation/current/en/manual/installation/install/mac_agent

Install Automake and pkg-config using Homebrew.

```bash
brew install automake
brew install pkg-config
```

--------------------------------

### VaultPrefix Configuration Examples

Source: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_proxy

Examples of custom prefixes for Vault paths or queries.

```text
v1/secret/data/zabbix/
```

```text
/AIMWebService/api/Accounts?
```

--------------------------------

### Start Zabbix processes

Source: https://www.zabbix.com/documentation/current/en/manual/installation/upgrade/packages/debian_ubuntu

Start the upgraded Zabbix services after the installation process is complete.

```bash
systemctl start zabbix-server
systemctl start zabbix-proxy
systemctl start zabbix-agent
systemctl start zabbix-agent2
```

--------------------------------

### Alias Configuration Examples

Source: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win

Examples demonstrating how to define aliases for complex item keys to simplify monitoring configurations.

```text
Alias=pg_usage:perf_counter[\Paging File(_Total)\% Usage]
```

```text
Alias=cpu.load:system.cpu.load
Alias=cpu.load[*]:system.cpu.load[*]
```

```text
Alias=vfs.fs.discovery[*]:vfs.fs.discovery
```

--------------------------------

### Start Request Example

Source: https://www.zabbix.com/documentation/current/en/manual/appendix/protocols/zabbix_agent2_plugin

A JSON request to execute the Start function of the Runner interface.

```json
{"id":3,"type":4}
```

--------------------------------

### Prepare source directory

Source: https://www.zabbix.com/documentation/current/en/manual/installation/install/mac_agent

Create and enter the directory for building static libraries.

```bash
mkdir static-libs-source
cd static-libs-source
```

--------------------------------

### Elasticsearch GET response

Source: https://www.zabbix.com/documentation/current/en/manual/config/items/itemtypes/http

Example JSON response received from an Elasticsearch service after a GET request.

```json
    {
      "name" : "YQ2VAY-",
      "cluster_name" : "elasticsearch",
      "cluster_uuid" : "kH4CYqh5QfqgeTsjh2F9zg",
      "version" : {
        "number" : "6.1.3",
        "build_hash" : "af51318",
        "build_date" : "2018-01-26T18:22:55.523Z",
        "build_snapshot" : false,
        "lucene_version" : "7.1.0",
        "minimum_wire_compatibility_version" : "5.6.0",
        "minimum_index_compatibility_version" : "5.0.0"
      },
      "tagline" : "You know, for search"
    }
```

--------------------------------

### Initialize vcpkg and install dependencies

Source: https://www.zabbix.com/documentation/current/en/manual/installation/install/win_agent

Commands to set up the vcpkg environment and install the required PCRE2 and OpenSSL libraries.

```batch
cd C:\Zabbix
vcpkg new --application
vcpkg add port pcre2
vcpkg add port openssl
vcpkg install --triplet x64-windows-static --x-install-root="C:\Program Files\Zabbix\x64"
```

--------------------------------

### Initialize Go Module and Download Dependencies

Source: https://www.zabbix.com/documentation/guidelines/en/plugins/loadable_plugins

Use this bash script to initialize your Go module, download plugin dependencies, and build the plugin executable. Ensure you replace 'branchname' with the correct branch or commit hash.

```bash
go mod init myip
GOPROXY=direct go get git.zabbix.com/ap/plugin-support/plugin@branchname
go mod tidy
go build
```

--------------------------------

### Go Get: Add Third-Party Package

Source: https://www.zabbix.com/documentation/guidelines/en/coding/go/code_style

Use the `go get` command from the `~/zabbix/src/go` directory to add third-party Go packages to your project. This command fetches and installs the specified package.

```bash
go get example.com/pkg
```

--------------------------------

### Configure Step URL Examples

Source: https://www.zabbix.com/documentation/current/en/manual/web_monitoring

Examples of valid URL formats for web scenario steps.

```text
https://www.example.com
http://www.example.com/download
```

--------------------------------

### Prepare Zabbix Schema

Source: https://www.zabbix.com/documentation/current/en/manual/appendix/install/db_scripts

Run this command when installing from the Zabbix Git repository before proceeding with database setup.

```bash
make dbschema
```

--------------------------------

### Back up configuration and binaries

Source: https://www.zabbix.com/documentation/current/en/manual/installation/upgrade/packages/debian_ubuntu

Create a backup directory and copy existing configuration files, PHP files, and binaries.

```bash
mkdir /opt/zabbix-backup/
cp /etc/zabbix/zabbix_server.conf /opt/zabbix-backup/
cp /etc/apache2/conf-enabled/zabbix.conf /opt/zabbix-backup/
```

```bash
cp -R /usr/share/zabbix/ /opt/zabbix-backup/
cp -R /usr/share/zabbix-* /opt/zabbix-backup/
```

--------------------------------

### Full Sentence Comment Example

Source: https://www.zabbix.com/documentation/guidelines/en/coding/php

Demonstrates a full sentence comment, starting with a capital letter and ending with a period.

```PHP
// This is a full sentence comment.
```

--------------------------------

### Run Zabbix server with parameters

Source: https://www.zabbix.com/documentation/current/en/manual/concepts/server

Examples of executing the Zabbix server binary with specific configuration or help flags.

```bash
zabbix_server -c /usr/local/etc/zabbix_server.conf
zabbix_server --help
zabbix_server -V
```

--------------------------------

### Reference a Network Map via URL

Source: https://www.zabbix.com/documentation/current/en/manual/web_interface/frontend_sections/monitoring/maps

Example of using the mapname GET parameter to open a specific network map.

```http
http://zabbix/zabbix/zabbix.php?action=map.view&mapname=Local%20network
```

--------------------------------

### Retrieve processor load using Zabbix get

Source: https://www.zabbix.com/documentation/current/en/manual/concepts/get

Example command to fetch the system CPU load from a Zabbix agent on a specific host.

```bash
cd bin
./zabbix_get -s 127.0.0.1 -p 10050 -k system.cpu.load[all,avg1]
```

--------------------------------

### Creating Plugin Directory and Main File

Source: https://www.zabbix.com/documentation/guidelines/en/plugins/loadable_plugins

Commands to create the plugin directory and the main Go source file.

```bash
mkdir -p /usr/local/zabbix/go/plugins/myip
cd /usr/local/zabbix/go/plugins/myip
vi main.go
```

--------------------------------

### Capture string from website using Zabbix get

Source: https://www.zabbix.com/documentation/current/en/manual/concepts/get

Example command using a regular expression to capture a specific string from a website via the agent.

```bash
cd bin
./zabbix_get -s 192.168.1.1 -p 10050 -k "web.page.regexp[www.example.com,,,"USA: ([a-zA-Z0-9.-]+)",,\1]"
```

--------------------------------

### Dashboard API get response structure

Source: https://www.zabbix.com/documentation/current/en/manual/api/reference/dashboard/get

Example of the JSON structure returned by the dashboard.get method, including dashboard pages, widgets, and user permissions.

```json
{
                            "widgetid": "3",
                            "type": "favmaps",
                            "name": "",
                            "x": "8",
                            "y": "0",
                            "width": "12",
                            "height": "3",
                            "view_mode": "0",
                            "fields": []
                        },
                        {
                            "widgetid": "1",
                            "type": "favgraphs",
                            "name": "",
                            "x": "0",
                            "y": "0",
                            "width": "12",
                            "height": "3",
                            "view_mode": "0",
                            "fields": []
                        }
                    ]
                },
                {
                    "dashboard_pageid": "2",
                    "name": "",
                    "display_period": "0",
                    "widgets": []
                },
                {
                    "dashboard_pageid": "3",
                    "name": "Custom page name",
                    "display_period": "60",
                    "widgets": []
                }
            ]
        },
        {
            "dashboardid": "2",
            "name": "My dashboard",
            "userid": "1",
            "private": "1",
            "display_period": "60",
            "auto_start": "1",
            "users": [
                {
                    "userid": "4",
                    "permission": "3"
                }
            ],
            "userGroups": [
                {
                    "usrgrpid": "7",
                    "permission": "2"
                }
            ],
            "pages": [
                {
                    "dashboard_pageid": "4",
                    "name": "",
                    "display_period": "0",
                    "widgets": [
                        {
                            "widgetid": "10",
                            "type": "problems",
                            "name": "",
                            "x": "0",
                            "y": "0",
                            "width": "12",
                            "height": "5",
                            "view_mode": "0",
                            "fields": [
                                {
                                    "type": "2",
                                    "name": "groupids",
                                    "value": "4"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ],
    "id": 1
}
```

--------------------------------

### Simple UserParameter examples

Source: https://www.zabbix.com/documentation/current/en/manual/config/items/userparameters

Examples of static user parameters that return fixed or command-based values.

```text
UserParameter=ping,echo 1
```

```text
UserParameter=mysql.ping,mysqladmin -uroot ping | grep -c alive
```

--------------------------------

### CSS Selector Specificity Example

Source: https://www.zabbix.com/documentation/guidelines/en/coding/html_css

Demonstrates correct and incorrect CSS selector patterns. It emphasizes starting selectors with the root element for structured groups and avoiding overly specific selectors tied to DOM structure.

```html
<div class="widget">
    <div class="header"></div>
    <div class="body"></div>
</div>

```

```css
/* correct */
.widget { ... }
.widget .header { ... }
.widget .body a { ... }

/* wrong */
.widget { ... }
.header { ... }
.body a { ... }

/* also wrong */
.widget { ... }
.widget-header { ... }
.widget-body a { ... }

```

```css
/* correct */
.w.list .item .status strong { ... }

/* wrong */
.w.list tr.item td.status strong { ... }

```

--------------------------------

### View configuration help

Source: https://www.zabbix.com/documentation/current/en/manual/installation/install

Displays all available configuration options for the Zabbix source build.

```bash
./configure --help
```

--------------------------------

### CPU load monitoring example

Source: https://www.zabbix.com/documentation/current/en/manual/config/items/itemtypes/zabbix_agent

Example of retrieving the five-minute average CPU load.

```text
system.cpu.load[,avg5]
```

--------------------------------

### Troubleshoot Zabbix Agent Installation

Source: https://www.zabbix.com/documentation/current/en/manual/installation/install_from_packages/mac_pkg

Commands to verify if the agent is running, check package installation status, and list installed files.

```bash
ps aux | grep zabbix_agentd
```

```bash
pkgutil --pkgs | grep zabbix 
com.zabbix.pkg.ZabbixAgent
```

```bash
pkgutil --only-files --files com.zabbix.pkg.ZabbixAgent
```

--------------------------------

### Install OpenSSL

Source: https://www.zabbix.com/documentation/current/en/manual/installation/install/win_agent

Installs the compiled OpenSSL binaries.

```bash
nmake install
```

--------------------------------

### Plugin Logging Example

Source: https://www.zabbix.com/documentation/guidelines/en/plugins/built_in_plugins

Demonstrates how to use logging functions within a plugin to record messages that appear in the agent's logs.

```go
p.Infof("received request to handle %s key with %d parameters", key, len(params))
```

--------------------------------

### Install PCRE2

Source: https://www.zabbix.com/documentation/current/en/manual/installation/install/building_zabbix_agent_2_on_windows

Command to install PCRE2 after configuration.

```bash
make install
```

--------------------------------

### Configure Zabbix Server with Environment Variables

Source: https://www.zabbix.com/documentation/current/en/manual/appendix/config/environment_variables

Demonstrates setting a configuration parameter to an environment variable and passing it during component startup.

```bash
# Zabbix server configuration file:
DebugLevel=${NEW_DEBUG_LEVEL}

# Starting Zabbix server:
NEW_DEBUG_LEVEL=5 /usr/sbin/zabbix_server
```

--------------------------------

### Install Zabbix Agent via PKG

Source: https://www.zabbix.com/documentation/current/en/manual/installation/install_from_packages/mac_pkg

Use the installer command to install the Zabbix agent package. Ensure the filename matches the downloaded package version.

```bash
sudo installer -pkg zabbix_agent-7.4.0-macos-arm64-openssl.pkg -target /
```

--------------------------------

### Example odbc.ini Configuration

Source: https://www.zabbix.com/documentation/current/en/manual/guides/monitor_mysql

Example DSN configuration for connecting to a local MySQL instance.

```ini
[test]
Driver=MariaDB Unicode
Server=127.0.0.1
User=zbx_monitor
Password=<password>
Port=3306
Database=zabbix
```

--------------------------------

### Datastore Type Examples

Source: https://www.zabbix.com/documentation/current/en/manual/vm_monitoring/discovery_fields

Example values for the {#DATASTORE.TYPE} field.

```text
VMFS, NFS, vsan, etc.
```

--------------------------------

### List Datastore Hypervisors

Source: https://www.zabbix.com/documentation/current/en/manual/vm_monitoring/vmware_keys

Example output showing a list of hypervisors associated with a datastore.

```text
esx7-01-host.zabbix.sandbox
esx7-02-host.zabbix.sandbox
```

--------------------------------

### Start Zabbix server via init.d

Source: https://www.zabbix.com/documentation/current/en/manual/concepts/server

Use the init script to start the Zabbix server on systems where systemd is not available.

```bash
/etc/init.d/zabbix-server start
```
Tokens:
Raw