Documentation
Table of Contents
5 Ładowalne moduły
Przegląd
Ładowalne moduły pozwalają w wydajny sposób rozszerzyć funkcjonalność Zabbix.
Istnieją już sposoby rozszerzania funkcjonalności Zabbix przez:
- parametry użytkownika (metryki agenta)
- sprawdzenia zewnętrzne (monitorowanie bez agenta)
- pozycję agenta Zabbix
system.run[].
Działają dobrze, ale mają jedną zasadniczą wadę, mianowicie fork(). Zabbix musi wydzielić nowy proces za każdym razem, gdy obsługuje metrykę użytkownika, co nie jest zbyt dobre dla wydajności. Normalnie nie jest to żaden problem, ale może być poważnym utrudnieniem przy monitorowaniu systemów wbudowanych, posiadających dużą liczbę monitorowanych parametrów lub ciężkie skrypty ze skomplikowaną logiką lub długim czasem działania.
Zabbix 2.2 wspiera ładowalne moduły, rozszerzające agenta i serwer Zabbix bez obniżania wydajności.
Ładowalny moduł to w zasadzie współdzielona biblioteka używana przez serwer lub agenta Zabbix, ładowana podczas startu. Biblioteka powinna zawierać pewne funkcje, które pozwolą procesowi Zabbix stwierdzić, że ten plik to moduł, który można załadować i z nim pracować.
Ładowalne moduły posiadają wiele zalet. Bardzo ważna jest wysoka wydajność i możliwość implementowania dowolnej logiki, ale możliwe jest, że najważniejszą zaletą jest sama możliwość tworzenia, używania i współdzielenia modułów Zabbix. Możliwe jest bezproblemowe utrzymanie i łatwiejsze dostarczanie nowych funkcjonalności, niezależnie od bazowego kodu samego Zabbix.
Parametry konfiguracji
Serwer i agent Zabbix obsługują dwa parametry do pracy z modułami:
- LoadModulePath - pełna ścieżka do lokalizacji ładowalnych modułów
- LoadModule - moduł(y) do załadowania przy starcie. Moduły muszą być umieszczone w katalogu określonym w LoadModulePath. Dopuszczalne jest podanie wielu parametrów LoadModule.
Na przykład, aby rozszerzyć agenta Zabbix można dodać następujące parametry:
LoadModulePath=/usr/local/lib/zabbix/agent/
LoadModule=mariadb.so
LoadModule=apache.so
LoadModule=kernel.so
LoadModule=dummy.soPodczas uruchamiania agent załaduje moduły mariadb.so, apache.so, kernel.so i dummy.so z katalogu /usr/local/lib/zabbix/agent. Ładowanie nie powiedzie się, jeżeli modułu nie będzie, będzie miał złe uprawnienia lub jeżeli współdzielona biblioteka nie jest modułem Zabbix.
Moduł atrapa (dummy)
Zabbix 2.2 zawiera przykład modułu napisany w języku C. Moduł zlokalizowany jest w src/modules/dummy:
alex@alex:~trunk/src/modules/dummy$ ls -l
-rw-rw-r-- 1 alex alex 9019 Apr 24 17:54 dummy.c
-rw-rw-r-- 1 alex alex 67 Apr 24 17:54 Makefile
-rw-rw-r-- 1 alex alex 245 Apr 24 17:54 READMEModuł jest dobrze udokumentowany, może być użyty jako szablon dla nowych modułów.
Wystarczy uruchomić make, aby zbudować dummy.so.
/*
** Zabbix
** Copyright (C) 2001-2013 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.
**/
#include "sysinc.h"
#include "module.h"
/* the variable keeps timeout setting for item processing */
static int item_timeout = 0;
int zbx_module_dummy_ping(AGENT_REQUEST *request, AGENT_RESULT *result);
int zbx_module_dummy_echo(AGENT_REQUEST *request, AGENT_RESULT *result);
int zbx_module_dummy_random(AGENT_REQUEST *request, AGENT_RESULT *result);
static ZBX_METRIC keys[] =
/* KEY FLAG FUNCTION TEST PARAMETERS */
{
{"dummy.ping", 0, zbx_module_dummy_ping, NULL},
{"dummy.echo", CF_HAVEPARAMS, zbx_module_dummy_echo, "a message"},
{"dummy.random", CF_HAVEPARAMS, zbx_module_dummy_random,"1,1000"},
{NULL}
};
/******************************************************************************
* *
* Function: zbx_module_api_version *
* *
* Purpose: returns version number of the module interface *
* *
* Return value: ZBX_MODULE_API_VERSION_ONE - the only version supported by *
* Zabbix currently *
* *
******************************************************************************/
int zbx_module_api_version()
{
return ZBX_MODULE_API_VERSION_ONE;
}
/******************************************************************************
* *
* Function: zbx_module_item_timeout *
* *
* Purpose: set timeout value for processing of items *
* *
* Parameters: timeout - timeout in seconds, 0 - no timeout set *
* *
******************************************************************************/
void zbx_module_item_timeout(int timeout)
{
item_timeout = timeout;
}
/******************************************************************************
* *
* Function: zbx_module_item_list *
* *
* Purpose: returns list of item keys supported by the module *
* *
* Return value: list of item keys *
* *
******************************************************************************/
ZBX_METRIC *zbx_module_item_list()
{
return keys;
}
int zbx_module_dummy_ping(AGENT_REQUEST *request, AGENT_RESULT *result)
{
SET_UI64_RESULT(result, 1);
return SYSINFO_RET_OK;
}
int zbx_module_dummy_echo(AGENT_REQUEST *request, AGENT_RESULT *result)
{
char *param;
if (1 != request→nparam)
{
/* set optional error message */
SET_MSG_RESULT(result, strdup("Invalid number of parameters"));
return SYSINFO_RET_FAIL;
}
param = get_rparam(request, 0);
SET_STR_RESULT(result, strdup(param));
return SYSINFO_RET_OK;
}
/******************************************************************************
* *
* Function: zbx_module_dummy_random *
* *
* Purpose: a main entry point for processing of an item *
* *
* Parameters: request - structure that contains item key and parameters *
* request→key - item key without parameters *
* request→nparam - number of parameters *
* request→timeout - processing should not take longer than *
* this number of seconds *
* request→params[N-1] - pointers to item key parameters *
* *
* result - structure that will contain result *
* *
* Return value: SYSINFO_RET_FAIL - function failed, item will be marked *
* as not supported by zabbix *
* SYSINFO_RET_OK - success *
* *
* Comment: get_rparam(request, N-1) can be used to get a pointer to the Nth *
* parameter starting from 0 (first parameter). Make sure it exists *
* by checking value of request→nparam. *
* *
******************************************************************************/
int zbx_module_dummy_random(AGENT_REQUEST *request, AGENT_RESULT *result)
{
char *param1, *param2;
int from, to;
if (request→nparam != 2)
{
/* set optional error message */
SET_MSG_RESULT(result, strdup("Invalid number of parameters"));
return SYSINFO_RET_FAIL;
}
param1 = get_rparam(request, 0);
param2 = get_rparam(request, 1);
/* there is no strict validation of parameters for simplicity sake */
from = atoi(param1);
to = atoi(param2);
if (from > to)
{
SET_MSG_RESULT(result, strdup("Incorrect range given"));
return SYSINFO_RET_FAIL;
}
SET_UI64_RESULT(result, from + rand() % (to - from + 1));
return SYSINFO_RET_OK;
}
/******************************************************************************
* *
* Function: zbx_module_init *
* *
* Purpose: the function is called on agent startup *
* It should be used to call any initialization routines *
* *
* Return value: ZBX_MODULE_OK - success *
* ZBX_MODULE_FAIL - module initialization failed *
* *
* Comment: the module won't be loaded in case of ZBX_MODULE_FAIL *
* *
******************************************************************************/
int zbx_module_init()
{
/* initialization for dummy.random */
srand(time(NULL));
return ZBX_MODULE_OK;
}
/******************************************************************************
* *
* Function: zbx_module_uninit *
* *
* Purpose: the function is called on agent shutdown *
* It should be used to cleanup used resources if there are any *
* *
* Return value: ZBX_MODULE_OK - success *
* ZBX_MODULE_FAIL - function failed *
* *
******************************************************************************/
int zbx_module_uninit()
{
return ZBX_MODULE_OK;
}Moduł eksportuje trzy nowe pozycje:
dummy.ping- zawsze zwraca '1'dummy.echo[param1]- zwraca pierwszy parametr, na przykład,dummy.echo[ABC]zwróci ABCdummy.random[param1, param2]- zwraca losową liczbę z zakresu param1-param2, na przykład,dummy.random[1,1000000]
Ograniczenia
Wsparcie dla ładowalnych modułów zostało zaimplementowane wyłącznie na platformach Unix. Oznacza to, że nie będą działać z agentami Windows.
W niektórych przypadkach moduł może chcieć odczytać swoje parametry konfiguracji z zabbix_agentd.conf. Aktualnie nie jest to obsługiwane. Jeżeli istnieje potrzeba, by moduł posiadał parametry konfiguracyjne, powinno się zaimplementować parsowanie pliku konfiguracyjnego przeznaczonego dla modułu.