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.
70 lines
2.2 KiB
Go
70 lines
2.2 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
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"time"
|
|
|
|
happydns "git.happydns.org/checker-sdk-go/checker"
|
|
)
|
|
|
|
// Provider returns a new ping observation provider for local execution.
|
|
func Provider() happydns.ObservationProvider {
|
|
return &pingProvider{}
|
|
}
|
|
|
|
// ProviderWithPrivileged returns a provider with privileged ICMP mode enabled.
|
|
func ProviderWithPrivileged(privileged bool) happydns.ObservationProvider {
|
|
return &pingProvider{Privileged: privileged}
|
|
}
|
|
|
|
type pingProvider struct {
|
|
// Privileged controls whether raw ICMP sockets are used (requires CAP_NET_RAW or root).
|
|
Privileged bool
|
|
}
|
|
|
|
func (p *pingProvider) Key() happydns.ObservationKey {
|
|
return ObservationKeyPing
|
|
}
|
|
|
|
// ExtractMetrics implements happydns.CheckerMetricsReporter.
|
|
func (p *pingProvider) ExtractMetrics(ctx happydns.ReportContext, collectedAt time.Time) ([]happydns.CheckMetric, error) {
|
|
var data PingData
|
|
if err := json.Unmarshal(ctx.Data(), &data); err != nil {
|
|
return nil, fmt.Errorf("decode ping data: %w", err)
|
|
}
|
|
|
|
metrics := Metrics(&data, collectedAt)
|
|
result := make([]happydns.CheckMetric, len(metrics))
|
|
for i, m := range metrics {
|
|
result[i] = happydns.CheckMetric{
|
|
Name: m.Name,
|
|
Value: m.Value,
|
|
Unit: m.Unit,
|
|
Labels: m.Labels,
|
|
Timestamp: m.Timestamp,
|
|
}
|
|
}
|
|
return result, nil
|
|
}
|