happyDomain/checker-ping
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Address publication review feedback

Browse source 
Add the AGPL LICENSE file and a deployment-security note in the README
to clarify that the unauthenticated /collect endpoint must run on a
trusted network.

Fix the IPv6 reachability rule so it consults the IP actually probed:
PingTargetResult now carries ResolvedIP populated from pinger.IPAddr(),
which lets the rule classify hostname targets correctly instead of
always reporting "No IPv6 target pinged".

Tighten error handling: ipsFromService now propagates JSON errors,
ExtractMetrics wraps decode failures, the count option returns an
explicit error when out of range instead of silently clamping, and the
"all pings failed" message no longer concatenates every per-target
error. Threshold validation is factored into validateThresholdPair and
shared between the RTT and packet-loss rules.

Add unit tests covering address resolution, threshold validation, and
each rule's evaluation paths.
This commit is contained in:
nemunaire 2026-04-26 10:40:32 +07:00
commit 34b70969c8
16 changed files with 1270 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

27
checker/collect.go
View file

@ -26,7 +26,6 @@ import (
"encoding/json"
"fmt"
"net"
"strings"
"time"
probing "github.com/prometheus-community/pro-bing"
@ -45,12 +44,10 @@ func (p *pingProvider) Collect(ctx context.Context, opts sdk.CheckerOptions) (an
return nil, err
}
const minCount, maxCount = 1, 20
count := sdk.GetIntOption(opts, "count", 5)
if count < 1 {
count = 1
}
if count > 20 {
count = 20
if count < minCount || count > maxCount {
return nil, fmt.Errorf("count must be between %d and %d, got %d", minCount, maxCount, count)
}
data := &PingData{}
@ -76,8 +73,13 @@ func (p *pingProvider) Collect(ctx context.Context, opts sdk.CheckerOptions) (an
}
stats := pinger.Statistics()
var resolved string
if ip := pinger.IPAddr(); ip != nil {
resolved = ip.IP.String()
}
data.Targets = append(data.Targets, PingTargetResult{
Address: addr,
ResolvedIP: resolved,
RTTMin: float64(stats.MinRtt.Microseconds()) / 1000.0,
RTTAvg: float64(stats.AvgRtt.Microseconds()) / 1000.0,
RTTMax: float64(stats.MaxRtt.Microseconds()) / 1000.0,
@ -88,7 +90,7 @@ func (p *pingProvider) Collect(ctx context.Context, opts sdk.CheckerOptions) (an
}
if len(data.Targets) == 0 {
return nil, fmt.Errorf("all pings failed: %s", strings.Join(errs, "; "))
return nil, fmt.Errorf("all %d ping(s) failed; first error: %s", len(errs), errs[0])
}
return data, nil
@ -128,7 +130,10 @@ func resolveAddresses(opts sdk.CheckerOptions) ([]string, error) {
if svc.Type != "abstract.Server" {
return nil, fmt.Errorf("service is %s, expected abstract.Server", svc.Type)
}
ips := ipsFromService(&svc)
ips, err := ipsFromService(&svc)
if err != nil {
return nil, fmt.Errorf("decode service payload: %w", err)
}
if len(ips) > 0 {
addrs := make([]string, len(ips))
for i, ip := range ips {
@ -142,10 +147,10 @@ func resolveAddresses(opts sdk.CheckerOptions) ([]string, error) {
return nil, fmt.Errorf("no addresses provided: set 'addresses', 'address', or 'service' in options")
}
func ipsFromService(svc *happydns.ServiceMessage) []net.IP {
func ipsFromService(svc *happydns.ServiceMessage) ([]net.IP, error) {
var server abstract.Server
if err := json.Unmarshal(svc.Service, &server); err != nil {
return nil
return nil, err
}
var ips []net.IP
@ -155,5 +160,5 @@ func ipsFromService(svc *happydns.ServiceMessage) []net.IP {
if server.AAAA != nil && len(server.AAAA.AAAA) > 0 {
ips = append(ips, server.AAAA.AAAA)
}
return ips
return ips, nil
}