Preliminary AdGuard Home Dashboard in Grafana

💬 Lounge
1

So I switched from Pi-hole over to AdGuard Home a while back but its lack of metrics on its dashboard were bothering me. I tried setting up a popular exporter and dashboard that I found online but it was missing the thing I wanted most, which was a breakdown of which DNS servers are being selected for upstream queries. Pi-hole has a chart for this right on the main page :frowning: .

So... I wrote my own Telegraf input using the Adguard API and Telegraf json_v2 parser, send the metrics to Influx and started making a dashboard. I still need to add some line charts to see the trending over time.

I am not totally sure if I have the measurement/tag/fields setup quite right, I need to investigate that some more before I get too crazy because I might have to redo all the charts. Proof of concept is done.

l also want to make a Hubitat Driver to see and control the status of AdGuard similar to the existing pi-hole driver.

Would anyone else be interested in implementing this if I posted my configs and the dashboard on github?

image
image1847×698 152 KB

2

I just switched to AdGuard Home about 3 weeks ago, from Pi-Hole for about 4 years.

Your charting looks useful but a Hubitiat driver would be much more interesting for me.
I'd like to gain the ability to block YouTube on specific clients using a ZWave button.
I have this set up with HA and Pi-Hole but since AdGuard is now my primary it's not useful unless AdGuard goes down.

I'd be happy to assist with this if needed.

3

Glad I am not alone in making the switch.

AGH does have a sort of API that can be used. I actually started working on a driver just so I could turn it off from the dashboard and have it come back on automatically. Otherwise sometimes I turn it off and forget its off for a while until I start seeing ads all over. There is a Pi-hole driver I think on this forum someplace I was using as a starting point.

I don't do much blocking per client, I use the DHCP from the router.

I suspect with Pi-hole that HA was accessing it via command line on the same machine vs using an API? How did it setup the per client blocking? Maybe by adding a removing a group?

Anyway, for AGH, I see in the Persistent Clients section you can use their services blocking per client, is that how you want to block it or would you just do a custom filtering rule? I think both can be done from the API would just be a matter of building the correct command and putting it into a driver.

If you want to check out the API you can find it here and doc suggests to use swagger to view it which works OK. AdGuardHome/openapi at master · AdguardTeam/AdGuardHome · GitHub

I think the last time I worked on it I loaded it in Postman and it was easier to navigate in there.

4

PH's lack of real API made it a little more challenging, but I have it set up to post to the groups endpoint (/admin/scripts/pi-hole/php/groups.php) to enable/disable an entry.
ie: {{group_endpoint}}?action=edit_domain&id=37&type=3&comment=YouTube+Regex&status=1&groups%5B%5D=1&groups%5B%5D=2&token={{token}}

For AGH it would just be to post to /clients/update. The real kicker with this one is that an update requires you to resend ALL of the config for that client and not just the updated keys. So you'd first need to query for the client config (/clients/find?ip0=10.8.0.11), make changes to the blocked_services, and then post the update.

Since I use UniFi for my DHCP I have static IPs set for devices I need to block. MAC blocking doesn't work for AGH unless you use it's DHCP server. The values of ids would be mac, ip, or hostname.

Example payload to block youtube:

{
  "name": "GTV-LivingRoom",
  "data": {
    "name": "GTV-LivingRoom",
    "filtering_enabled": true,
    "parental_enabled": true,
    "safebrowsing_enabled": true,
    "safesearch_enabled": true,
    "use_global_blocked_services": false,
    "use_global_settings": false,
    "upstreams": [],
    "tags": [
        "device_tv",
        "os_android"
    ],
    "ids": [
        "10.8.0.11"
    ],
    "blocked_services": [
        "youtube"
    ]
  }
}
5

@jtp10181 I took a stab at a driver for this. Let me know how it works for you if you try it out.

HPM Manifest - https://raw.githubusercontent.com/JoKneeMo/hubitat/main/adguardhome/packageManifest.json
GitHub - hubitat/adguardhome at main · JoKneeMo/hubitat · GitHub

The app will currently create the DNS server for you but something is broken with the management after the fact.
Once the DNS server is created, you can toggle all the states and block/unblock services.
The Client driver is not in a usable state yet as I started with the server first.

image
image1278×786 69.1 KB

6

Sounds good, I have not had a chance to check it out yet I was busy putting out some drivers for new devices. I did not forget about this I will be back to check it out as soon as I can!

7

Just fixed all of those issues and it's very stable now. Finally have my YouTube blocker button again!

8

Hi @jtp10181

This is what I'm looking for it. is the dashboard you remain using? if so, would you mind share with me the implementation guide on Github?
Thx a lot!!

9

What Influx version do you use? I need to rewrite my queries in Flux now that I am better at it. They are currently using the old v1 query style.

11

Its InfluxDB v1.8.6 (git: 1.8 v1.8.6) on docker.

12

Looking forward to your rewrite version.

13

You would want the v1 queries for influx 1.8 but I also need to dig out the telegrapf config and post it all somewhere.

14

It’s great to hear you remain working on it.
Let me know if revised done.
Thx a lot.

1 Like
15

While you may still refining, I found using below config.
thx a lot!!

Edit: can't post link ,,,, So you may search github Adguarrd home, issues 573, issuecomment-760167925 and issuecomment-760235296

16

Could not find it by searching that.
Join the owners group to post a link: Hub owners - Hubitat

EDIT: Here is what I am using. Dashboard JSON is for InfluxQL queries (1.x Influx or using a DRBP mapping on 2.x).

For Telegraf you have to setup an output config and an input. My output file is for Influx 2.x so you may need to use a template for 1.x
telegraf output: Adguard Home Dashboard · GitHub
telegraf input: Adguard Home Dashboard · GitHub

I have a legacy DRBP mapping on my Influx 2.x and it was easier for me to figure out the InfluxQL query so that's how I wrote it. I may try and upgrade it to Flux (for 2.x).
grafana dashboard: Adguard Home Dashboard · GitHub

image
image1510×1127 175 KB

17

Let me have a try a again.
github AdGuardHome issues/573
#issuecomment-760167925

[[inputs.tail]]
  files = ["/opt/AdGuardHome/data/querylog.json"]
  data_format = "json"
  tag_keys = [
    "IP",
    "QH",
    "QT",
    "QC",
    "CP",
    "Upstream",
    "Result_Reason"
  ]

  json_name_key = "query"
  json_time_key = "T"
  json_time_format = "2006-01-02T15:04:05.999999999Z07:00"

[[processors.regex]]
  [[processors.regex.tags]]
    key = "IP"
    result_key = "IP_24"
    pattern = "^(\\d+)\\.(\\d+)\\.(\\d+)\\.(\\d+)$"
    replacement = "${1}.${2}.${3}.x"

[[processors.regex]]
  [[processors.regex.tags]]
    key = "QH"
    result_key = "TLD"
    pattern = "^.*?(?P<tld>[^.]+\\.[^.]+)$"
    replacement = "${tld}"

[[outputs.influxdb]]
  urls = ["http://influxdb.local:8086"]
  database = "adguard"
18

Thank you so much!!!
I'll try to merge both to have a more informative dashboard.

19

Oh I like that way better, instead of using the API if its on the same server you just tail the log. That should be more efficient that what I was doing. I will have to look into that.

20

Hi, it is possible to explain a litle more how to implement it in HomeAssistant.

I'm trying but I'm unable to replicate it, it says "No data"

21

I assume you are using the Influx and Grafana addons from within HA, that is what you mean?

What are you getting stuck on? Did you setup telegraf to scrape the API and save the data to Influx?