Grafana Dashboard using Telegraf with additional plugins

bigjohns97 · Jan 27, 2021, 4:14 PM

I was playing with the telegraph_unbound script and noticed it wasn't working and ended up replacing the command in the script with the following

unbound-control -c /var/unbound/unbound.conf stats_noreset | grep total.num

This provides a cache hit stats output and was wondering if anyone had any skills with grafana to provide a nice panel addition to this already great dashboard. Was looking for something like this.

I found this thread from reddit where they were discussing how to optimize cache hits and couldn't figure out how to get the following panel to show.

If anyone has the knowledge on how to create this panel I would greatly appreciate it!

(I tried to post the original thread from reddit but it kept flagging this post as spam)

bigjohns97 · Jan 27, 2021, 9:29 PM

@bigjohns97 said in Grafana Dashboard using Telegraf with additional plugins:

I was playing with the telegraph_unbound script and noticed it wasn't working and ended up replacing the command in the script with the following
unbound-control -c /var/unbound/unbound.conf stats_noreset | grep total.num
This provides a cache hit stats output and was wondering if anyone had any skills with grafana to provide a nice panel addition to this already great dashboard. Was looking for something like this.

I found this thread from reddit where they were discussing how to optimize cache hits and couldn't figure out how to get the following panel to show.

If anyone has the knowledge on how to create this panel I would greatly appreciate it!

(I tried to post the original thread from reddit but it kept flagging this post as spam)

Was able to reach out to the originator of this post from reddit and get a working version of this

SELECT "total_num_cachehits" FROM "unbound" WHERE ("host" = 'pfSense.localdomain') AND $timeFilter

SELECT "total_num_cachemiss" FROM "unbound" WHERE ("host" = 'pfSense.localdomain') AND $timeFilter

{
  "aliasColors": {
    "Hits": "#629e51",
    "Misses": "#bf1b00"
  },
  "breakPoint": "50%",
  "cacheTimeout": null,
  "combine": {
    "label": "Others",
    "threshold": 0
  },
  "datasource": "$dataSource",
  "decimals": null,
  "fieldConfig": {
    "defaults": {
      "custom": {}
    },
    "overrides": []
  },
  "fontSize": "100%",
  "format": "short",
  "gridPos": {
    "h": 6,
    "w": 3,
    "x": 13,
    "y": 7
  },
  "hideTimeOverride": false,
  "id": 23763571993,
  "interval": null,
  "legend": {
    "header": "",
    "percentage": true,
    "percentageDecimals": 0,
    "show": true,
    "sortDesc": true,
    "values": false
  },
  "legendType": "On graph",
  "links": [],
  "maxDataPoints": 3,
  "nullPointMode": "connected",
  "pieType": "donut",
  "pluginVersion": "6.3.3",
  "strokeWidth": "2",
  "targets": [
    {
      "alias": "Hits",
      "groupBy": [],
      "measurement": "unbound",
      "orderByTime": "ASC",
      "policy": "default",
      "refId": "A",
      "resultFormat": "time_series",
      "select": [
        [
          {
            "params": [
              "total_num_cachehits"
            ],
            "type": "field"
          }
        ]
      ],
      "tags": [
        {
          "key": "host",
          "operator": "=~",
          "value": "/^$Host$/"
        }
      ]
    },
    {
      "alias": "Misses",
      "groupBy": [],
      "measurement": "unbound",
      "orderByTime": "ASC",
      "policy": "default",
      "refId": "B",
      "resultFormat": "time_series",
      "select": [
        [
          {
            "params": [
              "total_num_cachemiss"
            ],
            "type": "field"
          }
        ]
      ],
      "tags": [
        {
          "key": "host",
          "operator": "=~",
          "value": "/^$Host$/"
        }
      ]
    }
  ],
  "thresholds": [],
  "timeFrom": null,
  "timeShift": null,
  "title": "DNS Cache Hit/Miss Ratio",
  "type": "grafana-piechart-panel",
  "valueName": "current"
}

