Move most of the code out of package main
This commit is contained in:
Matthew McPherrin
parent
5e9c7ff5c5
commit
12dc575113
|
|
@ -8,10 +8,11 @@ COPY go.sum .
|
|||
RUN go mod download
|
||||
|
||||
COPY *.go .
|
||||
COPY internal internal
|
||||
|
||||
ENV CGO_ENABLED=0
|
||||
|
||||
RUN GOOS=$TARGETOS GOARCH=$TARGETPLATFORM go build -v -o /go/bin/unbound_exporter ./...
|
||||
RUN GOOS=$TARGETOS GOARCH=$TARGETPLATFORM go build -v -o /go/bin/unbound_exporter .
|
||||
|
||||
FROM gcr.io/distroless/static-debian12
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,507 @@
|
|||
package exporter
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"crypto/tls"
|
||||
"crypto/x509"
|
||||
"fmt"
|
||||
"io"
|
||||
"net"
|
||||
"net/url"
|
||||
"os"
|
||||
"regexp"
|
||||
"sort"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"github.com/go-kit/log"
|
||||
"github.com/go-kit/log/level"
|
||||
"github.com/prometheus/client_golang/prometheus"
|
||||
)
|
||||
|
||||
var unboundUpDesc = prometheus.NewDesc(
|
||||
prometheus.BuildFQName("unbound", "", "up"),
|
||||
"Whether scraping Unbound's metrics was successful.",
|
||||
nil, nil)
|
||||
|
||||
var unboundHistogram = prometheus.NewDesc(
|
||||
prometheus.BuildFQName("unbound", "", "response_time_seconds"),
|
||||
"Query response time in seconds.",
|
||||
nil, nil)
|
||||
|
||||
var unboundMetrics = []*unboundMetric{
|
||||
newUnboundMetric(
|
||||
"answer_rcodes_total",
|
||||
"Total number of answers to queries, from cache or from recursion, by response code.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"rcode"},
|
||||
"^num\\.answer\\.rcode\\.(\\w+)$"),
|
||||
newUnboundMetric(
|
||||
"answers_bogus",
|
||||
"Total number of answers that were bogus.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.answer\\.bogus$"),
|
||||
newUnboundMetric(
|
||||
"answers_secure_total",
|
||||
"Total number of answers that were secure.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.answer\\.secure$"),
|
||||
newUnboundMetric(
|
||||
"cache_hits_total",
|
||||
"Total number of queries that were successfully answered using a cache lookup.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread(\\d+)\\.num\\.cachehits$"),
|
||||
newUnboundMetric(
|
||||
"cache_misses_total",
|
||||
"Total number of cache queries that needed recursive processing.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread(\\d+)\\.num\\.cachemiss$"),
|
||||
newUnboundMetric(
|
||||
"queries_cookie_client_total",
|
||||
"Total number of queries with a client cookie.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread(\\d+)\\.num\\.queries_cookie_client$"),
|
||||
newUnboundMetric(
|
||||
"queries_cookie_invalid_total",
|
||||
"Total number of queries with a invalid cookie.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread(\\d+)\\.num\\.queries_invalid_client$"),
|
||||
newUnboundMetric(
|
||||
"queries_cookie_valid_total",
|
||||
"Total number of queries with a valid cookie.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread(\\d+)\\.num\\.queries_cookie_valid$"),
|
||||
newUnboundMetric(
|
||||
"memory_caches_bytes",
|
||||
"Memory in bytes in use by caches.",
|
||||
prometheus.GaugeValue,
|
||||
[]string{"cache"},
|
||||
"^mem\\.cache\\.(\\w+)$"),
|
||||
newUnboundMetric(
|
||||
"memory_modules_bytes",
|
||||
"Memory in bytes in use by modules.",
|
||||
prometheus.GaugeValue,
|
||||
[]string{"module"},
|
||||
"^mem\\.mod\\.(\\w+)$"),
|
||||
newUnboundMetric(
|
||||
"memory_sbrk_bytes",
|
||||
"Memory in bytes allocated through sbrk.",
|
||||
prometheus.GaugeValue,
|
||||
nil,
|
||||
"^mem\\.total\\.sbrk$"),
|
||||
newUnboundMetric(
|
||||
"prefetches_total",
|
||||
"Total number of cache prefetches performed.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread(\\d+)\\.num\\.prefetch$"),
|
||||
newUnboundMetric(
|
||||
"queries_total",
|
||||
"Total number of queries received.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread(\\d+)\\.num\\.queries$"),
|
||||
newUnboundMetric(
|
||||
"expired_total",
|
||||
"Total number of expired entries served.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread(\\d+)\\.num\\.expired$"),
|
||||
newUnboundMetric(
|
||||
"query_classes_total",
|
||||
"Total number of queries with a given query class.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"class"},
|
||||
"^num\\.query\\.class\\.([\\w]+)$"),
|
||||
newUnboundMetric(
|
||||
"query_flags_total",
|
||||
"Total number of queries that had a given flag set in the header.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"flag"},
|
||||
"^num\\.query\\.flags\\.([\\w]+)$"),
|
||||
newUnboundMetric(
|
||||
"query_ipv6_total",
|
||||
"Total number of queries that were made using IPv6 towards the Unbound server.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.query\\.ipv6$"),
|
||||
newUnboundMetric(
|
||||
"query_opcodes_total",
|
||||
"Total number of queries with a given query opcode.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"opcode"},
|
||||
"^num\\.query\\.opcode\\.([\\w]+)$"),
|
||||
newUnboundMetric(
|
||||
"query_edns_DO_total",
|
||||
"Total number of queries that had an EDNS OPT record with the DO (DNSSEC OK) bit set present.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.query\\.edns\\.DO$"),
|
||||
newUnboundMetric(
|
||||
"query_edns_present_total",
|
||||
"Total number of queries that had an EDNS OPT record present.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.query\\.edns\\.present$"),
|
||||
newUnboundMetric(
|
||||
"query_tcp_total",
|
||||
"Total number of queries that were made using TCP towards the Unbound server, including DoT and DoH queries.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.query\\.tcp$"),
|
||||
newUnboundMetric(
|
||||
"query_tcpout_total",
|
||||
"Total number of queries that the Unbound server made using TCP outgoing towards other servers.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.query\\.tcpout$"),
|
||||
newUnboundMetric(
|
||||
"query_tls_total",
|
||||
"Total number of queries that were made using TCP TLS towards the Unbound server, including DoT and DoH queries.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.query\\.tls$"),
|
||||
newUnboundMetric(
|
||||
"query_tls_resume_total",
|
||||
"Total number of queries that were made using TCP TLS Resume towards the Unbound server.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.query\\.tls\\.resume$"),
|
||||
newUnboundMetric(
|
||||
"query_https_total",
|
||||
"Total number of queries that were made using HTTPS towards the Unbound server.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.query\\.https$"),
|
||||
newUnboundMetric(
|
||||
"query_types_total",
|
||||
"Total number of queries with a given query type.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"type"},
|
||||
"^num\\.query\\.type\\.([\\w]+)$"),
|
||||
newUnboundMetric(
|
||||
"query_udpout_total",
|
||||
"Total number of queries that the Unbound server made using UDP outgoing towardsother servers.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.query\\.udpout$"),
|
||||
newUnboundMetric(
|
||||
"query_aggressive_nsec",
|
||||
"Total number of queries that the Unbound server generated response using Aggressive NSEC.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"rcode"},
|
||||
"^num\\.query\\.aggressive\\.(\\w+)$"),
|
||||
newUnboundMetric(
|
||||
"request_list_current_all",
|
||||
"Current size of the request list, including internally generated queries.",
|
||||
prometheus.GaugeValue,
|
||||
[]string{"thread"},
|
||||
"^thread([0-9]+)\\.requestlist\\.current\\.all$"),
|
||||
newUnboundMetric(
|
||||
"request_list_current_user",
|
||||
"Current size of the request list, only counting the requests from client queries.",
|
||||
prometheus.GaugeValue,
|
||||
[]string{"thread"},
|
||||
"^thread([0-9]+)\\.requestlist\\.current\\.user$"),
|
||||
newUnboundMetric(
|
||||
"request_list_exceeded_total",
|
||||
"Number of queries that were dropped because the request list was full.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread([0-9]+)\\.requestlist\\.exceeded$"),
|
||||
newUnboundMetric(
|
||||
"request_list_overwritten_total",
|
||||
"Total number of requests in the request list that were overwritten by newer entries.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread([0-9]+)\\.requestlist\\.overwritten$"),
|
||||
newUnboundMetric(
|
||||
"recursive_replies_total",
|
||||
"Total number of replies sent to queries that needed recursive processing.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread(\\d+)\\.num\\.recursivereplies$"),
|
||||
newUnboundMetric(
|
||||
"rrset_bogus_total",
|
||||
"Total number of rrsets marked bogus by the validator.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.rrset\\.bogus$"),
|
||||
newUnboundMetric(
|
||||
"rrset_cache_max_collisions_total",
|
||||
"Total number of rrset cache hashtable collisions.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^rrset\\.cache\\.max_collisions$"),
|
||||
newUnboundMetric(
|
||||
"time_elapsed_seconds",
|
||||
"Time since last statistics printout in seconds.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^time\\.elapsed$"),
|
||||
newUnboundMetric(
|
||||
"time_now_seconds",
|
||||
"Current time in seconds since 1970.",
|
||||
prometheus.GaugeValue,
|
||||
nil,
|
||||
"^time\\.now$"),
|
||||
newUnboundMetric(
|
||||
"time_up_seconds_total",
|
||||
"Uptime since server boot in seconds.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^time\\.up$"),
|
||||
newUnboundMetric(
|
||||
"unwanted_queries_total",
|
||||
"Total number of queries that were refused or dropped because they failed the access control settings.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^unwanted\\.queries$"),
|
||||
newUnboundMetric(
|
||||
"unwanted_replies_total",
|
||||
"Total number of replies that were unwanted or unsolicited.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^unwanted\\.replies$"),
|
||||
newUnboundMetric(
|
||||
"recursion_time_seconds_avg",
|
||||
"Average time it took to answer queries that needed recursive processing (does not include in-cache requests).",
|
||||
prometheus.GaugeValue,
|
||||
nil,
|
||||
"^total\\.recursion\\.time\\.avg$"),
|
||||
newUnboundMetric(
|
||||
"recursion_time_seconds_median",
|
||||
"The median of the time it took to answer queries that needed recursive processing.",
|
||||
prometheus.GaugeValue,
|
||||
nil,
|
||||
"^total\\.recursion\\.time\\.median$"),
|
||||
newUnboundMetric(
|
||||
"msg_cache_count",
|
||||
"The Number of Messages cached",
|
||||
prometheus.GaugeValue,
|
||||
nil,
|
||||
"^msg\\.cache\\.count$"),
|
||||
newUnboundMetric(
|
||||
"msg_cache_max_collisions_total",
|
||||
"Total number of msg cache hashtable collisions.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^msg\\.cache\\.max_collisions$"),
|
||||
newUnboundMetric(
|
||||
"rrset_cache_count",
|
||||
"The Number of rrset cached",
|
||||
prometheus.GaugeValue,
|
||||
nil,
|
||||
"^rrset\\.cache\\.count$"),
|
||||
}
|
||||
|
||||
type unboundMetric struct {
|
||||
desc *prometheus.Desc
|
||||
valueType prometheus.ValueType
|
||||
pattern *regexp.Regexp
|
||||
}
|
||||
|
||||
func newUnboundMetric(name string, description string, valueType prometheus.ValueType, labels []string, pattern string) *unboundMetric {
|
||||
return &unboundMetric{
|
||||
desc: prometheus.NewDesc(
|
||||
prometheus.BuildFQName("unbound", "", name),
|
||||
description,
|
||||
labels,
|
||||
nil),
|
||||
valueType: valueType,
|
||||
pattern: regexp.MustCompile(pattern),
|
||||
}
|
||||
}
|
||||
|
||||
func CollectFromReader(file io.Reader, ch chan<- prometheus.Metric) error {
|
||||
scanner := bufio.NewScanner(file)
|
||||
scanner.Split(bufio.ScanLines)
|
||||
histogramPattern := regexp.MustCompile(`^histogram\.\d+\.\d+\.to\.(\d+\.\d+)$`)
|
||||
|
||||
histogramCount := uint64(0)
|
||||
histogramAvg := float64(0)
|
||||
histogramBuckets := make(map[float64]uint64)
|
||||
|
||||
for scanner.Scan() {
|
||||
fields := strings.Split(scanner.Text(), "=")
|
||||
if len(fields) != 2 {
|
||||
return fmt.Errorf(
|
||||
"%q is not a valid key-value pair",
|
||||
scanner.Text())
|
||||
}
|
||||
|
||||
for _, metric := range unboundMetrics {
|
||||
if matches := metric.pattern.FindStringSubmatch(fields[0]); matches != nil {
|
||||
value, err := strconv.ParseFloat(fields[1], 64)
|
||||
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
metric.desc,
|
||||
metric.valueType,
|
||||
value,
|
||||
matches[1:]...)
|
||||
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if matches := histogramPattern.FindStringSubmatch(fields[0]); matches != nil {
|
||||
end, err := strconv.ParseFloat(matches[1], 64)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
value, err := strconv.ParseUint(fields[1], 10, 64)
|
||||
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
histogramBuckets[end] = value
|
||||
histogramCount += value
|
||||
} else if fields[0] == "total.recursion.time.avg" {
|
||||
value, err := strconv.ParseFloat(fields[1], 64)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
histogramAvg = value
|
||||
}
|
||||
}
|
||||
|
||||
// Convert the metrics to a cumulative Prometheus histogram.
|
||||
// Reconstruct the sum of all samples from the average value
|
||||
// provided by Unbound. Hopefully this does not break
|
||||
// monotonicity.
|
||||
keys := []float64{}
|
||||
for k := range histogramBuckets {
|
||||
keys = append(keys, k)
|
||||
}
|
||||
sort.Float64s(keys)
|
||||
prev := uint64(0)
|
||||
for _, i := range keys {
|
||||
histogramBuckets[i] += prev
|
||||
prev = histogramBuckets[i]
|
||||
}
|
||||
ch <- prometheus.MustNewConstHistogram(
|
||||
unboundHistogram,
|
||||
histogramCount,
|
||||
histogramAvg*float64(histogramCount),
|
||||
histogramBuckets)
|
||||
|
||||
return scanner.Err()
|
||||
}
|
||||
|
||||
func CollectFromSocket(socketFamily string, host string, tlsConfig *tls.Config, ch chan<- prometheus.Metric) error {
|
||||
var (
|
||||
conn net.Conn
|
||||
err error
|
||||
)
|
||||
|
||||
if socketFamily == "unix" || tlsConfig == nil {
|
||||
conn, err = net.Dial(socketFamily, host)
|
||||
} else {
|
||||
conn, err = tls.Dial(socketFamily, host, tlsConfig)
|
||||
}
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer conn.Close()
|
||||
_, err = conn.Write([]byte("UBCT1 stats_noreset\n"))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return CollectFromReader(conn, ch)
|
||||
}
|
||||
|
||||
type UnboundExporter struct {
|
||||
log log.Logger
|
||||
socketFamily string
|
||||
host string
|
||||
tlsConfig *tls.Config
|
||||
}
|
||||
|
||||
func NewUnboundExporter(log log.Logger, host string, ca string, cert string, key string) (*UnboundExporter, error) {
|
||||
u, err := url.Parse(host)
|
||||
if err != nil {
|
||||
return &UnboundExporter{}, err
|
||||
}
|
||||
|
||||
if u.Scheme == "unix" {
|
||||
return &UnboundExporter{
|
||||
socketFamily: u.Scheme,
|
||||
host: u.Path,
|
||||
}, nil
|
||||
}
|
||||
|
||||
if ca == "" && cert == "" {
|
||||
return &UnboundExporter{
|
||||
socketFamily: u.Scheme,
|
||||
host: u.Host,
|
||||
}, nil
|
||||
}
|
||||
|
||||
/* Server authentication. */
|
||||
caData, err := os.ReadFile(ca)
|
||||
if err != nil {
|
||||
return &UnboundExporter{}, err
|
||||
}
|
||||
roots := x509.NewCertPool()
|
||||
if !roots.AppendCertsFromPEM(caData) {
|
||||
return &UnboundExporter{}, fmt.Errorf("Failed to parse CA")
|
||||
}
|
||||
|
||||
/* Client authentication. */
|
||||
certData, err := os.ReadFile(cert)
|
||||
if err != nil {
|
||||
return &UnboundExporter{}, err
|
||||
}
|
||||
keyData, err := os.ReadFile(key)
|
||||
if err != nil {
|
||||
return &UnboundExporter{}, err
|
||||
}
|
||||
keyPair, err := tls.X509KeyPair(certData, keyData)
|
||||
if err != nil {
|
||||
return &UnboundExporter{}, err
|
||||
}
|
||||
|
||||
return &UnboundExporter{
|
||||
log: log,
|
||||
socketFamily: u.Scheme,
|
||||
host: u.Host,
|
||||
tlsConfig: &tls.Config{
|
||||
Certificates: []tls.Certificate{keyPair},
|
||||
RootCAs: roots,
|
||||
ServerName: "unbound",
|
||||
},
|
||||
}, nil
|
||||
}
|
||||
|
||||
func (e *UnboundExporter) Describe(ch chan<- *prometheus.Desc) {
|
||||
ch <- unboundUpDesc
|
||||
for _, metric := range unboundMetrics {
|
||||
ch <- metric.desc
|
||||
}
|
||||
}
|
||||
|
||||
func (e *UnboundExporter) Collect(ch chan<- prometheus.Metric) {
|
||||
err := CollectFromSocket(e.socketFamily, e.host, e.tlsConfig, ch)
|
||||
if err == nil {
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
unboundUpDesc,
|
||||
prometheus.GaugeValue,
|
||||
1.0)
|
||||
} else {
|
||||
_ = level.Error(e.log).Log("Failed to scrape socket: ", err)
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
unboundUpDesc,
|
||||
prometheus.GaugeValue,
|
||||
0.0)
|
||||
}
|
||||
}
|
||||
|
|
@ -14,517 +14,22 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"crypto/tls"
|
||||
"crypto/x509"
|
||||
"flag"
|
||||
"fmt"
|
||||
"io"
|
||||
"net"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"os"
|
||||
"regexp"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"sort"
|
||||
|
||||
"github.com/go-kit/log/level"
|
||||
"github.com/prometheus/client_golang/prometheus"
|
||||
"github.com/prometheus/client_golang/prometheus/promhttp"
|
||||
"github.com/prometheus/common/promlog"
|
||||
|
||||
"github.com/letsencrypt/unbound_exporter/internal/exporter"
|
||||
)
|
||||
|
||||
var (
|
||||
log = promlog.New(&promlog.Config{})
|
||||
|
||||
unboundUpDesc = prometheus.NewDesc(
|
||||
prometheus.BuildFQName("unbound", "", "up"),
|
||||
"Whether scraping Unbound's metrics was successful.",
|
||||
nil, nil)
|
||||
|
||||
unboundHistogram = prometheus.NewDesc(
|
||||
prometheus.BuildFQName("unbound", "", "response_time_seconds"),
|
||||
"Query response time in seconds.",
|
||||
nil, nil)
|
||||
|
||||
unboundMetrics = []*unboundMetric{
|
||||
newUnboundMetric(
|
||||
"answer_rcodes_total",
|
||||
"Total number of answers to queries, from cache or from recursion, by response code.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"rcode"},
|
||||
"^num\\.answer\\.rcode\\.(\\w+)$"),
|
||||
newUnboundMetric(
|
||||
"answers_bogus",
|
||||
"Total number of answers that were bogus.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.answer\\.bogus$"),
|
||||
newUnboundMetric(
|
||||
"answers_secure_total",
|
||||
"Total number of answers that were secure.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.answer\\.secure$"),
|
||||
newUnboundMetric(
|
||||
"cache_hits_total",
|
||||
"Total number of queries that were successfully answered using a cache lookup.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread(\\d+)\\.num\\.cachehits$"),
|
||||
newUnboundMetric(
|
||||
"cache_misses_total",
|
||||
"Total number of cache queries that needed recursive processing.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread(\\d+)\\.num\\.cachemiss$"),
|
||||
newUnboundMetric(
|
||||
"queries_cookie_client_total",
|
||||
"Total number of queries with a client cookie.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread(\\d+)\\.num\\.queries_cookie_client$"),
|
||||
newUnboundMetric(
|
||||
"queries_cookie_invalid_total",
|
||||
"Total number of queries with a invalid cookie.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread(\\d+)\\.num\\.queries_invalid_client$"),
|
||||
newUnboundMetric(
|
||||
"queries_cookie_valid_total",
|
||||
"Total number of queries with a valid cookie.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread(\\d+)\\.num\\.queries_cookie_valid$"),
|
||||
newUnboundMetric(
|
||||
"memory_caches_bytes",
|
||||
"Memory in bytes in use by caches.",
|
||||
prometheus.GaugeValue,
|
||||
[]string{"cache"},
|
||||
"^mem\\.cache\\.(\\w+)$"),
|
||||
newUnboundMetric(
|
||||
"memory_modules_bytes",
|
||||
"Memory in bytes in use by modules.",
|
||||
prometheus.GaugeValue,
|
||||
[]string{"module"},
|
||||
"^mem\\.mod\\.(\\w+)$"),
|
||||
newUnboundMetric(
|
||||
"memory_sbrk_bytes",
|
||||
"Memory in bytes allocated through sbrk.",
|
||||
prometheus.GaugeValue,
|
||||
nil,
|
||||
"^mem\\.total\\.sbrk$"),
|
||||
newUnboundMetric(
|
||||
"prefetches_total",
|
||||
"Total number of cache prefetches performed.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread(\\d+)\\.num\\.prefetch$"),
|
||||
newUnboundMetric(
|
||||
"queries_total",
|
||||
"Total number of queries received.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread(\\d+)\\.num\\.queries$"),
|
||||
newUnboundMetric(
|
||||
"expired_total",
|
||||
"Total number of expired entries served.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread(\\d+)\\.num\\.expired$"),
|
||||
newUnboundMetric(
|
||||
"query_classes_total",
|
||||
"Total number of queries with a given query class.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"class"},
|
||||
"^num\\.query\\.class\\.([\\w]+)$"),
|
||||
newUnboundMetric(
|
||||
"query_flags_total",
|
||||
"Total number of queries that had a given flag set in the header.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"flag"},
|
||||
"^num\\.query\\.flags\\.([\\w]+)$"),
|
||||
newUnboundMetric(
|
||||
"query_ipv6_total",
|
||||
"Total number of queries that were made using IPv6 towards the Unbound server.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.query\\.ipv6$"),
|
||||
newUnboundMetric(
|
||||
"query_opcodes_total",
|
||||
"Total number of queries with a given query opcode.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"opcode"},
|
||||
"^num\\.query\\.opcode\\.([\\w]+)$"),
|
||||
newUnboundMetric(
|
||||
"query_edns_DO_total",
|
||||
"Total number of queries that had an EDNS OPT record with the DO (DNSSEC OK) bit set present.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.query\\.edns\\.DO$"),
|
||||
newUnboundMetric(
|
||||
"query_edns_present_total",
|
||||
"Total number of queries that had an EDNS OPT record present.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.query\\.edns\\.present$"),
|
||||
newUnboundMetric(
|
||||
"query_tcp_total",
|
||||
"Total number of queries that were made using TCP towards the Unbound server, including DoT and DoH queries.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.query\\.tcp$"),
|
||||
newUnboundMetric(
|
||||
"query_tcpout_total",
|
||||
"Total number of queries that the Unbound server made using TCP outgoing towards other servers.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.query\\.tcpout$"),
|
||||
newUnboundMetric(
|
||||
"query_tls_total",
|
||||
"Total number of queries that were made using TCP TLS towards the Unbound server, including DoT and DoH queries.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.query\\.tls$"),
|
||||
newUnboundMetric(
|
||||
"query_tls_resume_total",
|
||||
"Total number of queries that were made using TCP TLS Resume towards the Unbound server.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.query\\.tls\\.resume$"),
|
||||
newUnboundMetric(
|
||||
"query_https_total",
|
||||
"Total number of queries that were made using HTTPS towards the Unbound server.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.query\\.https$"),
|
||||
newUnboundMetric(
|
||||
"query_types_total",
|
||||
"Total number of queries with a given query type.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"type"},
|
||||
"^num\\.query\\.type\\.([\\w]+)$"),
|
||||
newUnboundMetric(
|
||||
"query_udpout_total",
|
||||
"Total number of queries that the Unbound server made using UDP outgoing towardsother servers.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.query\\.udpout$"),
|
||||
newUnboundMetric(
|
||||
"query_aggressive_nsec",
|
||||
"Total number of queries that the Unbound server generated response using Aggressive NSEC.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"rcode"},
|
||||
"^num\\.query\\.aggressive\\.(\\w+)$"),
|
||||
newUnboundMetric(
|
||||
"request_list_current_all",
|
||||
"Current size of the request list, including internally generated queries.",
|
||||
prometheus.GaugeValue,
|
||||
[]string{"thread"},
|
||||
"^thread([0-9]+)\\.requestlist\\.current\\.all$"),
|
||||
newUnboundMetric(
|
||||
"request_list_current_user",
|
||||
"Current size of the request list, only counting the requests from client queries.",
|
||||
prometheus.GaugeValue,
|
||||
[]string{"thread"},
|
||||
"^thread([0-9]+)\\.requestlist\\.current\\.user$"),
|
||||
newUnboundMetric(
|
||||
"request_list_exceeded_total",
|
||||
"Number of queries that were dropped because the request list was full.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread([0-9]+)\\.requestlist\\.exceeded$"),
|
||||
newUnboundMetric(
|
||||
"request_list_overwritten_total",
|
||||
"Total number of requests in the request list that were overwritten by newer entries.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread([0-9]+)\\.requestlist\\.overwritten$"),
|
||||
newUnboundMetric(
|
||||
"recursive_replies_total",
|
||||
"Total number of replies sent to queries that needed recursive processing.",
|
||||
prometheus.CounterValue,
|
||||
[]string{"thread"},
|
||||
"^thread(\\d+)\\.num\\.recursivereplies$"),
|
||||
newUnboundMetric(
|
||||
"rrset_bogus_total",
|
||||
"Total number of rrsets marked bogus by the validator.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^num\\.rrset\\.bogus$"),
|
||||
newUnboundMetric(
|
||||
"rrset_cache_max_collisions_total",
|
||||
"Total number of rrset cache hashtable collisions.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^rrset\\.cache\\.max_collisions$"),
|
||||
newUnboundMetric(
|
||||
"time_elapsed_seconds",
|
||||
"Time since last statistics printout in seconds.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^time\\.elapsed$"),
|
||||
newUnboundMetric(
|
||||
"time_now_seconds",
|
||||
"Current time in seconds since 1970.",
|
||||
prometheus.GaugeValue,
|
||||
nil,
|
||||
"^time\\.now$"),
|
||||
newUnboundMetric(
|
||||
"time_up_seconds_total",
|
||||
"Uptime since server boot in seconds.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^time\\.up$"),
|
||||
newUnboundMetric(
|
||||
"unwanted_queries_total",
|
||||
"Total number of queries that were refused or dropped because they failed the access control settings.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^unwanted\\.queries$"),
|
||||
newUnboundMetric(
|
||||
"unwanted_replies_total",
|
||||
"Total number of replies that were unwanted or unsolicited.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^unwanted\\.replies$"),
|
||||
newUnboundMetric(
|
||||
"recursion_time_seconds_avg",
|
||||
"Average time it took to answer queries that needed recursive processing (does not include in-cache requests).",
|
||||
prometheus.GaugeValue,
|
||||
nil,
|
||||
"^total\\.recursion\\.time\\.avg$"),
|
||||
newUnboundMetric(
|
||||
"recursion_time_seconds_median",
|
||||
"The median of the time it took to answer queries that needed recursive processing.",
|
||||
prometheus.GaugeValue,
|
||||
nil,
|
||||
"^total\\.recursion\\.time\\.median$"),
|
||||
newUnboundMetric(
|
||||
"msg_cache_count",
|
||||
"The Number of Messages cached",
|
||||
prometheus.GaugeValue,
|
||||
nil,
|
||||
"^msg\\.cache\\.count$"),
|
||||
newUnboundMetric(
|
||||
"msg_cache_max_collisions_total",
|
||||
"Total number of msg cache hashtable collisions.",
|
||||
prometheus.CounterValue,
|
||||
nil,
|
||||
"^msg\\.cache\\.max_collisions$"),
|
||||
newUnboundMetric(
|
||||
"rrset_cache_count",
|
||||
"The Number of rrset cached",
|
||||
prometheus.GaugeValue,
|
||||
nil,
|
||||
"^rrset\\.cache\\.count$"),
|
||||
}
|
||||
)
|
||||
|
||||
type unboundMetric struct {
|
||||
desc *prometheus.Desc
|
||||
valueType prometheus.ValueType
|
||||
pattern *regexp.Regexp
|
||||
}
|
||||
|
||||
func newUnboundMetric(name string, description string, valueType prometheus.ValueType, labels []string, pattern string) *unboundMetric {
|
||||
return &unboundMetric{
|
||||
desc: prometheus.NewDesc(
|
||||
prometheus.BuildFQName("unbound", "", name),
|
||||
description,
|
||||
labels,
|
||||
nil),
|
||||
valueType: valueType,
|
||||
pattern: regexp.MustCompile(pattern),
|
||||
}
|
||||
}
|
||||
|
||||
func CollectFromReader(file io.Reader, ch chan<- prometheus.Metric) error {
|
||||
scanner := bufio.NewScanner(file)
|
||||
scanner.Split(bufio.ScanLines)
|
||||
histogramPattern := regexp.MustCompile(`^histogram\.\d+\.\d+\.to\.(\d+\.\d+)$`)
|
||||
|
||||
histogramCount := uint64(0)
|
||||
histogramAvg := float64(0)
|
||||
histogramBuckets := make(map[float64]uint64)
|
||||
|
||||
for scanner.Scan() {
|
||||
fields := strings.Split(scanner.Text(), "=")
|
||||
if len(fields) != 2 {
|
||||
return fmt.Errorf(
|
||||
"%q is not a valid key-value pair",
|
||||
scanner.Text())
|
||||
}
|
||||
|
||||
for _, metric := range unboundMetrics {
|
||||
if matches := metric.pattern.FindStringSubmatch(fields[0]); matches != nil {
|
||||
value, err := strconv.ParseFloat(fields[1], 64)
|
||||
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
metric.desc,
|
||||
metric.valueType,
|
||||
value,
|
||||
matches[1:]...)
|
||||
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if matches := histogramPattern.FindStringSubmatch(fields[0]); matches != nil {
|
||||
end, err := strconv.ParseFloat(matches[1], 64)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
value, err := strconv.ParseUint(fields[1], 10, 64)
|
||||
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
histogramBuckets[end] = value
|
||||
histogramCount += value
|
||||
} else if fields[0] == "total.recursion.time.avg" {
|
||||
value, err := strconv.ParseFloat(fields[1], 64)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
histogramAvg = value
|
||||
}
|
||||
}
|
||||
|
||||
// Convert the metrics to a cumulative Prometheus histogram.
|
||||
// Reconstruct the sum of all samples from the average value
|
||||
// provided by Unbound. Hopefully this does not break
|
||||
// monotonicity.
|
||||
keys := []float64{}
|
||||
for k := range histogramBuckets {
|
||||
keys = append(keys, k)
|
||||
}
|
||||
sort.Float64s(keys)
|
||||
prev := uint64(0)
|
||||
for _, i := range keys {
|
||||
histogramBuckets[i] += prev
|
||||
prev = histogramBuckets[i]
|
||||
}
|
||||
ch <- prometheus.MustNewConstHistogram(
|
||||
unboundHistogram,
|
||||
histogramCount,
|
||||
histogramAvg*float64(histogramCount),
|
||||
histogramBuckets)
|
||||
|
||||
return scanner.Err()
|
||||
}
|
||||
|
||||
func CollectFromSocket(socketFamily string, host string, tlsConfig *tls.Config, ch chan<- prometheus.Metric) error {
|
||||
var (
|
||||
conn net.Conn
|
||||
err error
|
||||
)
|
||||
|
||||
if socketFamily == "unix" || tlsConfig == nil {
|
||||
conn, err = net.Dial(socketFamily, host)
|
||||
} else {
|
||||
conn, err = tls.Dial(socketFamily, host, tlsConfig)
|
||||
}
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer conn.Close()
|
||||
_, err = conn.Write([]byte("UBCT1 stats_noreset\n"))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return CollectFromReader(conn, ch)
|
||||
}
|
||||
|
||||
type UnboundExporter struct {
|
||||
socketFamily string
|
||||
host string
|
||||
tlsConfig *tls.Config
|
||||
}
|
||||
|
||||
func NewUnboundExporter(host string, ca string, cert string, key string) (*UnboundExporter, error) {
|
||||
u, err := url.Parse(host)
|
||||
if err != nil {
|
||||
return &UnboundExporter{}, err
|
||||
}
|
||||
|
||||
if u.Scheme == "unix" {
|
||||
return &UnboundExporter{
|
||||
socketFamily: u.Scheme,
|
||||
host: u.Path,
|
||||
}, nil
|
||||
}
|
||||
|
||||
if ca == "" && cert == "" {
|
||||
return &UnboundExporter{
|
||||
socketFamily: u.Scheme,
|
||||
host: u.Host,
|
||||
}, nil
|
||||
}
|
||||
|
||||
/* Server authentication. */
|
||||
caData, err := os.ReadFile(ca)
|
||||
if err != nil {
|
||||
return &UnboundExporter{}, err
|
||||
}
|
||||
roots := x509.NewCertPool()
|
||||
if !roots.AppendCertsFromPEM(caData) {
|
||||
return &UnboundExporter{}, fmt.Errorf("Failed to parse CA")
|
||||
}
|
||||
|
||||
/* Client authentication. */
|
||||
certData, err := os.ReadFile(cert)
|
||||
if err != nil {
|
||||
return &UnboundExporter{}, err
|
||||
}
|
||||
keyData, err := os.ReadFile(key)
|
||||
if err != nil {
|
||||
return &UnboundExporter{}, err
|
||||
}
|
||||
keyPair, err := tls.X509KeyPair(certData, keyData)
|
||||
if err != nil {
|
||||
return &UnboundExporter{}, err
|
||||
}
|
||||
|
||||
return &UnboundExporter{
|
||||
socketFamily: u.Scheme,
|
||||
host: u.Host,
|
||||
tlsConfig: &tls.Config{
|
||||
Certificates: []tls.Certificate{keyPair},
|
||||
RootCAs: roots,
|
||||
ServerName: "unbound",
|
||||
},
|
||||
}, nil
|
||||
}
|
||||
|
||||
func (e *UnboundExporter) Describe(ch chan<- *prometheus.Desc) {
|
||||
ch <- unboundUpDesc
|
||||
for _, metric := range unboundMetrics {
|
||||
ch <- metric.desc
|
||||
}
|
||||
}
|
||||
|
||||
func (e *UnboundExporter) Collect(ch chan<- prometheus.Metric) {
|
||||
err := CollectFromSocket(e.socketFamily, e.host, e.tlsConfig, ch)
|
||||
if err == nil {
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
unboundUpDesc,
|
||||
prometheus.GaugeValue,
|
||||
1.0)
|
||||
} else {
|
||||
_ = level.Error(log).Log("Failed to scrape socket: ", err)
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
unboundUpDesc,
|
||||
prometheus.GaugeValue,
|
||||
0.0)
|
||||
}
|
||||
}
|
||||
|
||||
func main() {
|
||||
var (
|
||||
listenAddress = flag.String("web.listen-address", ":9167", "Address to listen on for web interface and telemetry.")
|
||||
|
|
@ -537,7 +42,7 @@ func main() {
|
|||
flag.Parse()
|
||||
|
||||
_ = level.Info(log).Log("Starting unbound_exporter")
|
||||
exporter, err := NewUnboundExporter(*unboundHost, *unboundCa, *unboundCert, *unboundKey)
|
||||
exporter, err := exporter.NewUnboundExporter(log, *unboundHost, *unboundCa, *unboundCert, *unboundKey)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue