[Feature Request] Support Blocky stats (Widget)

[garfieldairlines]

Description

Blocky is a DNS Server written in GO ( https://0xerr0r.github.io/blocky/v0.23/ ) that can also export some metrics ( https://0xerr0r.github.io/blocky/v0.23/prometheus_grafana/ ).

It doesn't have a web interface to configure it but would it be possible to add the metrics as a widget in homepage ?

Other

No response

[glime-ai[bot]]

To add Blocky's metrics as a widget in Homepage, you would typically use the Prometheus widget since Blocky can export metrics in a format that Prometheus can scrape. Once Prometheus is scraping Blocky's metrics, you can then configure the Prometheus widget in Homepage to display the desired metrics.

Here's a general outline of the steps you would need to follow:

1. Ensure that Blocky is configured to export metrics that Prometheus can scrape. This usually involves setting up Blocky to expose a /metrics endpoint.
2. Set up Prometheus to scrape metrics from Blocky's /metrics endpoint. This involves adding a scrape configuration for Blocky in Prometheus's configuration file.
3. Once Prometheus is successfully scraping metrics from Blocky, you can configure the Prometheus widget in Homepage to display these metrics. You would use the widget configuration for Prometheus as described in the Homepage documentation.

Here is an example of how the Prometheus widget configuration might look in your Homepage YAML configuration file:

widget:
  type: prometheus
  url: http://prometheushost:port

You would replace http://prometheushost:port with the actual URL and port where your Prometheus instance is accessible.

Please note that the specific metrics you want to display from Blocky will need to be defined in the Prometheus widget configuration. You can refer to the Prometheus widget documentation for Homepage to understand how to specify which metrics to display.

If you need further assistance with the specific configuration or if you encounter any issues, please provide more details, and I'll be happy to help you troubleshoot.

---

Thanks for posting a discussion about homepage here on GitHub. Homepage now uses a fancy new AI tool thanks to our friends at Glime, so the answer above is the AI bot's attempt to answer your question. If you feel it's sufficient you can mark the answer and close this post, otherwise feel free to leave it open of course!

Thanks for using Homepage! ❤️

This comment was generated by Glime.

[joryirving]

I would also like to see Blocky added, since we already have NextDNS.

[machsix]

Prometheus is an overkill here

[machsix]

http://homelab.local:4000/metrics

returns a list like the following. Sadly, it's not JSON

# HELP blocky_blocking_enabled Blocking status
# TYPE blocky_blocking_enabled gauge
blocky_blocking_enabled 1
# HELP blocky_build_info Version number and build info
# TYPE blocky_build_info gauge
blocky_build_info{build_time="20240525-085726",version="v0.24"} 1
# HELP blocky_cache_entry_count Number of entries in cache
# TYPE blocky_cache_entry_count gauge
blocky_cache_entry_count 10
# HELP blocky_cache_hit_count Cache hit counter
# TYPE blocky_cache_hit_count counter
blocky_cache_hit_count 12
# HELP blocky_cache_miss_count Cache miss counter
# TYPE blocky_cache_miss_count counter
blocky_cache_miss_count 11
# HELP blocky_denylist_cache Number of entries in the denylist cache
# TYPE blocky_denylist_cache gauge
blocky_denylist_cache{group="ads"} 170239
# HELP blocky_error_total Number of total errors
# TYPE blocky_error_total counter
blocky_error_total 0
# HELP blocky_failed_download_count Failed download counter
# TYPE blocky_failed_download_count counter
blocky_failed_download_count 0
# HELP blocky_last_list_group_refresh Timestamp of last list refresh
# TYPE blocky_last_list_group_refresh gauge
blocky_last_list_group_refresh 1.724519958e+09
# HELP blocky_prefetch_count Prefetch counter
# TYPE blocky_prefetch_count counter
blocky_prefetch_count 0
# HELP blocky_prefetch_domain_name_cache_count Number of entries in domain cache
# TYPE blocky_prefetch_domain_name_cache_count gauge
blocky_prefetch_domain_name_cache_count 11
# HELP blocky_prefetch_hit_count Prefetch hit counter
# TYPE blocky_prefetch_hit_count counter
blocky_prefetch_hit_count 0
# HELP blocky_query_total Number of total queries
# TYPE blocky_query_total counter
blocky_query_total{client="10.10.1.3",type="A"} 10
blocky_query_total{client="10.10.1.3",type="AAAA"} 1
blocky_query_total{client="10.88.111.1",type="A"} 9
blocky_query_total{client="10.88.111.1",type="AAAA"} 1
blocky_query_total{client="10.88.111.3",type="A"} 1
blocky_query_total{client="10.88.111.6",type="A"} 1
# HELP blocky_request_duration_ms Request duration distribution
# TYPE blocky_request_duration_ms histogram
blocky_request_duration_ms_bucket{response_type="CACHED",le="5"} 12
blocky_request_duration_ms_bucket{response_type="CACHED",le="10"} 12
blocky_request_duration_ms_bucket{response_type="CACHED",le="20"} 12
blocky_request_duration_ms_bucket{response_type="CACHED",le="30"} 12
blocky_request_duration_ms_bucket{response_type="CACHED",le="50"} 12
blocky_request_duration_ms_bucket{response_type="CACHED",le="75"} 12
blocky_request_duration_ms_bucket{response_type="CACHED",le="100"} 12
blocky_request_duration_ms_bucket{response_type="CACHED",le="200"} 12
blocky_request_duration_ms_bucket{response_type="CACHED",le="500"} 12
blocky_request_duration_ms_bucket{response_type="CACHED",le="1000"} 12
blocky_request_duration_ms_bucket{response_type="CACHED",le="2000"} 12
blocky_request_duration_ms_bucket{response_type="CACHED",le="+Inf"} 12
blocky_request_duration_ms_sum{response_type="CACHED"} 3
blocky_request_duration_ms_count{response_type="CACHED"} 12
blocky_request_duration_ms_bucket{response_type="RESOLVED",le="5"} 1
blocky_request_duration_ms_bucket{response_type="RESOLVED",le="10"} 9
blocky_request_duration_ms_bucket{response_type="RESOLVED",le="20"} 10
blocky_request_duration_ms_bucket{response_type="RESOLVED",le="30"} 10
blocky_request_duration_ms_bucket{response_type="RESOLVED",le="50"} 10
blocky_request_duration_ms_bucket{response_type="RESOLVED",le="75"} 10
blocky_request_duration_ms_bucket{response_type="RESOLVED",le="100"} 10
blocky_request_duration_ms_bucket{response_type="RESOLVED",le="200"} 10
blocky_request_duration_ms_bucket{response_type="RESOLVED",le="500"} 10
blocky_request_duration_ms_bucket{response_type="RESOLVED",le="1000"} 10
blocky_request_duration_ms_bucket{response_type="RESOLVED",le="2000"} 10
blocky_request_duration_ms_bucket{response_type="RESOLVED",le="+Inf"} 10
blocky_request_duration_ms_sum{response_type="RESOLVED"} 86
blocky_request_duration_ms_count{response_type="RESOLVED"} 10
blocky_request_duration_ms_bucket{response_type="SPECIAL",le="5"} 1
blocky_request_duration_ms_bucket{response_type="SPECIAL",le="10"} 1
blocky_request_duration_ms_bucket{response_type="SPECIAL",le="20"} 1
blocky_request_duration_ms_bucket{response_type="SPECIAL",le="30"} 1
blocky_request_duration_ms_bucket{response_type="SPECIAL",le="50"} 1
blocky_request_duration_ms_bucket{response_type="SPECIAL",le="75"} 1
blocky_request_duration_ms_bucket{response_type="SPECIAL",le="100"} 1
blocky_request_duration_ms_bucket{response_type="SPECIAL",le="200"} 1
blocky_request_duration_ms_bucket{response_type="SPECIAL",le="500"} 1
blocky_request_duration_ms_bucket{response_type="SPECIAL",le="1000"} 1
blocky_request_duration_ms_bucket{response_type="SPECIAL",le="2000"} 1
blocky_request_duration_ms_bucket{response_type="SPECIAL",le="+Inf"} 1
blocky_request_duration_ms_sum{response_type="SPECIAL"} 0
blocky_request_duration_ms_count{response_type="SPECIAL"} 1
# HELP blocky_response_total Number of total responses
# TYPE blocky_response_total counter
blocky_response_total{reason="CACHED",response_code="NOERROR",response_type="CACHED"} 9
blocky_response_total{reason="CACHED NEGATIVE",response_code="NXDOMAIN",response_type="CACHED"} 3
blocky_response_total{reason="RESOLVED (tcp+udp:1.0.0.2)",response_code="NOERROR",response_type="RESOLVED"} 3
blocky_response_total{reason="RESOLVED (tcp+udp:1.1.1.2)",response_code="NOERROR",response_type="RESOLVED"} 2
blocky_response_total{reason="RESOLVED (tcp+udp:9.9.9.9)",response_code="NOERROR",response_type="RESOLVED"} 5
blocky_response_total{reason="Special-Use Domain Name",response_code="NXDOMAIN",response_type="SPECIAL"} 1
# HELP go_gc_duration_seconds A summary of the pause duration of garbage collection cycles.
# TYPE go_gc_duration_seconds summary
go_gc_duration_seconds{quantile="0"} 0.0002452
go_gc_duration_seconds{quantile="0.25"} 0.0003864
go_gc_duration_seconds{quantile="0.5"} 0.00043196
go_gc_duration_seconds{quantile="0.75"} 0.000562121
go_gc_duration_seconds{quantile="1"} 0.008207447
go_gc_duration_seconds_sum 0.168661911
go_gc_duration_seconds_count 261
# HELP go_goroutines Number of goroutines that currently exist.
# TYPE go_goroutines gauge
go_goroutines 23
# HELP go_info Information about the Go environment.
# TYPE go_info gauge
go_info{version="go1.22.3"} 1
# HELP go_memstats_alloc_bytes Number of bytes allocated and still in use.
# TYPE go_memstats_alloc_bytes gauge
go_memstats_alloc_bytes 4.985984e+06
# HELP go_memstats_alloc_bytes_total Total number of bytes allocated, even if freed.
# TYPE go_memstats_alloc_bytes_total counter
go_memstats_alloc_bytes_total 1.479443416e+09
# HELP go_memstats_buck_hash_sys_bytes Number of bytes used by the profiling bucket hash table.
# TYPE go_memstats_buck_hash_sys_bytes gauge
go_memstats_buck_hash_sys_bytes 735619
# HELP go_memstats_frees_total Total number of frees.
# TYPE go_memstats_frees_total counter
go_memstats_frees_total 3.964063e+06
# HELP go_memstats_gc_sys_bytes Number of bytes used for garbage collection system metadata.
# TYPE go_memstats_gc_sys_bytes gauge
go_memstats_gc_sys_bytes 1.140496e+06
# HELP go_memstats_heap_alloc_bytes Number of heap bytes allocated and still in use.
# TYPE go_memstats_heap_alloc_bytes gauge
go_memstats_heap_alloc_bytes 4.985984e+06
# HELP go_memstats_heap_idle_bytes Number of heap bytes waiting to be used.
# TYPE go_memstats_heap_idle_bytes gauge
go_memstats_heap_idle_bytes 1.7539072e+07
# HELP go_memstats_heap_inuse_bytes Number of heap bytes that are in use.
# TYPE go_memstats_heap_inuse_bytes gauge
go_memstats_heap_inuse_bytes 6.938624e+06
# HELP go_memstats_heap_objects Number of allocated objects.
# TYPE go_memstats_heap_objects gauge
go_memstats_heap_objects 14518
# HELP go_memstats_heap_released_bytes Number of heap bytes released to OS.
# TYPE go_memstats_heap_released_bytes gauge
go_memstats_heap_released_bytes 1.7350656e+07
# HELP go_memstats_heap_sys_bytes Number of heap bytes obtained from system.
# TYPE go_memstats_heap_sys_bytes gauge
go_memstats_heap_sys_bytes 2.4477696e+07
# HELP go_memstats_last_gc_time_seconds Number of seconds since 1970 of last garbage collection.
# TYPE go_memstats_last_gc_time_seconds gauge
go_memstats_last_gc_time_seconds 1.7245199586682086e+09
# HELP go_memstats_lookups_total Total number of pointer lookups.
# TYPE go_memstats_lookups_total counter
go_memstats_lookups_total 0
# HELP go_memstats_mallocs_total Total number of mallocs.
# TYPE go_memstats_mallocs_total counter
go_memstats_mallocs_total 3.978581e+06
# HELP go_memstats_mcache_inuse_bytes Number of bytes in use by mcache structures.
# TYPE go_memstats_mcache_inuse_bytes gauge
go_memstats_mcache_inuse_bytes 1200
# HELP go_memstats_mcache_sys_bytes Number of bytes used for mcache structures obtained from system.
# TYPE go_memstats_mcache_sys_bytes gauge
go_memstats_mcache_sys_bytes 16200
# HELP go_memstats_mspan_inuse_bytes Number of bytes in use by mspan structures.
# TYPE go_memstats_mspan_inuse_bytes gauge
go_memstats_mspan_inuse_bytes 56640
# HELP go_memstats_mspan_sys_bytes Number of bytes used for mspan structures obtained from system.
# TYPE go_memstats_mspan_sys_bytes gauge
go_memstats_mspan_sys_bytes 228480
# HELP go_memstats_next_gc_bytes Number of heap bytes when next garbage collection will take place.
# TYPE go_memstats_next_gc_bytes gauge
go_memstats_next_gc_bytes 9.051824e+06
# HELP go_memstats_other_sys_bytes Number of bytes used for other system allocations.
# TYPE go_memstats_other_sys_bytes gauge
go_memstats_other_sys_bytes 593953
# HELP go_memstats_stack_inuse_bytes Number of bytes in use by the stack allocator.
# TYPE go_memstats_stack_inuse_bytes gauge
go_memstats_stack_inuse_bytes 688128
# HELP go_memstats_stack_sys_bytes Number of bytes obtained from system for stack allocator.
# TYPE go_memstats_stack_sys_bytes gauge
go_memstats_stack_sys_bytes 688128
# HELP go_memstats_sys_bytes Number of bytes obtained from system.
# TYPE go_memstats_sys_bytes gauge
go_memstats_sys_bytes 2.7880572e+07
# HELP go_threads Number of OS threads created.
# TYPE go_threads gauge
go_threads 8
# HELP process_cpu_seconds_total Total user and system CPU time spent in seconds.
# TYPE process_cpu_seconds_total counter
process_cpu_seconds_total 40.55
# HELP process_max_fds Maximum number of open file descriptors.
# TYPE process_max_fds gauge
process_max_fds 1.048576e+06
# HELP process_open_fds Number of open file descriptors.
# TYPE process_open_fds gauge
process_open_fds 12
# HELP process_resident_memory_bytes Resident memory size in bytes.
# TYPE process_resident_memory_bytes gauge
process_resident_memory_bytes 2.3425024e+07
# HELP process_start_time_seconds Start time of the process since unix epoch in seconds.
# TYPE process_start_time_seconds gauge
process_start_time_seconds 1.72451992961e+09
# HELP process_virtual_memory_bytes Virtual memory size in bytes.
# TYPE process_virtual_memory_bytes gauge
process_virtual_memory_bytes 5.68430592e+08
# HELP process_virtual_memory_max_bytes Maximum amount of virtual memory available in bytes.
# TYPE process_virtual_memory_max_bytes gauge
process_virtual_memory_max_bytes 1.8446744073709552e+19
# HELP promhttp_metric_handler_requests_in_flight Current number of scrapes being served.
# TYPE promhttp_metric_handler_requests_in_flight gauge
promhttp_metric_handler_requests_in_flight 1
# HELP promhttp_metric_handler_requests_total Total number of scrapes by HTTP status code.
# TYPE promhttp_metric_handler_requests_total counter
promhttp_metric_handler_requests_total{code="200"} 1
promhttp_metric_handler_requests_total{code="500"} 0
promhttp_metric_handler_requests_total{code="503"} 0

[astappiev]

Even worse, the metrics are not aggregated but instead updated every time.

So the blocky_query_total metric will show only the number of queries in the last 15 seconds (or so, but less than a minute).
To make a widget similar to PiHome or AdGuard widgets we need to store them in Prometheus.