Here is my current stats (I set min ttl to 3600 in unbound)

EDIT : I forgot to mention you have to use this command in the telegraf_unbound.sh and make sure you uncomment it from the telegraf config in the install instructions

unbound-control -c /var/unbound/unbound.conf stats_noreset | grep total.num

von Papst · Jan 27, 2021, 7:21 PM

I'm not sure where do I install these plugins and telegraf config. On my pfsense or on my Linux box where I have telegraf and influxdb installed?

bigjohns97 · Jan 27, 2021, 7:33 PM

@von-papst said in Grafana Dashboard using Telegraf with additional plugins:

I'm not sure where do I install these plugins and telegraf config. On my pfsense or on my Linux box where I have telegraf and influxdb installed?

Telegraf should be on your pfsense box and it should send to influxdb on your linux box, you shouldn't need Telegraf on your linux box for anything.

erbalo · Jan 27, 2021, 8:03 PM

@bigjohns97 said in Grafana Dashboard using Telegraf with additional plugins:

@bigjohns97 said in Grafana Dashboard using Telegraf with additional plugins:
I was playing with the telegraph_unbound script and noticed it wasn't working and ended up replacing the command in the script with the following
unbound-control -c /var/unbound/unbound.conf stats_noreset | grep total.num
This provides a cache hit stats output and was wondering if anyone had any skills with grafana to provide a nice panel addition to this already great dashboard. Was looking for something like this.

I found this thread from reddit where they were discussing how to optimize cache hits and couldn't figure out how to get the following panel to show.

If anyone has the knowledge on how to create this panel I would greatly appreciate it!

(I tried to post the original thread from reddit but it kept flagging this post as spam)
Was able to reach out to the originator of this post from reddit and get a working version of this
SELECT "total_num_cachehits" FROM "unbound" WHERE ("host" = 'pfSense.localdomain') AND $timeFilter
SELECT "total_num_cachemiss" FROM "unbound" WHERE ("host" = 'pfSense.localdomain') AND $timeFilter
{
  "aliasColors": {
    "Hits": "#629e51",
    "Misses": "#bf1b00"
  },
  "breakPoint": "50%",
  "cacheTimeout": null,
  "combine": {
    "label": "Others",
    "threshold": 0
  },
  "datasource": "PfSense",
  "decimals": null,
  "fieldConfig": {
    "defaults": {
      "custom": {}
    },
    "overrides": []
  },
  "fontSize": "100%",
  "format": "short",
  "gridPos": {
    "h": 6,
    "w": 3,
    "x": 13,
    "y": 7
  },
  "hideTimeOverride": false,
  "id": 23763571993,
  "interval": null,
  "legend": {
    "header": "",
    "percentage": true,
    "percentageDecimals": 0,
    "show": true,
    "sortDesc": true,
    "values": false
  },
  "legendType": "On graph",
  "links": [],
  "maxDataPoints": 3,
  "nullPointMode": "connected",
  "pieType": "donut",
  "pluginVersion": "6.3.3",
  "strokeWidth": "2",
  "targets": [
    {
      "alias": "Hits",
      "groupBy": [],
      "measurement": "unbound",
      "orderByTime": "ASC",
      "policy": "default",
      "refId": "A",
      "resultFormat": "time_series",
      "select": [
        [
          {
            "params": [
              "total_num_cachehits"
            ],
            "type": "field"
          }
        ]
      ],
      "tags": [
        {
          "key": "host",
          "operator": "=",
          "value": "pfSense.localdomain"
        }
      ]
    },
    {
      "alias": "Misses",
      "groupBy": [],
      "measurement": "unbound",
      "orderByTime": "ASC",
      "policy": "default",
      "refId": "B",
      "resultFormat": "time_series",
      "select": [
        [
          {
            "params": [
              "total_num_cachemiss"
            ],
            "type": "field"
          }
        ]
      ],
      "tags": [
        {
          "key": "host",
          "operator": "=",
          "value": "pfSense.localdomain"
        }
      ]
    }
  ],
  "thresholds": [],
  "timeFrom": null,
  "timeShift": null,
  "title": "DNS Cache Hit/Miss Ratio",
  "type": "grafana-piechart-panel",
  "valueName": "current"
}
Here is my current stats (I set min ttl to 3600 in unbound)

