diasdmhub / AdGuard_Home_Zabbix_Template

Zabbix template to monitor your AdGuard Home instance
GNU General Public License v3.0
6 stars 0 forks source link
adguard adguardhome agent api discovery home http monitor openapi rest template zabbix

Zabbix Template for AdGuard Home

[![License](https://img.shields.io/badge/License-GPL3-blue?logo=opensourceinitiative&logoColor=fff)](./LICENSE) [![Version](https://img.shields.io/badge/Version-702-blue?logo=zotero&color=0aa8d2)](https://github.com/diasdmhub/AdGuard_Home_Zabbix_Template/releases/tag/latest)


OVERVIEW

AdGuard Home is a network-wide ad blocking and tracking software. Once you've set it up, it will cover your devices without the need for any client-side software.

If you want to monitor your AdGuard Home instance with Zabbix, this template provides some useful monitoring items. \ The monitoring is done via "REST-ish" API as AdGuard Home offers an OpenAPI specification.

The main focus is on monitoring statistics from AdGuard Home.



➡️ Download (latest)


➡️ How to import templates



TEMPLATES

For more flexibility, the release includes templates that cover two monitoring methods, one for native HTTP data retrieval and another for Zabbix Agent Active. Both methods provide the same monitoring items, but with different item types. They are not intended to be used together on the same host.

There are also two independent template types. One is for HTTP AdGuard Home general status and statistics, and the other is for filter parameters discovery. \ In total, the released yaml file contains four templates.


REQUIREMENTS


TESTED VERSION

This template has been tested with AdGuard Home version > 0.107 on an Asus RT-AX86U router running an Asus Merlin firmware, a Mikrotik RouterOS and a standard Linux distribution running Oracle Linux 9. It should work with any recent version of AdGuard Home.


SETUP

If the AdGuard Home web user is password protected, the client must use an authentication mechanism when sending requests to the server. Basic access authentication is the offered method. A client must include an Authorization HTTP header along with all requests:

Authorization: Basic BASE64_DATA

Where BASE64_DATA is a base64-encoded data for your username:password string.



1️⃣ After importing the template to Zabbix and creating AdGuard's host, encode your AdGuard Authorization string username:password to Base64. See the examples bellow.


2️⃣ Copy and paste the encoded string into your host's macro {$ADGUARD.AUTH}.




MACROS USED

Macro Default Value Description
{$ADGUARD.AUTH} HTTP header Basic authorization string. A Base64 encoded string of your username:password.
{$ADGUARD.PORT} 3000 AdGuard Home HTTP port
{$ADGUARD.WEB} http Web protocol. Either "http" or "https"
{$ADGUARD.STAT.DAYS} 30 The configured statistics period in days (AdGuard Home Stats only)
{$ADGUARD.FILTER_ENABLED} true True to discover only enabled filters, leave empty to discover all filters (AdGuard Home Filters only)


ITEMS (AdGuard Home Stats)

Name
AdGuard Home General Status
AdGuard Home General Status: AdGuard Home Status Protection
AdGuard Home General Status: AdGuard Home Status Running
AdGuard Home General Status: AdGuard Home Version
AdGuard Home Statistics
AdGuard Home Statistics: AdGuard Home Average Processing Time
AdGuard Home Statistics: AdGuard Home DNS Queries per Second
AdGuard Home Statistics: AdGuard Home Total DNS Blocks by Period
AdGuard Home Statistics: AdGuard Home Total DNS Blocks Today
AdGuard Home Statistics: AdGuard Home Total DNS Queries by Period
AdGuard Home Statistics: AdGuard Home Total DNS Queries Today
AdGuard Home DNS Queries Today Block Rate
AdGuard Home DNS Queries Today Period Rate


TRIGGERS (AdGuard Home Stats)

Name
AdGuard Home Abnormally High Daily Queries
AdGuard Home Abnormally High Processing Time
AdGuard Home Has NO DNS Queries
AdGuard Home Protection Stopped
AdGuard Home Stopped
AdGuard Home Version Changed


ITEMS (AdGuard Home Filters)

Name
AdGuard Home Filters
AdGuard Home Filter Rules Count Sum


DISCOVERY RULE (AdGuard Home Filters)

Name
AdGuard Home Filters: AdGuard Filters Discovery


ITEM PROTOTYPES (AdGuard Home Filters)

Name
AdGuard Home Filter Last Update Time - {#FILTER.NAME}
AdGuard Home Filter Rules Count - {#FILTER.NAME}
AdGuard Home Filter Status - {#FILTER.NAME}


TRIGGER PROTOTYPES (AdGuard Home Filters)

Name
AdGuard Home Filter is Disabled - {#FILTER.NAME}
AdGuard Home Filter not Updated in more than 7 days - {#FILTER.NAME}


DASHBOARD EXAMPLE

Dashboard example