Pierre-Olivier Mercier
2aa596afd5
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.
47 lines
1.8 KiB
Go
47 lines
1.8 KiB
Go
// This file is part of the happyDomain (R) project.
|
|
// Copyright (c) 2020-2026 happyDomain
|
|
// Authors: Pierre-Olivier Mercier, et al.
|
|
//
|
|
// This program is offered under a commercial and under the AGPL license.
|
|
// For commercial licensing, contact us at <contact@happydomain.org>.
|
|
//
|
|
// For AGPL licensing:
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
package checker
|
|
|
|
// ObservationKeyPing is the observation key for ICMP ping data.
|
|
const ObservationKeyPing = "ping"
|
|
|
|
// PingData holds the collected ping results for all targets.
|
|
type PingData struct {
|
|
Targets []PingTargetResult `json:"targets"`
|
|
}
|
|
|
|
// PingTargetResult contains the ping statistics for a single target.
|
|
//
|
|
// Address is the user-supplied label (hostname or IP). ResolvedIP is the
|
|
// IP that was actually probed; rules that need to reason about address
|
|
// family (e.g. IPv6 reachability) must consult ResolvedIP because Address
|
|
// can be a hostname.
|
|
type PingTargetResult struct {
|
|
Address string `json:"address"`
|
|
ResolvedIP string `json:"resolved_ip,omitempty"`
|
|
RTTMin float64 `json:"rtt_min"`
|
|
RTTAvg float64 `json:"rtt_avg"`
|
|
RTTMax float64 `json:"rtt_max"`
|
|
PacketLoss float64 `json:"packet_loss"`
|
|
Sent int `json:"sent"`
|
|
Received int `json:"received"`
|
|
}
|