EDIT : I forgot to mention you have to use this command in the telegraf_unbound.sh and make sure you uncomment it from the telegraf config in the install instructions
unbound-control -c /var/unbound/unbound.conf stats_noreset | grep total.num

i am interesting on this graph. What can you do/analyze really with this graph DNS cache hit?

Do i only uncomend the unbound part on telegraf on pfsense and put the unbound-control.. to the telegraf.sh ?

#[[inputs.unbound]]

server = "127.0.0.1:953"

binary = "/usr/local/bin/telegraf_unbound.sh"

What should be the Server IP adres? is that my pfsense box?

bigjohns97 · Jan 27, 2021, 8:16 PM

@erbalo said in Grafana Dashboard using Telegraf with additional plugins:

@bigjohns97 said in Grafana Dashboard using Telegraf with additional plugins:
@bigjohns97 said in Grafana Dashboard using Telegraf with additional plugins:
I was playing with the telegraph_unbound script and noticed it wasn't working and ended up replacing the command in the script with the following
unbound-control -c /var/unbound/unbound.conf stats_noreset | grep total.num
This provides a cache hit stats output and was wondering if anyone had any skills with grafana to provide a nice panel addition to this already great dashboard. Was looking for something like this.

I found this thread from reddit where they were discussing how to optimize cache hits and couldn't figure out how to get the following panel to show.

If anyone has the knowledge on how to create this panel I would greatly appreciate it!

(I tried to post the original thread from reddit but it kept flagging this post as spam)
Was able to reach out to the originator of this post from reddit and get a working version of this
SELECT "total_num_cachehits" FROM "unbound" WHERE ("host" = 'pfSense.localdomain') AND $timeFilter
SELECT "total_num_cachemiss" FROM "unbound" WHERE ("host" = 'pfSense.localdomain') AND $timeFilter
{
  "aliasColors": {
    "Hits": "#629e51",
    "Misses": "#bf1b00"
  },
  "breakPoint": "50%",
  "cacheTimeout": null,
  "combine": {
    "label": "Others",
    "threshold": 0
  },
  "datasource": "PfSense",
  "decimals": null,
  "fieldConfig": {
    "defaults": {
      "custom": {}
    },
    "overrides": []
  },
  "fontSize": "100%",
  "format": "short",
  "gridPos": {
    "h": 6,
    "w": 3,
    "x": 13,
    "y": 7
  },
  "hideTimeOverride": false,
  "id": 23763571993,
  "interval": null,
  "legend": {
    "header": "",
    "percentage": true,
    "percentageDecimals": 0,
    "show": true,
    "sortDesc": true,
    "values": false
  },
  "legendType": "On graph",
  "links": [],
  "maxDataPoints": 3,
  "nullPointMode": "connected",
  "pieType": "donut",
  "pluginVersion": "6.3.3",
  "strokeWidth": "2",
  "targets": [
    {
      "alias": "Hits",
      "groupBy": [],
      "measurement": "unbound",
      "orderByTime": "ASC",
      "policy": "default",
      "refId": "A",
      "resultFormat": "time_series",
      "select": [
        [
          {
            "params": [
              "total_num_cachehits"
            ],
            "type": "field"
          }
        ]
      ],
      "tags": [
        {
          "key": "host",
          "operator": "=",
          "value": "pfSense.localdomain"
        }
      ]
    },
    {
      "alias": "Misses",
      "groupBy": [],
      "measurement": "unbound",
      "orderByTime": "ASC",
      "policy": "default",
      "refId": "B",
      "resultFormat": "time_series",
      "select": [
        [
          {
            "params": [
              "total_num_cachemiss"
            ],
            "type": "field"
          }
        ]
      ],
      "tags": [
        {
          "key": "host",
          "operator": "=",
          "value": "pfSense.localdomain"
        }
      ]
    }
  ],
  "thresholds": [],
  "timeFrom": null,
  "timeShift": null,
  "title": "DNS Cache Hit/Miss Ratio",
  "type": "grafana-piechart-panel",
  "valueName": "current"
}
Here is my current stats (I set min ttl to 3600 in unbound)

