Skip to main content
Version: 3.7.0

Zabbix Metrics

ONE can collect Zabbix Metrics by REST API polling or real-time Webhook push.
Choose the mode that best fits your scale and performance requirements.

Prerequisites

ModeRequirements
APIZabbix ≤ 6.0
Webhook pushZabbix ≤ 6.0(higher performance via file export)
NetworkONE platform must reach Zabbix server

Getting Started

API-based metrics collection

Navigate to Integrations → Plugins, locate the Zabbix card, click Start Integration, and choose “API fetch Zabbix Items”.

Supply the required Zabbix API parameters as detailed in the official documentation linked below.

Zabbix API Official Documentation

How to obtain Zabbix API

Other Parameters

  • Data interval: how many seconds elapse between each Zabbix API call. Frequent requests can overload Zabbix; the recommended interval is 15–30 s.

  • Data start time: the earliest point in time from which to collect data.

  • Unique label: identifies which Zabbix instance the data originates from.

Webhook-based metrics ingestion

Navigate to IntegrationsPlugins, locate the Zabbix card, click Start Integration, and choose Webhook fetch Zabbix Items.

ONE provides a stand-alone utility that continuously reads Zabbix real-time export files and pushes the metrics to ONE via Webhook.
The tool periodically calls the Zabbix API to refresh item metadata while streaming values from the export files.

  • Locate the Zabbix Server configuration file.
ps -ef |grep zabbix_server.conf
  • Add export settings to the configuration file.
# zabbix Directory for real-time export data files
ExportDir=/data/br/data/zabbix
# zabbix Real-time export data file size
ExportFileSize=1G
  • Check which user the Zabbix Server process belongs to, then grant that user read and write permissions on the ExportDir folder.
ps -ef |grep "/etc/zabbix/zabbix_server.conf"
zabbix 9746 1 0 16:03 ? 00:00:00 /usr/sbin/zabbix_server -c /etc/zabbix/zabbix_server.conf

# The user is shown as **zabbix**, so grant the **zabbix** user read and write permissions on the **ExportDir** folder:
chown zabbix:zabbix -R /data/br/data/zabbix
chmod u+rw -R /data/br/data/zabbix
  • Restart Zabbix Server
service restart zabbix-server
or
systemctl restart zabbix-server
  • Upload zabbix-realtime-export.zip to the Zabbix Server host and extract it to a directory such as /home/zabbix/export.
  • Copy the Zabbix Webhook metrics-push URL shown in ONE and paste it into the service section of config.yml.
  • Configure the Zabbix API endpoint (zabbix.apiServer), username (zabbix.username), and password (zabbix.password).
    Also set zabbix.exportDir to the path you added in zabbix_server.conf and point to the location of that same config file.
tip
  • If the frontend path is in the format http://ip/xxx/zabbix.php, configure apiServer as:
    http://127.0.0.1/xxx/api_jsonrpc.php.
  • If the frontend path is http://ip/zabbix.php, remove the /xxx segment and set apiServer to:
    http://127.0.0.1/api_jsonrpc.php.
# Zabbix API-related configuration
zabbix:
apiServer: http://127.0.0.1/zabbix/api_jsonrpc.php
username: Admin
password: zabbix
refreshIntervalHours: 6
# Zabbix real-time export protocol configuration
export:
exportDir: /data/br/data/zabbix
zabbixServerConfPath: /etc/zabbix/zabbix_server.conf
# Export service-related configuration
service:
pollingIntervalInMillis: 50
readFileBufferInMB: 2
checkpointPath: ./checkpoint
checkpointSync: true
initialFlushDelaySeconds: 1
flushDelaySeconds: 1
sendBufferSize: 16
webhookUrl: http://10.241.3.201:4318/integration/zabbix/metric/aaaaaaaa-eb71-4a8f-a0f8-05d2e79a3f32
  • Utility-related commands
# Start
sh one_zabbix.sh start

# Stop
sh one_zabbix.sh stop

# Restart
sh one_zabbix.sh restart

# Check the program's running status
sh one_zabbix.sh status

# After starting the program, check its status; if the following message is returned, the program is running normally.
zabbix-realtime-export is running.

Configure Data Stream

  • ONE provides an out-of-the-box default stream.
  • You can also build a custom stream for advanced scenarios.

Verification

  • Review registered Metrics under InsightData ModelMetrics.
  • Explore live data under InsightData Explorer.