EDIT : I forgot to mention you have to use this command in the telegraf_unbound.sh and make sure you uncomment it from the telegraf config in the install instructions
unbound-control -c /var/unbound/unbound.conf stats_noreset | grep total.num
i am interesting on this graph. What can you do/analyze really with this graph DNS cache hit?

Do i only uncomend the unbound part on telegraf on pfsense and put the unbound-control.. to the telegraf.sh ?

#[[inputs.unbound]]

server = "127.0.0.1:953"

binary = "/usr/local/bin/telegraf_unbound.sh"

What should be the Server IP adres? is that my pfsense box?

Correct, uncomment out the part you posted and then go and edit the sh script with the "unbound-control" command I posted above.

As far as what purpose this serves, for me this helped me get to a point where the majority of my dns requests were cached and being responded to locally by pfsense, this greatly speeds up internet experience.

A lot of IOT devices today use very small TTLs which means pfsense is constantly sending out DNS traffic to DNS servers on the internet for domain queries. With a min TTL of 3600 I am telling unbound to always use at least 3600 as a minimum ttl. This sets a low watermark for all domains but allows domains above 3600 to keep their designed TTL as well.

As you can see it gives me a very high cache rate, and I have done this since way back when I was running pihole and have never seen any issues with it but you will hear from quite a few who believe this is a bad practice because it goes against what the domain owner intended. I have always felt that domain owners have to account for the lowest common denominator however so for me a 3600 min TTL is a nice middle ground between performance and proper name resolution.

erbalo · Jan 27, 2021, 8:28 PM

@bigjohns97

Thank you, which IP should i put here and late the port number 953 ?

server = "127.0.0.1:953"

erbalo · Jan 27, 2021, 8:32 PM

Should that be ok so?

#!/bin/sh
/usr/local/sbin/unbound-control -c /var/unbound/unbound.conf $* | grep -vE 'thread[0-9]+'
unbound-control -c /var/unbound/unbound.conf stats_noreset | grep total.num

bigjohns97 · Jan 27, 2021, 8:33 PM

@erbalo That server ip and port should be fine.

bigjohns97 · Jan 27, 2021, 8:39 PM

@erbalo said in Grafana Dashboard using Telegraf with additional plugins:

Should that be ok so?

#!/bin/sh
/usr/local/sbin/unbound-control -c /var/unbound/unbound.conf $* | grep -vE 'thread[0-9]+'
unbound-control -c /var/unbound/unbound.conf stats_noreset | grep total.num

When I tried running that command that was originally in there (your top line) it didn't work.

erbalo · Jan 27, 2021, 8:42 PM

@bigjohns97 said in Grafana Dashboard using Telegraf with additional plugins:

@erbalo said in Grafana Dashboard using Telegraf with additional plugins:
Should that be ok so?
#!/bin/sh
/usr/local/sbin/unbound-control -c /var/unbound/unbound.conf $* | grep -vE 'thread[0-9]+'
unbound-control -c /var/unbound/unbound.conf stats_noreset | grep total.num
When I tried running that command that was originally in there (your top line) it didn't work.

Just it should be:

#!/bin/sh
unbound-control -c /var/unbound/unbound.conf stats_noreset | grep total.num

?

bigjohns97 · Jan 27, 2021, 8:46 PM

@erbalo said in Grafana Dashboard using Telegraf with additional plugins:

@bigjohns97 said in Grafana Dashboard using Telegraf with additional plugins:
@erbalo said in Grafana Dashboard using Telegraf with additional plugins:
Should that be ok so?
#!/bin/sh
/usr/local/sbin/unbound-control -c /var/unbound/unbound.conf $* | grep -vE 'thread[0-9]+'
unbound-control -c /var/unbound/unbound.conf stats_noreset | grep total.num
When I tried running that command that was originally in there (your top line) it didn't work.
Just it should be:
#!/bin/sh
unbound-control -c /var/unbound/unbound.conf stats_noreset | grep total.num
?

That is what I am running, correct, and it didn't affect any other metrics.

erbalo · Jan 27, 2021, 9:13 PM

@bigjohns97 said in Grafana Dashboard using Telegraf with additional plugins:

@erbalo said in Grafana Dashboard using Telegraf with additional plugins:
@bigjohns97 said in Grafana Dashboard using Telegraf with additional plugins:
@erbalo said in Grafana Dashboard using Telegraf with additional plugins:
Should that be ok so?
#!/bin/sh
/usr/local/sbin/unbound-control -c /var/unbound/unbound.conf $* | grep -vE 'thread[0-9]+'
unbound-control -c /var/unbound/unbound.conf stats_noreset | grep total.num
When I tried running that command that was originally in there (your top line) it didn't work.
Just it should be:
#!/bin/sh
unbound-control -c /var/unbound/unbound.conf stats_noreset | grep total.num
?
That is what I am running, correct, and it didn't affect any other metrics.

I don't receive any data to grafana, what can be wrong?

bigjohns97 · Jan 27, 2021, 9:31 PM

@erbalo said in Grafana Dashboard using Telegraf with additional plugins:

@bigjohns97 said in Grafana Dashboard using Telegraf with additional plugins:
@erbalo said in Grafana Dashboard using Telegraf with additional plugins:
@bigjohns97 said in Grafana Dashboard using Telegraf with additional plugins:
@erbalo said in Grafana Dashboard using Telegraf with additional plugins:
Should that be ok so?
#!/bin/sh
/usr/local/sbin/unbound-control -c /var/unbound/unbound.conf $* | grep -vE 'thread[0-9]+'
unbound-control -c /var/unbound/unbound.conf stats_noreset | grep total.num
When I tried running that command that was originally in there (your top line) it didn't work.
Just it should be:
#!/bin/sh
unbound-control -c /var/unbound/unbound.conf stats_noreset | grep total.num
?
That is what I am running, correct, and it didn't affect any other metrics.
I don't receive any data to grafana, what can be wrong?

Make sure the data source and table is the same on your side as what I posted.

@erbalo copy the JSON from above again I replaced some of my entries with variables so be more plug and play.

von Papst · Jan 28, 2021, 2:46 PM

@bigjohns97 got it running. But still missing CPU, memory and system load data. What am I missing?

bigjohns97 · Jan 28, 2021, 2:53 PM

@von-papst This is just a single panel, add it to the dashboard being developed in this thread.

jpcapone · Feb 23, 2021, 2:18 AM

This post is deleted!

jpcapone · Feb 23, 2021, 3:04 AM

I think I am late to the party but I am trying to figure some things out. I am running pfsense in a vm on esxi 6.7. I was able to figure out enough to get most of the panels working but I think the scripts arent working. I am not super familiar with FreeBSD so I am finding it difficult to determine how to test run the scripts so that I can remediate. I am pretty sure the scripts arent running because all of the panels aren't populated with data and when I do a show measurements on the DB I get only the entries listed below. Any advice would be appreciated.
cpu
disk
diskio
mem
net
pf
processes
swap
system

bigjohns97 · Feb 23, 2021, 1:47 PM

@jpcapone This is the best way to troubleshoot the plugins

Taken from https://github.com/VictorRobellini/pfSense-Dashboard

jpcapone · Feb 23, 2021, 6:55 PM

This post is deleted!