Compare commits
No commits in common. "master" and "v0.1.0" have entirely different histories.
27 changed files with 231 additions and 1886 deletions
|
|
@ -1,22 +0,0 @@
|
||||||
image: happydomain/checker-ping:{{#if build.tag}}{{trimPrefix "v" build.tag}}{{else}}latest{{/if}}
|
|
||||||
{{#if build.tags}}
|
|
||||||
tags:
|
|
||||||
{{#each build.tags}}
|
|
||||||
- {{this}}
|
|
||||||
{{/each}}
|
|
||||||
{{/if}}
|
|
||||||
manifests:
|
|
||||||
- image: happydomain/checker-ping:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}linux-amd64
|
|
||||||
platform:
|
|
||||||
architecture: amd64
|
|
||||||
os: linux
|
|
||||||
- image: happydomain/checker-ping:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}linux-arm64
|
|
||||||
platform:
|
|
||||||
architecture: arm64
|
|
||||||
os: linux
|
|
||||||
variant: v8
|
|
||||||
- image: happydomain/checker-ping:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}linux-arm
|
|
||||||
platform:
|
|
||||||
architecture: arm
|
|
||||||
os: linux
|
|
||||||
variant: v7
|
|
||||||
187
.drone.yml
187
.drone.yml
|
|
@ -1,187 +0,0 @@
|
||||||
---
|
|
||||||
kind: pipeline
|
|
||||||
type: docker
|
|
||||||
name: build-amd64
|
|
||||||
|
|
||||||
platform:
|
|
||||||
os: linux
|
|
||||||
arch: amd64
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: checker build
|
|
||||||
image: golang:1-alpine
|
|
||||||
commands:
|
|
||||||
- apk add --no-cache git make
|
|
||||||
- make
|
|
||||||
environment:
|
|
||||||
CHECKER_VERSION: "${DRONE_BRANCH}-${DRONE_COMMIT}"
|
|
||||||
CGO_ENABLED: 0
|
|
||||||
when:
|
|
||||||
event:
|
|
||||||
exclude:
|
|
||||||
- tag
|
|
||||||
|
|
||||||
- name: checker build tag
|
|
||||||
image: golang:1-alpine
|
|
||||||
commands:
|
|
||||||
- apk add --no-cache git make
|
|
||||||
- make
|
|
||||||
environment:
|
|
||||||
CHECKER_VERSION: "${DRONE_SEMVER}"
|
|
||||||
CGO_ENABLED: 0
|
|
||||||
when:
|
|
||||||
event:
|
|
||||||
- tag
|
|
||||||
|
|
||||||
- name: publish on Docker Hub
|
|
||||||
image: plugins/docker
|
|
||||||
settings:
|
|
||||||
repo: happydomain/checker-ping
|
|
||||||
auto_tag: true
|
|
||||||
auto_tag_suffix: ${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}
|
|
||||||
dockerfile: Dockerfile
|
|
||||||
build_args:
|
|
||||||
- CHECKER_VERSION=${DRONE_BRANCH}-${DRONE_COMMIT}
|
|
||||||
username:
|
|
||||||
from_secret: docker_username
|
|
||||||
password:
|
|
||||||
from_secret: docker_password
|
|
||||||
when:
|
|
||||||
event:
|
|
||||||
exclude:
|
|
||||||
- tag
|
|
||||||
|
|
||||||
- name: publish on Docker Hub (tag)
|
|
||||||
image: plugins/docker
|
|
||||||
settings:
|
|
||||||
repo: happydomain/checker-ping
|
|
||||||
auto_tag: true
|
|
||||||
auto_tag_suffix: ${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}
|
|
||||||
dockerfile: Dockerfile
|
|
||||||
build_args:
|
|
||||||
- CHECKER_VERSION=${DRONE_SEMVER}
|
|
||||||
username:
|
|
||||||
from_secret: docker_username
|
|
||||||
password:
|
|
||||||
from_secret: docker_password
|
|
||||||
when:
|
|
||||||
event:
|
|
||||||
- tag
|
|
||||||
|
|
||||||
trigger:
|
|
||||||
branch:
|
|
||||||
exclude:
|
|
||||||
- renovate/*
|
|
||||||
event:
|
|
||||||
- cron
|
|
||||||
- push
|
|
||||||
- tag
|
|
||||||
|
|
||||||
---
|
|
||||||
kind: pipeline
|
|
||||||
type: docker
|
|
||||||
name: build-arm64
|
|
||||||
|
|
||||||
platform:
|
|
||||||
os: linux
|
|
||||||
arch: arm64
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: checker build
|
|
||||||
image: golang:1-alpine
|
|
||||||
commands:
|
|
||||||
- apk add --no-cache git make
|
|
||||||
- make
|
|
||||||
environment:
|
|
||||||
CHECKER_VERSION: "${DRONE_BRANCH}-${DRONE_COMMIT}"
|
|
||||||
CGO_ENABLED: 0
|
|
||||||
when:
|
|
||||||
event:
|
|
||||||
exclude:
|
|
||||||
- tag
|
|
||||||
|
|
||||||
- name: checker build tag
|
|
||||||
image: golang:1-alpine
|
|
||||||
commands:
|
|
||||||
- apk add --no-cache git make
|
|
||||||
- make
|
|
||||||
environment:
|
|
||||||
CHECKER_VERSION: "${DRONE_SEMVER}"
|
|
||||||
CGO_ENABLED: 0
|
|
||||||
when:
|
|
||||||
event:
|
|
||||||
- tag
|
|
||||||
|
|
||||||
- name: publish on Docker Hub
|
|
||||||
image: plugins/docker
|
|
||||||
settings:
|
|
||||||
repo: happydomain/checker-ping
|
|
||||||
auto_tag: true
|
|
||||||
auto_tag_suffix: ${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}
|
|
||||||
dockerfile: Dockerfile
|
|
||||||
build_args:
|
|
||||||
- CHECKER_VERSION=${DRONE_BRANCH}-${DRONE_COMMIT}
|
|
||||||
username:
|
|
||||||
from_secret: docker_username
|
|
||||||
password:
|
|
||||||
from_secret: docker_password
|
|
||||||
when:
|
|
||||||
event:
|
|
||||||
exclude:
|
|
||||||
- tag
|
|
||||||
|
|
||||||
- name: publish on Docker Hub (tag)
|
|
||||||
image: plugins/docker
|
|
||||||
settings:
|
|
||||||
repo: happydomain/checker-ping
|
|
||||||
auto_tag: true
|
|
||||||
auto_tag_suffix: ${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}
|
|
||||||
dockerfile: Dockerfile
|
|
||||||
build_args:
|
|
||||||
- CHECKER_VERSION=${DRONE_SEMVER}
|
|
||||||
username:
|
|
||||||
from_secret: docker_username
|
|
||||||
password:
|
|
||||||
from_secret: docker_password
|
|
||||||
when:
|
|
||||||
event:
|
|
||||||
- tag
|
|
||||||
|
|
||||||
trigger:
|
|
||||||
event:
|
|
||||||
- cron
|
|
||||||
- push
|
|
||||||
- tag
|
|
||||||
|
|
||||||
---
|
|
||||||
kind: pipeline
|
|
||||||
name: docker-manifest
|
|
||||||
|
|
||||||
platform:
|
|
||||||
os: linux
|
|
||||||
arch: arm64
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: publish on Docker Hub
|
|
||||||
image: plugins/manifest
|
|
||||||
settings:
|
|
||||||
auto_tag: true
|
|
||||||
ignore_missing: true
|
|
||||||
spec: .drone-manifest.yml
|
|
||||||
username:
|
|
||||||
from_secret: docker_username
|
|
||||||
password:
|
|
||||||
from_secret: docker_password
|
|
||||||
|
|
||||||
trigger:
|
|
||||||
branch:
|
|
||||||
exclude:
|
|
||||||
- renovate/*
|
|
||||||
event:
|
|
||||||
- cron
|
|
||||||
- push
|
|
||||||
- tag
|
|
||||||
|
|
||||||
depends_on:
|
|
||||||
- build-amd64
|
|
||||||
- build-arm64
|
|
||||||
|
|
@ -6,12 +6,9 @@ WORKDIR /src
|
||||||
COPY go.mod go.sum ./
|
COPY go.mod go.sum ./
|
||||||
RUN go mod download
|
RUN go mod download
|
||||||
COPY . .
|
COPY . .
|
||||||
RUN CGO_ENABLED=0 go build -tags standalone -ldflags "-X main.Version=${CHECKER_VERSION}" -o /checker-ping .
|
RUN CGO_ENABLED=0 go build -ldflags "-X main.Version=${CHECKER_VERSION}" -o /checker-ping .
|
||||||
|
|
||||||
FROM scratch
|
FROM scratch
|
||||||
COPY --from=builder /checker-ping /checker-ping
|
COPY --from=builder /checker-ping /checker-ping
|
||||||
USER 65534:65534
|
|
||||||
EXPOSE 8080
|
EXPOSE 8080
|
||||||
HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \
|
|
||||||
CMD ["/checker-ping", "-healthcheck"]
|
|
||||||
ENTRYPOINT ["/checker-ping"]
|
ENTRYPOINT ["/checker-ping"]
|
||||||
|
|
|
||||||
682
LICENSE
682
LICENSE
|
|
@ -1,682 +0,0 @@
|
||||||
happyDomain Licensing
|
|
||||||
|
|
||||||
SOFTWARE LICENSING
|
|
||||||
|
|
||||||
You may be licensed to use source code to create compiled versions not produced
|
|
||||||
by the happyDNS team in one of two ways:
|
|
||||||
|
|
||||||
1. Under the AGPL v3, subject to the exceptions outlined in this policy;
|
|
||||||
2. Under a commercial license available from the happyDNS team by contacting
|
|
||||||
contact@happydns.org.
|
|
||||||
|
|
||||||
happyDNS and happyDomain TRADEMARK GUIDELINES
|
|
||||||
|
|
||||||
Your use of the mark happyDNS and happyDomain is subject to the happyDNS team's
|
|
||||||
prior written approval and our organization’s Trademark Standards of Use at
|
|
||||||
http://www.happydomain.org/trademark-standards-of-use/. For trademark approval
|
|
||||||
or any questions you have about using these trademarks, please email
|
|
||||||
contact@happydns.org
|
|
||||||
|
|
||||||
------------------------------------------------------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
|
||||||
Version 3, 19 November 2007
|
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
|
||||||
of this license document, but changing it is not allowed.
|
|
||||||
|
|
||||||
Preamble
|
|
||||||
|
|
||||||
The GNU Affero General Public License is a free, copyleft license for
|
|
||||||
software and other kinds of works, specifically designed to ensure
|
|
||||||
cooperation with the community in the case of network server software.
|
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed
|
|
||||||
to take away your freedom to share and change the works. By contrast,
|
|
||||||
our General Public Licenses are intended to guarantee your freedom to
|
|
||||||
share and change all versions of a program--to make sure it remains free
|
|
||||||
software for all its users.
|
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not
|
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
|
||||||
have the freedom to distribute copies of free software (and charge for
|
|
||||||
them if you wish), that you receive source code or can get it if you
|
|
||||||
want it, that you can change the software or use pieces of it in new
|
|
||||||
free programs, and that you know you can do these things.
|
|
||||||
|
|
||||||
Developers that use our General Public Licenses protect your rights
|
|
||||||
with two steps: (1) assert copyright on the software, and (2) offer
|
|
||||||
you this License which gives you legal permission to copy, distribute
|
|
||||||
and/or modify the software.
|
|
||||||
|
|
||||||
A secondary benefit of defending all users' freedom is that
|
|
||||||
improvements made in alternate versions of the program, if they
|
|
||||||
receive widespread use, become available for other developers to
|
|
||||||
incorporate. Many developers of free software are heartened and
|
|
||||||
encouraged by the resulting cooperation. However, in the case of
|
|
||||||
software used on network servers, this result may fail to come about.
|
|
||||||
The GNU General Public License permits making a modified version and
|
|
||||||
letting the public access it on a server without ever releasing its
|
|
||||||
source code to the public.
|
|
||||||
|
|
||||||
The GNU Affero General Public License is designed specifically to
|
|
||||||
ensure that, in such cases, the modified source code becomes available
|
|
||||||
to the community. It requires the operator of a network server to
|
|
||||||
provide the source code of the modified version running there to the
|
|
||||||
users of that server. Therefore, public use of a modified version, on
|
|
||||||
a publicly accessible server, gives the public access to the source
|
|
||||||
code of the modified version.
|
|
||||||
|
|
||||||
An older license, called the Affero General Public License and
|
|
||||||
published by Affero, was designed to accomplish similar goals. This is
|
|
||||||
a different license, not a version of the Affero GPL, but Affero has
|
|
||||||
released a new version of the Affero GPL which permits relicensing under
|
|
||||||
this license.
|
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and
|
|
||||||
modification follow.
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
0. Definitions.
|
|
||||||
|
|
||||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
|
||||||
|
|
||||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
|
||||||
works, such as semiconductor masks.
|
|
||||||
|
|
||||||
"The Program" refers to any copyrightable work licensed under this
|
|
||||||
License. Each licensee is addressed as "you". "Licensees" and
|
|
||||||
"recipients" may be individuals or organizations.
|
|
||||||
|
|
||||||
To "modify" a work means to copy from or adapt all or part of the work
|
|
||||||
in a fashion requiring copyright permission, other than the making of an
|
|
||||||
exact copy. The resulting work is called a "modified version" of the
|
|
||||||
earlier work or a work "based on" the earlier work.
|
|
||||||
|
|
||||||
A "covered work" means either the unmodified Program or a work based
|
|
||||||
on the Program.
|
|
||||||
|
|
||||||
To "propagate" a work means to do anything with it that, without
|
|
||||||
permission, would make you directly or secondarily liable for
|
|
||||||
infringement under applicable copyright law, except executing it on a
|
|
||||||
computer or modifying a private copy. Propagation includes copying,
|
|
||||||
distribution (with or without modification), making available to the
|
|
||||||
public, and in some countries other activities as well.
|
|
||||||
|
|
||||||
To "convey" a work means any kind of propagation that enables other
|
|
||||||
parties to make or receive copies. Mere interaction with a user through
|
|
||||||
a computer network, with no transfer of a copy, is not conveying.
|
|
||||||
|
|
||||||
An interactive user interface displays "Appropriate Legal Notices"
|
|
||||||
to the extent that it includes a convenient and prominently visible
|
|
||||||
feature that (1) displays an appropriate copyright notice, and (2)
|
|
||||||
tells the user that there is no warranty for the work (except to the
|
|
||||||
extent that warranties are provided), that licensees may convey the
|
|
||||||
work under this License, and how to view a copy of this License. If
|
|
||||||
the interface presents a list of user commands or options, such as a
|
|
||||||
menu, a prominent item in the list meets this criterion.
|
|
||||||
|
|
||||||
1. Source Code.
|
|
||||||
|
|
||||||
The "source code" for a work means the preferred form of the work
|
|
||||||
for making modifications to it. "Object code" means any non-source
|
|
||||||
form of a work.
|
|
||||||
|
|
||||||
A "Standard Interface" means an interface that either is an official
|
|
||||||
standard defined by a recognized standards body, or, in the case of
|
|
||||||
interfaces specified for a particular programming language, one that
|
|
||||||
is widely used among developers working in that language.
|
|
||||||
|
|
||||||
The "System Libraries" of an executable work include anything, other
|
|
||||||
than the work as a whole, that (a) is included in the normal form of
|
|
||||||
packaging a Major Component, but which is not part of that Major
|
|
||||||
Component, and (b) serves only to enable use of the work with that
|
|
||||||
Major Component, or to implement a Standard Interface for which an
|
|
||||||
implementation is available to the public in source code form. A
|
|
||||||
"Major Component", in this context, means a major essential component
|
|
||||||
(kernel, window system, and so on) of the specific operating system
|
|
||||||
(if any) on which the executable work runs, or a compiler used to
|
|
||||||
produce the work, or an object code interpreter used to run it.
|
|
||||||
|
|
||||||
The "Corresponding Source" for a work in object code form means all
|
|
||||||
the source code needed to generate, install, and (for an executable
|
|
||||||
work) run the object code and to modify the work, including scripts to
|
|
||||||
control those activities. However, it does not include the work's
|
|
||||||
System Libraries, or general-purpose tools or generally available free
|
|
||||||
programs which are used unmodified in performing those activities but
|
|
||||||
which are not part of the work. For example, Corresponding Source
|
|
||||||
includes interface definition files associated with source files for
|
|
||||||
the work, and the source code for shared libraries and dynamically
|
|
||||||
linked subprograms that the work is specifically designed to require,
|
|
||||||
such as by intimate data communication or control flow between those
|
|
||||||
subprograms and other parts of the work.
|
|
||||||
|
|
||||||
The Corresponding Source need not include anything that users
|
|
||||||
can regenerate automatically from other parts of the Corresponding
|
|
||||||
Source.
|
|
||||||
|
|
||||||
The Corresponding Source for a work in source code form is that
|
|
||||||
same work.
|
|
||||||
|
|
||||||
2. Basic Permissions.
|
|
||||||
|
|
||||||
All rights granted under this License are granted for the term of
|
|
||||||
copyright on the Program, and are irrevocable provided the stated
|
|
||||||
conditions are met. This License explicitly affirms your unlimited
|
|
||||||
permission to run the unmodified Program. The output from running a
|
|
||||||
covered work is covered by this License only if the output, given its
|
|
||||||
content, constitutes a covered work. This License acknowledges your
|
|
||||||
rights of fair use or other equivalent, as provided by copyright law.
|
|
||||||
|
|
||||||
You may make, run and propagate covered works that you do not
|
|
||||||
convey, without conditions so long as your license otherwise remains
|
|
||||||
in force. You may convey covered works to others for the sole purpose
|
|
||||||
of having them make modifications exclusively for you, or provide you
|
|
||||||
with facilities for running those works, provided that you comply with
|
|
||||||
the terms of this License in conveying all material for which you do
|
|
||||||
not control copyright. Those thus making or running the covered works
|
|
||||||
for you must do so exclusively on your behalf, under your direction
|
|
||||||
and control, on terms that prohibit them from making any copies of
|
|
||||||
your copyrighted material outside their relationship with you.
|
|
||||||
|
|
||||||
Conveying under any other circumstances is permitted solely under
|
|
||||||
the conditions stated below. Sublicensing is not allowed; section 10
|
|
||||||
makes it unnecessary.
|
|
||||||
|
|
||||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
|
||||||
|
|
||||||
No covered work shall be deemed part of an effective technological
|
|
||||||
measure under any applicable law fulfilling obligations under article
|
|
||||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
|
||||||
similar laws prohibiting or restricting circumvention of such
|
|
||||||
measures.
|
|
||||||
|
|
||||||
When you convey a covered work, you waive any legal power to forbid
|
|
||||||
circumvention of technological measures to the extent such circumvention
|
|
||||||
is effected by exercising rights under this License with respect to
|
|
||||||
the covered work, and you disclaim any intention to limit operation or
|
|
||||||
modification of the work as a means of enforcing, against the work's
|
|
||||||
users, your or third parties' legal rights to forbid circumvention of
|
|
||||||
technological measures.
|
|
||||||
|
|
||||||
4. Conveying Verbatim Copies.
|
|
||||||
|
|
||||||
You may convey verbatim copies of the Program's source code as you
|
|
||||||
receive it, in any medium, provided that you conspicuously and
|
|
||||||
appropriately publish on each copy an appropriate copyright notice;
|
|
||||||
keep intact all notices stating that this License and any
|
|
||||||
non-permissive terms added in accord with section 7 apply to the code;
|
|
||||||
keep intact all notices of the absence of any warranty; and give all
|
|
||||||
recipients a copy of this License along with the Program.
|
|
||||||
|
|
||||||
You may charge any price or no price for each copy that you convey,
|
|
||||||
and you may offer support or warranty protection for a fee.
|
|
||||||
|
|
||||||
5. Conveying Modified Source Versions.
|
|
||||||
|
|
||||||
You may convey a work based on the Program, or the modifications to
|
|
||||||
produce it from the Program, in the form of source code under the
|
|
||||||
terms of section 4, provided that you also meet all of these conditions:
|
|
||||||
|
|
||||||
a) The work must carry prominent notices stating that you modified
|
|
||||||
it, and giving a relevant date.
|
|
||||||
|
|
||||||
b) The work must carry prominent notices stating that it is
|
|
||||||
released under this License and any conditions added under section
|
|
||||||
7. This requirement modifies the requirement in section 4 to
|
|
||||||
"keep intact all notices".
|
|
||||||
|
|
||||||
c) You must license the entire work, as a whole, under this
|
|
||||||
License to anyone who comes into possession of a copy. This
|
|
||||||
License will therefore apply, along with any applicable section 7
|
|
||||||
additional terms, to the whole of the work, and all its parts,
|
|
||||||
regardless of how they are packaged. This License gives no
|
|
||||||
permission to license the work in any other way, but it does not
|
|
||||||
invalidate such permission if you have separately received it.
|
|
||||||
|
|
||||||
d) If the work has interactive user interfaces, each must display
|
|
||||||
Appropriate Legal Notices; however, if the Program has interactive
|
|
||||||
interfaces that do not display Appropriate Legal Notices, your
|
|
||||||
work need not make them do so.
|
|
||||||
|
|
||||||
A compilation of a covered work with other separate and independent
|
|
||||||
works, which are not by their nature extensions of the covered work,
|
|
||||||
and which are not combined with it such as to form a larger program,
|
|
||||||
in or on a volume of a storage or distribution medium, is called an
|
|
||||||
"aggregate" if the compilation and its resulting copyright are not
|
|
||||||
used to limit the access or legal rights of the compilation's users
|
|
||||||
beyond what the individual works permit. Inclusion of a covered work
|
|
||||||
in an aggregate does not cause this License to apply to the other
|
|
||||||
parts of the aggregate.
|
|
||||||
|
|
||||||
6. Conveying Non-Source Forms.
|
|
||||||
|
|
||||||
You may convey a covered work in object code form under the terms
|
|
||||||
of sections 4 and 5, provided that you also convey the
|
|
||||||
machine-readable Corresponding Source under the terms of this License,
|
|
||||||
in one of these ways:
|
|
||||||
|
|
||||||
a) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by the
|
|
||||||
Corresponding Source fixed on a durable physical medium
|
|
||||||
customarily used for software interchange.
|
|
||||||
|
|
||||||
b) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by a
|
|
||||||
written offer, valid for at least three years and valid for as
|
|
||||||
long as you offer spare parts or customer support for that product
|
|
||||||
model, to give anyone who possesses the object code either (1) a
|
|
||||||
copy of the Corresponding Source for all the software in the
|
|
||||||
product that is covered by this License, on a durable physical
|
|
||||||
medium customarily used for software interchange, for a price no
|
|
||||||
more than your reasonable cost of physically performing this
|
|
||||||
conveying of source, or (2) access to copy the
|
|
||||||
Corresponding Source from a network server at no charge.
|
|
||||||
|
|
||||||
c) Convey individual copies of the object code with a copy of the
|
|
||||||
written offer to provide the Corresponding Source. This
|
|
||||||
alternative is allowed only occasionally and noncommercially, and
|
|
||||||
only if you received the object code with such an offer, in accord
|
|
||||||
with subsection 6b.
|
|
||||||
|
|
||||||
d) Convey the object code by offering access from a designated
|
|
||||||
place (gratis or for a charge), and offer equivalent access to the
|
|
||||||
Corresponding Source in the same way through the same place at no
|
|
||||||
further charge. You need not require recipients to copy the
|
|
||||||
Corresponding Source along with the object code. If the place to
|
|
||||||
copy the object code is a network server, the Corresponding Source
|
|
||||||
may be on a different server (operated by you or a third party)
|
|
||||||
that supports equivalent copying facilities, provided you maintain
|
|
||||||
clear directions next to the object code saying where to find the
|
|
||||||
Corresponding Source. Regardless of what server hosts the
|
|
||||||
Corresponding Source, you remain obligated to ensure that it is
|
|
||||||
available for as long as needed to satisfy these requirements.
|
|
||||||
|
|
||||||
e) Convey the object code using peer-to-peer transmission, provided
|
|
||||||
you inform other peers where the object code and Corresponding
|
|
||||||
Source of the work are being offered to the general public at no
|
|
||||||
charge under subsection 6d.
|
|
||||||
|
|
||||||
A separable portion of the object code, whose source code is excluded
|
|
||||||
from the Corresponding Source as a System Library, need not be
|
|
||||||
included in conveying the object code work.
|
|
||||||
|
|
||||||
A "User Product" is either (1) a "consumer product", which means any
|
|
||||||
tangible personal property which is normally used for personal, family,
|
|
||||||
or household purposes, or (2) anything designed or sold for incorporation
|
|
||||||
into a dwelling. In determining whether a product is a consumer product,
|
|
||||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
|
||||||
product received by a particular user, "normally used" refers to a
|
|
||||||
typical or common use of that class of product, regardless of the status
|
|
||||||
of the particular user or of the way in which the particular user
|
|
||||||
actually uses, or expects or is expected to use, the product. A product
|
|
||||||
is a consumer product regardless of whether the product has substantial
|
|
||||||
commercial, industrial or non-consumer uses, unless such uses represent
|
|
||||||
the only significant mode of use of the product.
|
|
||||||
|
|
||||||
"Installation Information" for a User Product means any methods,
|
|
||||||
procedures, authorization keys, or other information required to install
|
|
||||||
and execute modified versions of a covered work in that User Product from
|
|
||||||
a modified version of its Corresponding Source. The information must
|
|
||||||
suffice to ensure that the continued functioning of the modified object
|
|
||||||
code is in no case prevented or interfered with solely because
|
|
||||||
modification has been made.
|
|
||||||
|
|
||||||
If you convey an object code work under this section in, or with, or
|
|
||||||
specifically for use in, a User Product, and the conveying occurs as
|
|
||||||
part of a transaction in which the right of possession and use of the
|
|
||||||
User Product is transferred to the recipient in perpetuity or for a
|
|
||||||
fixed term (regardless of how the transaction is characterized), the
|
|
||||||
Corresponding Source conveyed under this section must be accompanied
|
|
||||||
by the Installation Information. But this requirement does not apply
|
|
||||||
if neither you nor any third party retains the ability to install
|
|
||||||
modified object code on the User Product (for example, the work has
|
|
||||||
been installed in ROM).
|
|
||||||
|
|
||||||
The requirement to provide Installation Information does not include a
|
|
||||||
requirement to continue to provide support service, warranty, or updates
|
|
||||||
for a work that has been modified or installed by the recipient, or for
|
|
||||||
the User Product in which it has been modified or installed. Access to a
|
|
||||||
network may be denied when the modification itself materially and
|
|
||||||
adversely affects the operation of the network or violates the rules and
|
|
||||||
protocols for communication across the network.
|
|
||||||
|
|
||||||
Corresponding Source conveyed, and Installation Information provided,
|
|
||||||
in accord with this section must be in a format that is publicly
|
|
||||||
documented (and with an implementation available to the public in
|
|
||||||
source code form), and must require no special password or key for
|
|
||||||
unpacking, reading or copying.
|
|
||||||
|
|
||||||
7. Additional Terms.
|
|
||||||
|
|
||||||
"Additional permissions" are terms that supplement the terms of this
|
|
||||||
License by making exceptions from one or more of its conditions.
|
|
||||||
Additional permissions that are applicable to the entire Program shall
|
|
||||||
be treated as though they were included in this License, to the extent
|
|
||||||
that they are valid under applicable law. If additional permissions
|
|
||||||
apply only to part of the Program, that part may be used separately
|
|
||||||
under those permissions, but the entire Program remains governed by
|
|
||||||
this License without regard to the additional permissions.
|
|
||||||
|
|
||||||
When you convey a copy of a covered work, you may at your option
|
|
||||||
remove any additional permissions from that copy, or from any part of
|
|
||||||
it. (Additional permissions may be written to require their own
|
|
||||||
removal in certain cases when you modify the work.) You may place
|
|
||||||
additional permissions on material, added by you to a covered work,
|
|
||||||
for which you have or can give appropriate copyright permission.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, for material you
|
|
||||||
add to a covered work, you may (if authorized by the copyright holders of
|
|
||||||
that material) supplement the terms of this License with terms:
|
|
||||||
|
|
||||||
a) Disclaiming warranty or limiting liability differently from the
|
|
||||||
terms of sections 15 and 16 of this License; or
|
|
||||||
|
|
||||||
b) Requiring preservation of specified reasonable legal notices or
|
|
||||||
author attributions in that material or in the Appropriate Legal
|
|
||||||
Notices displayed by works containing it; or
|
|
||||||
|
|
||||||
c) Prohibiting misrepresentation of the origin of that material, or
|
|
||||||
requiring that modified versions of such material be marked in
|
|
||||||
reasonable ways as different from the original version; or
|
|
||||||
|
|
||||||
d) Limiting the use for publicity purposes of names of licensors or
|
|
||||||
authors of the material; or
|
|
||||||
|
|
||||||
e) Declining to grant rights under trademark law for use of some
|
|
||||||
trade names, trademarks, or service marks; or
|
|
||||||
|
|
||||||
f) Requiring indemnification of licensors and authors of that
|
|
||||||
material by anyone who conveys the material (or modified versions of
|
|
||||||
it) with contractual assumptions of liability to the recipient, for
|
|
||||||
any liability that these contractual assumptions directly impose on
|
|
||||||
those licensors and authors.
|
|
||||||
|
|
||||||
All other non-permissive additional terms are considered "further
|
|
||||||
restrictions" within the meaning of section 10. If the Program as you
|
|
||||||
received it, or any part of it, contains a notice stating that it is
|
|
||||||
governed by this License along with a term that is a further
|
|
||||||
restriction, you may remove that term. If a license document contains
|
|
||||||
a further restriction but permits relicensing or conveying under this
|
|
||||||
License, you may add to a covered work material governed by the terms
|
|
||||||
of that license document, provided that the further restriction does
|
|
||||||
not survive such relicensing or conveying.
|
|
||||||
|
|
||||||
If you add terms to a covered work in accord with this section, you
|
|
||||||
must place, in the relevant source files, a statement of the
|
|
||||||
additional terms that apply to those files, or a notice indicating
|
|
||||||
where to find the applicable terms.
|
|
||||||
|
|
||||||
Additional terms, permissive or non-permissive, may be stated in the
|
|
||||||
form of a separately written license, or stated as exceptions;
|
|
||||||
the above requirements apply either way.
|
|
||||||
|
|
||||||
8. Termination.
|
|
||||||
|
|
||||||
You may not propagate or modify a covered work except as expressly
|
|
||||||
provided under this License. Any attempt otherwise to propagate or
|
|
||||||
modify it is void, and will automatically terminate your rights under
|
|
||||||
this License (including any patent licenses granted under the third
|
|
||||||
paragraph of section 11).
|
|
||||||
|
|
||||||
However, if you cease all violation of this License, then your
|
|
||||||
license from a particular copyright holder is reinstated (a)
|
|
||||||
provisionally, unless and until the copyright holder explicitly and
|
|
||||||
finally terminates your license, and (b) permanently, if the copyright
|
|
||||||
holder fails to notify you of the violation by some reasonable means
|
|
||||||
prior to 60 days after the cessation.
|
|
||||||
|
|
||||||
Moreover, your license from a particular copyright holder is
|
|
||||||
reinstated permanently if the copyright holder notifies you of the
|
|
||||||
violation by some reasonable means, this is the first time you have
|
|
||||||
received notice of violation of this License (for any work) from that
|
|
||||||
copyright holder, and you cure the violation prior to 30 days after
|
|
||||||
your receipt of the notice.
|
|
||||||
|
|
||||||
Termination of your rights under this section does not terminate the
|
|
||||||
licenses of parties who have received copies or rights from you under
|
|
||||||
this License. If your rights have been terminated and not permanently
|
|
||||||
reinstated, you do not qualify to receive new licenses for the same
|
|
||||||
material under section 10.
|
|
||||||
|
|
||||||
9. Acceptance Not Required for Having Copies.
|
|
||||||
|
|
||||||
You are not required to accept this License in order to receive or
|
|
||||||
run a copy of the Program. Ancillary propagation of a covered work
|
|
||||||
occurring solely as a consequence of using peer-to-peer transmission
|
|
||||||
to receive a copy likewise does not require acceptance. However,
|
|
||||||
nothing other than this License grants you permission to propagate or
|
|
||||||
modify any covered work. These actions infringe copyright if you do
|
|
||||||
not accept this License. Therefore, by modifying or propagating a
|
|
||||||
covered work, you indicate your acceptance of this License to do so.
|
|
||||||
|
|
||||||
10. Automatic Licensing of Downstream Recipients.
|
|
||||||
|
|
||||||
Each time you convey a covered work, the recipient automatically
|
|
||||||
receives a license from the original licensors, to run, modify and
|
|
||||||
propagate that work, subject to this License. You are not responsible
|
|
||||||
for enforcing compliance by third parties with this License.
|
|
||||||
|
|
||||||
An "entity transaction" is a transaction transferring control of an
|
|
||||||
organization, or substantially all assets of one, or subdividing an
|
|
||||||
organization, or merging organizations. If propagation of a covered
|
|
||||||
work results from an entity transaction, each party to that
|
|
||||||
transaction who receives a copy of the work also receives whatever
|
|
||||||
licenses to the work the party's predecessor in interest had or could
|
|
||||||
give under the previous paragraph, plus a right to possession of the
|
|
||||||
Corresponding Source of the work from the predecessor in interest, if
|
|
||||||
the predecessor has it or can get it with reasonable efforts.
|
|
||||||
|
|
||||||
You may not impose any further restrictions on the exercise of the
|
|
||||||
rights granted or affirmed under this License. For example, you may
|
|
||||||
not impose a license fee, royalty, or other charge for exercise of
|
|
||||||
rights granted under this License, and you may not initiate litigation
|
|
||||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
|
||||||
any patent claim is infringed by making, using, selling, offering for
|
|
||||||
sale, or importing the Program or any portion of it.
|
|
||||||
|
|
||||||
11. Patents.
|
|
||||||
|
|
||||||
A "contributor" is a copyright holder who authorizes use under this
|
|
||||||
License of the Program or a work on which the Program is based. The
|
|
||||||
work thus licensed is called the contributor's "contributor version".
|
|
||||||
|
|
||||||
A contributor's "essential patent claims" are all patent claims
|
|
||||||
owned or controlled by the contributor, whether already acquired or
|
|
||||||
hereafter acquired, that would be infringed by some manner, permitted
|
|
||||||
by this License, of making, using, or selling its contributor version,
|
|
||||||
but do not include claims that would be infringed only as a
|
|
||||||
consequence of further modification of the contributor version. For
|
|
||||||
purposes of this definition, "control" includes the right to grant
|
|
||||||
patent sublicenses in a manner consistent with the requirements of
|
|
||||||
this License.
|
|
||||||
|
|
||||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
|
||||||
patent license under the contributor's essential patent claims, to
|
|
||||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
|
||||||
propagate the contents of its contributor version.
|
|
||||||
|
|
||||||
In the following three paragraphs, a "patent license" is any express
|
|
||||||
agreement or commitment, however denominated, not to enforce a patent
|
|
||||||
(such as an express permission to practice a patent or covenant not to
|
|
||||||
sue for patent infringement). To "grant" such a patent license to a
|
|
||||||
party means to make such an agreement or commitment not to enforce a
|
|
||||||
patent against the party.
|
|
||||||
|
|
||||||
If you convey a covered work, knowingly relying on a patent license,
|
|
||||||
and the Corresponding Source of the work is not available for anyone
|
|
||||||
to copy, free of charge and under the terms of this License, through a
|
|
||||||
publicly available network server or other readily accessible means,
|
|
||||||
then you must either (1) cause the Corresponding Source to be so
|
|
||||||
available, or (2) arrange to deprive yourself of the benefit of the
|
|
||||||
patent license for this particular work, or (3) arrange, in a manner
|
|
||||||
consistent with the requirements of this License, to extend the patent
|
|
||||||
license to downstream recipients. "Knowingly relying" means you have
|
|
||||||
actual knowledge that, but for the patent license, your conveying the
|
|
||||||
covered work in a country, or your recipient's use of the covered work
|
|
||||||
in a country, would infringe one or more identifiable patents in that
|
|
||||||
country that you have reason to believe are valid.
|
|
||||||
|
|
||||||
If, pursuant to or in connection with a single transaction or
|
|
||||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
|
||||||
covered work, and grant a patent license to some of the parties
|
|
||||||
receiving the covered work authorizing them to use, propagate, modify
|
|
||||||
or convey a specific copy of the covered work, then the patent license
|
|
||||||
you grant is automatically extended to all recipients of the covered
|
|
||||||
work and works based on it.
|
|
||||||
|
|
||||||
A patent license is "discriminatory" if it does not include within
|
|
||||||
the scope of its coverage, prohibits the exercise of, or is
|
|
||||||
conditioned on the non-exercise of one or more of the rights that are
|
|
||||||
specifically granted under this License. You may not convey a covered
|
|
||||||
work if you are a party to an arrangement with a third party that is
|
|
||||||
in the business of distributing software, under which you make payment
|
|
||||||
to the third party based on the extent of your activity of conveying
|
|
||||||
the work, and under which the third party grants, to any of the
|
|
||||||
parties who would receive the covered work from you, a discriminatory
|
|
||||||
patent license (a) in connection with copies of the covered work
|
|
||||||
conveyed by you (or copies made from those copies), or (b) primarily
|
|
||||||
for and in connection with specific products or compilations that
|
|
||||||
contain the covered work, unless you entered into that arrangement,
|
|
||||||
or that patent license was granted, prior to 28 March 2007.
|
|
||||||
|
|
||||||
Nothing in this License shall be construed as excluding or limiting
|
|
||||||
any implied license or other defenses to infringement that may
|
|
||||||
otherwise be available to you under applicable patent law.
|
|
||||||
|
|
||||||
12. No Surrender of Others' Freedom.
|
|
||||||
|
|
||||||
If conditions are imposed on you (whether by court order, agreement or
|
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
|
||||||
excuse you from the conditions of this License. If you cannot convey a
|
|
||||||
covered work so as to satisfy simultaneously your obligations under this
|
|
||||||
License and any other pertinent obligations, then as a consequence you may
|
|
||||||
not convey it at all. For example, if you agree to terms that obligate you
|
|
||||||
to collect a royalty for further conveying from those to whom you convey
|
|
||||||
the Program, the only way you could satisfy both those terms and this
|
|
||||||
License would be to refrain entirely from conveying the Program.
|
|
||||||
|
|
||||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, if you modify the
|
|
||||||
Program, your modified version must prominently offer all users
|
|
||||||
interacting with it remotely through a computer network (if your version
|
|
||||||
supports such interaction) an opportunity to receive the Corresponding
|
|
||||||
Source of your version by providing access to the Corresponding Source
|
|
||||||
from a network server at no charge, through some standard or customary
|
|
||||||
means of facilitating copying of software. This Corresponding Source
|
|
||||||
shall include the Corresponding Source for any work covered by version 3
|
|
||||||
of the GNU General Public License that is incorporated pursuant to the
|
|
||||||
following paragraph.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, you have
|
|
||||||
permission to link or combine any covered work with a work licensed
|
|
||||||
under version 3 of the GNU General Public License into a single
|
|
||||||
combined work, and to convey the resulting work. The terms of this
|
|
||||||
License will continue to apply to the part which is the covered work,
|
|
||||||
but the work with which it is combined will remain governed by version
|
|
||||||
3 of the GNU General Public License.
|
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of
|
|
||||||
the GNU Affero General Public License from time to time. Such new versions
|
|
||||||
will be similar in spirit to the present version, but may differ in detail to
|
|
||||||
address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the
|
|
||||||
Program specifies that a certain numbered version of the GNU Affero General
|
|
||||||
Public License "or any later version" applies to it, you have the
|
|
||||||
option of following the terms and conditions either of that numbered
|
|
||||||
version or of any later version published by the Free Software
|
|
||||||
Foundation. If the Program does not specify a version number of the
|
|
||||||
GNU Affero General Public License, you may choose any version ever published
|
|
||||||
by the Free Software Foundation.
|
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future
|
|
||||||
versions of the GNU Affero General Public License can be used, that proxy's
|
|
||||||
public statement of acceptance of a version permanently authorizes you
|
|
||||||
to choose that version for the Program.
|
|
||||||
|
|
||||||
Later license versions may give you additional or different
|
|
||||||
permissions. However, no additional obligations are imposed on any
|
|
||||||
author or copyright holder as a result of your choosing to follow a
|
|
||||||
later version.
|
|
||||||
|
|
||||||
15. Disclaimer of Warranty.
|
|
||||||
|
|
||||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
|
||||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
|
||||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
|
||||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
|
||||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
||||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
|
||||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
|
||||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
|
||||||
|
|
||||||
16. Limitation of Liability.
|
|
||||||
|
|
||||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
||||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
|
||||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
|
||||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
|
||||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
|
||||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
|
||||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
|
||||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
|
||||||
SUCH DAMAGES.
|
|
||||||
|
|
||||||
17. Interpretation of Sections 15 and 16.
|
|
||||||
|
|
||||||
If the disclaimer of warranty and limitation of liability provided
|
|
||||||
above cannot be given local legal effect according to their terms,
|
|
||||||
reviewing courts shall apply local law that most closely approximates
|
|
||||||
an absolute waiver of all civil liability in connection with the
|
|
||||||
Program, unless a warranty or assumption of liability accompanies a
|
|
||||||
copy of the Program in return for a fee.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest
|
|
||||||
possible use to the public, the best way to achieve this is to make it
|
|
||||||
free software which everyone can redistribute and change under these terms.
|
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest
|
|
||||||
to attach them to the start of each source file to most effectively
|
|
||||||
state the exclusion of warranty; and each file should have at least
|
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
|
||||||
|
|
||||||
<one line to give the program's name and a brief idea of what it does.>
|
|
||||||
Copyright (C) <year> <name of author>
|
|
||||||
|
|
||||||
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/>.
|
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
|
||||||
|
|
||||||
If your software can interact with users remotely through a computer
|
|
||||||
network, you should also make sure that it provides a way for users to
|
|
||||||
get its source. For example, if your program is a web application, its
|
|
||||||
interface could display a "Source" link that leads users to an archive
|
|
||||||
of the code. There are many ways you could offer source, and different
|
|
||||||
solutions will be better for different programs; see section 13 for the
|
|
||||||
specific requirements.
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or school,
|
|
||||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
|
||||||
For more information on this, and how to apply and follow the GNU AGPL, see
|
|
||||||
<https://www.gnu.org/licenses/>.
|
|
||||||
7
Makefile
7
Makefile
|
|
@ -6,12 +6,12 @@ CHECKER_SOURCES := main.go $(wildcard checker/*.go)
|
||||||
|
|
||||||
GO_LDFLAGS := -X main.Version=$(CHECKER_VERSION)
|
GO_LDFLAGS := -X main.Version=$(CHECKER_VERSION)
|
||||||
|
|
||||||
.PHONY: all plugin docker test clean
|
.PHONY: all plugin docker clean
|
||||||
|
|
||||||
all: $(CHECKER_NAME)
|
all: $(CHECKER_NAME)
|
||||||
|
|
||||||
$(CHECKER_NAME): $(CHECKER_SOURCES)
|
$(CHECKER_NAME): $(CHECKER_SOURCES)
|
||||||
go build -tags standalone -ldflags "$(GO_LDFLAGS)" -o $@ .
|
go build -ldflags "$(GO_LDFLAGS)" -o $@ .
|
||||||
|
|
||||||
plugin: $(CHECKER_NAME).so
|
plugin: $(CHECKER_NAME).so
|
||||||
|
|
||||||
|
|
@ -21,8 +21,5 @@ $(CHECKER_NAME).so: $(CHECKER_SOURCES) $(wildcard plugin/*.go)
|
||||||
docker:
|
docker:
|
||||||
docker build --build-arg CHECKER_VERSION=$(CHECKER_VERSION) -t $(CHECKER_IMAGE) .
|
docker build --build-arg CHECKER_VERSION=$(CHECKER_VERSION) -t $(CHECKER_IMAGE) .
|
||||||
|
|
||||||
test:
|
|
||||||
go test -tags standalone ./...
|
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
rm -f $(CHECKER_NAME) $(CHECKER_NAME).so
|
rm -f $(CHECKER_NAME) $(CHECKER_NAME).so
|
||||||
|
|
|
||||||
51
README.md
51
README.md
|
|
@ -19,8 +19,8 @@ make
|
||||||
|
|
||||||
The server exposes:
|
The server exposes:
|
||||||
|
|
||||||
- `GET /health`, health check
|
- `GET /health` — health check
|
||||||
- `POST /collect`, collect ping observations (happyDomain external checker protocol)
|
- `POST /collect` — collect ping observations (happyDomain external checker protocol)
|
||||||
|
|
||||||
### Docker
|
### Docker
|
||||||
|
|
||||||
|
|
@ -58,25 +58,40 @@ make docker CHECKER_VERSION=1.2.3
|
||||||
|
|
||||||
Set the `endpoint` admin option for the ping checker to the URL of the running checker-ping server (e.g., `http://checker-ping:8080`). happyDomain will delegate observation collection to this endpoint.
|
Set the `endpoint` admin option for the ping checker to the URL of the running checker-ping server (e.g., `http://checker-ping:8080`). happyDomain will delegate observation collection to this endpoint.
|
||||||
|
|
||||||
### Deployment
|
## Protocol
|
||||||
|
|
||||||
The `/collect` endpoint has no built-in authentication and will issue
|
### POST /collect
|
||||||
ICMP probes to whatever hostnames or IP addresses the caller supplies,
|
|
||||||
including private (RFC 1918), loopback, link-local, and cloud metadata
|
|
||||||
addresses (e.g. `169.254.169.254`). It is meant to run on a trusted
|
|
||||||
network, reachable only by the happyDomain instance that drives it.
|
|
||||||
Restrict access via a reverse proxy with authentication, a network ACL,
|
|
||||||
or by binding the listener to a private interface; do not expose it
|
|
||||||
directly to the public internet.
|
|
||||||
|
|
||||||
## Rules
|
Request:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"key": "ping",
|
||||||
|
"target": {"userId": "...", "domainId": "..."},
|
||||||
|
"options": {
|
||||||
|
"addresses": ["1.2.3.4", "2001:db8::1"],
|
||||||
|
"count": 5
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
| Code | Description | Severity |
|
Response:
|
||||||
|-----------------------|---------------------------------------------------------------------------------------------------|---------------------|
|
```json
|
||||||
| `ping.reachable` | Verifies every target replied to at least one ICMP probe. | CRITICAL |
|
{
|
||||||
| `ping.rtt` | Flags targets whose average round-trip time crosses the warning or critical threshold. | CRITICAL |
|
"data": {
|
||||||
| `ping.ipv6_reachable` | Verifies that at least one IPv6 target replied to an ICMP probe. | WARNING |
|
"targets": [
|
||||||
| `ping.packet_loss` | Flags targets whose packet-loss ratio crosses the warning or critical threshold. | CRITICAL |
|
{
|
||||||
|
"address": "1.2.3.4",
|
||||||
|
"rtt_min": 1.2,
|
||||||
|
"rtt_avg": 3.4,
|
||||||
|
"rtt_max": 5.6,
|
||||||
|
"packet_loss": 0,
|
||||||
|
"sent": 5,
|
||||||
|
"received": 5
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## License & licensing roadmap
|
## License & licensing roadmap
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -26,6 +26,7 @@ import (
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"net"
|
"net"
|
||||||
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
probing "github.com/prometheus-community/pro-bing"
|
probing "github.com/prometheus-community/pro-bing"
|
||||||
|
|
@ -44,10 +45,12 @@ func (p *pingProvider) Collect(ctx context.Context, opts sdk.CheckerOptions) (an
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
const minCount, maxCount = 1, 20
|
|
||||||
count := sdk.GetIntOption(opts, "count", 5)
|
count := sdk.GetIntOption(opts, "count", 5)
|
||||||
if count < minCount || count > maxCount {
|
if count < 1 {
|
||||||
return nil, fmt.Errorf("count must be between %d and %d, got %d", minCount, maxCount, count)
|
count = 1
|
||||||
|
}
|
||||||
|
if count > 20 {
|
||||||
|
count = 20
|
||||||
}
|
}
|
||||||
|
|
||||||
data := &PingData{}
|
data := &PingData{}
|
||||||
|
|
@ -73,13 +76,8 @@ func (p *pingProvider) Collect(ctx context.Context, opts sdk.CheckerOptions) (an
|
||||||
}
|
}
|
||||||
|
|
||||||
stats := pinger.Statistics()
|
stats := pinger.Statistics()
|
||||||
var resolved string
|
|
||||||
if ip := pinger.IPAddr(); ip != nil {
|
|
||||||
resolved = ip.IP.String()
|
|
||||||
}
|
|
||||||
data.Targets = append(data.Targets, PingTargetResult{
|
data.Targets = append(data.Targets, PingTargetResult{
|
||||||
Address: addr,
|
Address: addr,
|
||||||
ResolvedIP: resolved,
|
|
||||||
RTTMin: float64(stats.MinRtt.Microseconds()) / 1000.0,
|
RTTMin: float64(stats.MinRtt.Microseconds()) / 1000.0,
|
||||||
RTTAvg: float64(stats.AvgRtt.Microseconds()) / 1000.0,
|
RTTAvg: float64(stats.AvgRtt.Microseconds()) / 1000.0,
|
||||||
RTTMax: float64(stats.MaxRtt.Microseconds()) / 1000.0,
|
RTTMax: float64(stats.MaxRtt.Microseconds()) / 1000.0,
|
||||||
|
|
@ -90,7 +88,7 @@ func (p *pingProvider) Collect(ctx context.Context, opts sdk.CheckerOptions) (an
|
||||||
}
|
}
|
||||||
|
|
||||||
if len(data.Targets) == 0 {
|
if len(data.Targets) == 0 {
|
||||||
return nil, fmt.Errorf("all %d ping(s) failed; first error: %s", len(errs), errs[0])
|
return nil, fmt.Errorf("all pings failed: %s", strings.Join(errs, "; "))
|
||||||
}
|
}
|
||||||
|
|
||||||
return data, nil
|
return data, nil
|
||||||
|
|
@ -130,10 +128,7 @@ func resolveAddresses(opts sdk.CheckerOptions) ([]string, error) {
|
||||||
if svc.Type != "abstract.Server" {
|
if svc.Type != "abstract.Server" {
|
||||||
return nil, fmt.Errorf("service is %s, expected abstract.Server", svc.Type)
|
return nil, fmt.Errorf("service is %s, expected abstract.Server", svc.Type)
|
||||||
}
|
}
|
||||||
ips, err := ipsFromService(&svc)
|
ips := ipsFromService(&svc)
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("decode service payload: %w", err)
|
|
||||||
}
|
|
||||||
if len(ips) > 0 {
|
if len(ips) > 0 {
|
||||||
addrs := make([]string, len(ips))
|
addrs := make([]string, len(ips))
|
||||||
for i, ip := range ips {
|
for i, ip := range ips {
|
||||||
|
|
@ -147,10 +142,10 @@ func resolveAddresses(opts sdk.CheckerOptions) ([]string, error) {
|
||||||
return nil, fmt.Errorf("no addresses provided: set 'addresses', 'address', or 'service' in options")
|
return nil, fmt.Errorf("no addresses provided: set 'addresses', 'address', or 'service' in options")
|
||||||
}
|
}
|
||||||
|
|
||||||
func ipsFromService(svc *happydns.ServiceMessage) ([]net.IP, error) {
|
func ipsFromService(svc *happydns.ServiceMessage) []net.IP {
|
||||||
var server abstract.Server
|
var server abstract.Server
|
||||||
if err := json.Unmarshal(svc.Service, &server); err != nil {
|
if err := json.Unmarshal(svc.Service, &server); err != nil {
|
||||||
return nil, err
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
var ips []net.IP
|
var ips []net.IP
|
||||||
|
|
@ -160,5 +155,5 @@ func ipsFromService(svc *happydns.ServiceMessage) ([]net.IP, error) {
|
||||||
if server.AAAA != nil && len(server.AAAA.AAAA) > 0 {
|
if server.AAAA != nil && len(server.AAAA.AAAA) > 0 {
|
||||||
ips = append(ips, server.AAAA.AAAA)
|
ips = append(ips, server.AAAA.AAAA)
|
||||||
}
|
}
|
||||||
return ips, nil
|
return ips
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,121 +0,0 @@
|
||||||
// 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"
|
|
||||||
"net"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
sdk "git.happydns.org/checker-sdk-go/checker"
|
|
||||||
happydns "git.happydns.org/happyDomain/model"
|
|
||||||
"git.happydns.org/happyDomain/services/abstract"
|
|
||||||
"github.com/miekg/dns"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestResolveAddressesAddressesSlice(t *testing.T) {
|
|
||||||
cases := []sdk.CheckerOptions{
|
|
||||||
{"addresses": []string{"1.1.1.1", "2.2.2.2"}},
|
|
||||||
{"addresses": []any{"1.1.1.1", "2.2.2.2"}},
|
|
||||||
{"addresses": []any{"1.1.1.1", "", "2.2.2.2"}}, // empties dropped
|
|
||||||
}
|
|
||||||
for i, opts := range cases {
|
|
||||||
got, err := resolveAddresses(opts)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("[%d] err: %v", i, err)
|
|
||||||
}
|
|
||||||
if len(got) != 2 || got[0] != "1.1.1.1" || got[1] != "2.2.2.2" {
|
|
||||||
t.Errorf("[%d] got %v", i, got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestResolveAddressesSingle(t *testing.T) {
|
|
||||||
got, err := resolveAddresses(sdk.CheckerOptions{"address": "8.8.8.8"})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
if len(got) != 1 || got[0] != "8.8.8.8" {
|
|
||||||
t.Errorf("got %v", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestResolveAddressesMissing(t *testing.T) {
|
|
||||||
if _, err := resolveAddresses(sdk.CheckerOptions{}); err == nil {
|
|
||||||
t.Error("expected error for missing addresses")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestResolveAddressesEmptyStringIgnored(t *testing.T) {
|
|
||||||
if _, err := resolveAddresses(sdk.CheckerOptions{"address": ""}); err == nil {
|
|
||||||
t.Error("expected error when address is empty string")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestResolveAddressesWrongServiceType(t *testing.T) {
|
|
||||||
svc := happydns.ServiceMessage{
|
|
||||||
ServiceMeta: happydns.ServiceMeta{Type: "abstract.NotAServer"},
|
|
||||||
Service: json.RawMessage(`{}`),
|
|
||||||
}
|
|
||||||
_, err := resolveAddresses(sdk.CheckerOptions{"service": svc})
|
|
||||||
if err == nil || !strings.Contains(err.Error(), "expected abstract.Server") {
|
|
||||||
t.Errorf("got err=%v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIpsFromService(t *testing.T) {
|
|
||||||
srv := abstract.Server{
|
|
||||||
A: &dns.A{A: net.ParseIP("192.0.2.1").To4()},
|
|
||||||
AAAA: &dns.AAAA{AAAA: net.ParseIP("2001:db8::1")},
|
|
||||||
}
|
|
||||||
raw, err := json.Marshal(srv)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
msg := &happydns.ServiceMessage{Service: raw}
|
|
||||||
ips, err := ipsFromService(msg)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("err: %v", err)
|
|
||||||
}
|
|
||||||
if len(ips) != 2 {
|
|
||||||
t.Fatalf("got %d ips, want 2: %v", len(ips), ips)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIpsFromServiceMalformed(t *testing.T) {
|
|
||||||
msg := &happydns.ServiceMessage{Service: json.RawMessage(`{not json`)}
|
|
||||||
if _, err := ipsFromService(msg); err == nil {
|
|
||||||
t.Error("expected error on malformed payload")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIpsFromServiceEmpty(t *testing.T) {
|
|
||||||
msg := &happydns.ServiceMessage{Service: json.RawMessage(`{}`)}
|
|
||||||
ips, err := ipsFromService(msg)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("err: %v", err)
|
|
||||||
}
|
|
||||||
if len(ips) != 0 {
|
|
||||||
t.Errorf("expected 0 ips, got %v", ips)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -38,7 +38,7 @@ import (
|
||||||
var Version = "built-in"
|
var Version = "built-in"
|
||||||
|
|
||||||
// Definition returns the CheckerDefinition for the ping checker.
|
// Definition returns the CheckerDefinition for the ping checker.
|
||||||
func (p *pingProvider) Definition() *happydns.CheckerDefinition {
|
func Definition() *happydns.CheckerDefinition {
|
||||||
return &happydns.CheckerDefinition{
|
return &happydns.CheckerDefinition{
|
||||||
ID: "ping",
|
ID: "ping",
|
||||||
Name: "Ping (ICMP)",
|
Name: "Ping (ICMP)",
|
||||||
|
|
@ -89,7 +89,9 @@ func (p *pingProvider) Definition() *happydns.CheckerDefinition {
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
Rules: Rules(),
|
Rules: []happydns.CheckRule{
|
||||||
|
Rule(),
|
||||||
|
},
|
||||||
Interval: &happydns.CheckIntervalSpec{
|
Interval: &happydns.CheckIntervalSpec{
|
||||||
Min: 1 * time.Minute,
|
Min: 1 * time.Minute,
|
||||||
Max: 1 * time.Hour,
|
Max: 1 * time.Hour,
|
||||||
|
|
|
||||||
|
|
@ -22,6 +22,7 @@
|
||||||
package checker
|
package checker
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"fmt"
|
||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
@ -50,3 +51,44 @@ type Metric struct {
|
||||||
Labels map[string]string `json:"labels,omitempty"`
|
Labels map[string]string `json:"labels,omitempty"`
|
||||||
Timestamp time.Time `json:"timestamp"`
|
Timestamp time.Time `json:"timestamp"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// EvaluateResult holds the evaluation outcome for a single target.
|
||||||
|
type EvaluateResult struct {
|
||||||
|
Address string `json:"address"`
|
||||||
|
Status int `json:"status"`
|
||||||
|
Message string `json:"message"`
|
||||||
|
Code string `json:"code"`
|
||||||
|
}
|
||||||
|
|
||||||
|
const (
|
||||||
|
StatusUnknown = 0
|
||||||
|
StatusOK = 1
|
||||||
|
StatusWarn = 3
|
||||||
|
StatusCrit = 4
|
||||||
|
)
|
||||||
|
|
||||||
|
// Evaluate checks the ping data against the given thresholds and returns one
|
||||||
|
// result per target.
|
||||||
|
func Evaluate(data *PingData, warningRTT, criticalRTT, warningPacketLoss, criticalPacketLoss float64) []EvaluateResult {
|
||||||
|
if len(data.Targets) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
results := make([]EvaluateResult, 0, len(data.Targets))
|
||||||
|
for _, target := range data.Targets {
|
||||||
|
status := StatusOK
|
||||||
|
if target.PacketLoss >= criticalPacketLoss || target.RTTAvg >= criticalRTT {
|
||||||
|
status = StatusCrit
|
||||||
|
} else if target.PacketLoss >= warningPacketLoss || target.RTTAvg >= warningRTT {
|
||||||
|
status = StatusWarn
|
||||||
|
}
|
||||||
|
|
||||||
|
results = append(results, EvaluateResult{
|
||||||
|
Address: target.Address,
|
||||||
|
Status: status,
|
||||||
|
Message: fmt.Sprintf("%.1fms avg, %.0f%% loss", target.RTTAvg, target.PacketLoss),
|
||||||
|
Code: "ping_result",
|
||||||
|
})
|
||||||
|
}
|
||||||
|
return results
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -19,8 +19,6 @@
|
||||||
// You should have received a copy of the GNU Affero General Public License
|
// 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/>.
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
//go:build standalone
|
|
||||||
|
|
||||||
package checker
|
package checker
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|
@ -32,7 +30,7 @@ import (
|
||||||
sdk "git.happydns.org/checker-sdk-go/checker"
|
sdk "git.happydns.org/checker-sdk-go/checker"
|
||||||
)
|
)
|
||||||
|
|
||||||
// RenderForm implements server.Interactive. It exposes a minimal form
|
// RenderForm implements sdk.CheckerInteractive. It exposes a minimal form
|
||||||
// letting a human submit one or more ping targets (hostnames or IPs) along
|
// letting a human submit one or more ping targets (hostnames or IPs) along
|
||||||
// with the usual threshold knobs.
|
// with the usual threshold knobs.
|
||||||
func (p *pingProvider) RenderForm() []sdk.CheckerOptionField {
|
func (p *pingProvider) RenderForm() []sdk.CheckerOptionField {
|
||||||
|
|
@ -78,8 +76,8 @@ func (p *pingProvider) RenderForm() []sdk.CheckerOptionField {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// ParseForm implements server.Interactive. It converts the HTML form
|
// ParseForm implements sdk.CheckerInteractive. It converts the HTML form
|
||||||
// inputs into a CheckerOptions that Collect can consume directly, pinging
|
// inputs into a CheckerOptions that Collect can consume directly — pinging
|
||||||
// resolves hostnames on its own, so no extra lookups are needed here.
|
// resolves hostnames on its own, so no extra lookups are needed here.
|
||||||
func (p *pingProvider) ParseForm(r *http.Request) (sdk.CheckerOptions, error) {
|
func (p *pingProvider) ParseForm(r *http.Request) (sdk.CheckerOptions, error) {
|
||||||
raw := strings.TrimSpace(r.FormValue("addresses"))
|
raw := strings.TrimSpace(r.FormValue("addresses"))
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,6 @@ package checker
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
happydns "git.happydns.org/checker-sdk-go/checker"
|
happydns "git.happydns.org/checker-sdk-go/checker"
|
||||||
|
|
@ -48,11 +47,16 @@ func (p *pingProvider) Key() happydns.ObservationKey {
|
||||||
return ObservationKeyPing
|
return ObservationKeyPing
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Definition implements happydns.CheckerDefinitionProvider.
|
||||||
|
func (p *pingProvider) Definition() *happydns.CheckerDefinition {
|
||||||
|
return Definition()
|
||||||
|
}
|
||||||
|
|
||||||
// ExtractMetrics implements happydns.CheckerMetricsReporter.
|
// ExtractMetrics implements happydns.CheckerMetricsReporter.
|
||||||
func (p *pingProvider) ExtractMetrics(ctx happydns.ReportContext, collectedAt time.Time) ([]happydns.CheckMetric, error) {
|
func (p *pingProvider) ExtractMetrics(ctx happydns.ReportContext, collectedAt time.Time) ([]happydns.CheckMetric, error) {
|
||||||
var data PingData
|
var data PingData
|
||||||
if err := json.Unmarshal(ctx.Data(), &data); err != nil {
|
if err := json.Unmarshal(ctx.Data(), &data); err != nil {
|
||||||
return nil, fmt.Errorf("decode ping data: %w", err)
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
metrics := Metrics(&data, collectedAt)
|
metrics := Metrics(&data, collectedAt)
|
||||||
|
|
|
||||||
160
checker/rule.go
160
checker/rule.go
|
|
@ -24,69 +24,141 @@ package checker
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
"net"
|
|
||||||
|
|
||||||
sdk "git.happydns.org/checker-sdk-go/checker"
|
sdk "git.happydns.org/checker-sdk-go/checker"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Rules returns the full list of CheckRules exposed by the ping checker.
|
// Rule returns a new ping check rule for local evaluation.
|
||||||
// Each rule covers a single concern so callers see at a glance which
|
func Rule() sdk.CheckRule {
|
||||||
// aspects passed and which did not, instead of sharing a single monolithic
|
return &pingRule{}
|
||||||
// rule result.
|
}
|
||||||
func Rules() []sdk.CheckRule {
|
|
||||||
return []sdk.CheckRule{
|
type pingRule struct{}
|
||||||
&reachabilityRule{},
|
|
||||||
&packetLossRule{},
|
func (r *pingRule) Name() string { return "ping_check" }
|
||||||
&rttRule{},
|
func (r *pingRule) Description() string {
|
||||||
&ipv6ReachabilityRule{},
|
return "Checks ICMP ping reachability, round-trip time, and packet loss"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *pingRule) ValidateOptions(opts sdk.CheckerOptions) error {
|
||||||
|
warningRTT := float64(100)
|
||||||
|
criticalRTT := float64(500)
|
||||||
|
warningPacketLoss := float64(10)
|
||||||
|
criticalPacketLoss := float64(50)
|
||||||
|
|
||||||
|
if v, ok := opts["warningRTT"]; ok {
|
||||||
|
d, ok := v.(float64)
|
||||||
|
if !ok {
|
||||||
|
return fmt.Errorf("warningRTT must be a number")
|
||||||
|
}
|
||||||
|
if d <= 0 {
|
||||||
|
return fmt.Errorf("warningRTT must be positive")
|
||||||
|
}
|
||||||
|
warningRTT = d
|
||||||
|
}
|
||||||
|
if v, ok := opts["criticalRTT"]; ok {
|
||||||
|
d, ok := v.(float64)
|
||||||
|
if !ok {
|
||||||
|
return fmt.Errorf("criticalRTT must be a number")
|
||||||
|
}
|
||||||
|
if d <= 0 {
|
||||||
|
return fmt.Errorf("criticalRTT must be positive")
|
||||||
|
}
|
||||||
|
criticalRTT = d
|
||||||
|
}
|
||||||
|
if v, ok := opts["warningPacketLoss"]; ok {
|
||||||
|
d, ok := v.(float64)
|
||||||
|
if !ok {
|
||||||
|
return fmt.Errorf("warningPacketLoss must be a number")
|
||||||
|
}
|
||||||
|
if d < 0 || d > 100 {
|
||||||
|
return fmt.Errorf("warningPacketLoss must be between 0 and 100")
|
||||||
|
}
|
||||||
|
warningPacketLoss = d
|
||||||
|
}
|
||||||
|
if v, ok := opts["criticalPacketLoss"]; ok {
|
||||||
|
d, ok := v.(float64)
|
||||||
|
if !ok {
|
||||||
|
return fmt.Errorf("criticalPacketLoss must be a number")
|
||||||
|
}
|
||||||
|
if d < 0 || d > 100 {
|
||||||
|
return fmt.Errorf("criticalPacketLoss must be between 0 and 100")
|
||||||
|
}
|
||||||
|
criticalPacketLoss = d
|
||||||
|
}
|
||||||
|
if v, ok := opts["count"]; ok {
|
||||||
|
d, ok := v.(float64)
|
||||||
|
if !ok {
|
||||||
|
return fmt.Errorf("count must be a number")
|
||||||
|
}
|
||||||
|
if d < 1 || d > 20 {
|
||||||
|
return fmt.Errorf("count must be between 1 and 20")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// validateThresholdPair checks that warn and crit are within [min, max] and
|
if criticalRTT <= warningRTT {
|
||||||
// that crit is strictly greater than warn. The names are used in error
|
return fmt.Errorf("criticalRTT (%v) must be greater than warningRTT (%v)", criticalRTT, warningRTT)
|
||||||
// messages so callers get diagnostics naming their actual options.
|
|
||||||
func validateThresholdPair(warnName, critName string, warn, crit, min, max float64) error {
|
|
||||||
if warn < min || warn > max {
|
|
||||||
return fmt.Errorf("%s must be between %v and %v", warnName, min, max)
|
|
||||||
}
|
}
|
||||||
if crit < min || crit > max {
|
if criticalPacketLoss <= warningPacketLoss {
|
||||||
return fmt.Errorf("%s must be between %v and %v", critName, min, max)
|
return fmt.Errorf("criticalPacketLoss (%v) must be greater than warningPacketLoss (%v)", criticalPacketLoss, warningPacketLoss)
|
||||||
}
|
|
||||||
if crit <= warn {
|
|
||||||
return fmt.Errorf("%s (%v) must be greater than %s (%v)", critName, crit, warnName, warn)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// loadPingData fetches the ping observation. On error, returns a CheckState
|
func (r *pingRule) Evaluate(ctx context.Context, obs sdk.ObservationGetter, opts sdk.CheckerOptions) []sdk.CheckState {
|
||||||
// the caller should emit to short-circuit its rule.
|
|
||||||
func loadPingData(ctx context.Context, obs sdk.ObservationGetter) (*PingData, *sdk.CheckState) {
|
|
||||||
var data PingData
|
var data PingData
|
||||||
if err := obs.Get(ctx, ObservationKeyPing, &data); err != nil {
|
if err := obs.Get(ctx, ObservationKeyPing, &data); err != nil {
|
||||||
return nil, &sdk.CheckState{
|
return []sdk.CheckState{{
|
||||||
Status: sdk.StatusError,
|
Status: sdk.StatusError,
|
||||||
Message: fmt.Sprintf("failed to load ping observation: %v", err),
|
Message: fmt.Sprintf("Failed to get ping data: %v", err),
|
||||||
Code: "ping.observation_error",
|
Code: "ping_error",
|
||||||
}
|
}}
|
||||||
}
|
|
||||||
return &data, nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// noTargetsState is returned when the observation has no targets at all.
|
warningRTT := sdk.GetFloatOption(opts, "warningRTT", 100)
|
||||||
func noTargetsState(code string) sdk.CheckState {
|
criticalRTT := sdk.GetFloatOption(opts, "criticalRTT", 500)
|
||||||
return sdk.CheckState{
|
warningPacketLoss := sdk.GetFloatOption(opts, "warningPacketLoss", 10)
|
||||||
Status: sdk.StatusUnknown,
|
criticalPacketLoss := sdk.GetFloatOption(opts, "criticalPacketLoss", 50)
|
||||||
|
|
||||||
|
results := Evaluate(&data, warningRTT, criticalRTT, warningPacketLoss, criticalPacketLoss)
|
||||||
|
if len(results) == 0 {
|
||||||
|
return []sdk.CheckState{{
|
||||||
|
Status: sdk.StatusInfo,
|
||||||
Message: "No targets to ping",
|
Message: "No targets to ping",
|
||||||
Code: code,
|
Code: "ping_no_targets",
|
||||||
}
|
}}
|
||||||
}
|
}
|
||||||
|
|
||||||
// isIPv6 reports whether addr parses as an IPv6 address (excluding
|
targetByAddr := make(map[string]PingTargetResult, len(data.Targets))
|
||||||
// IPv4-mapped representations).
|
for _, t := range data.Targets {
|
||||||
func isIPv6(addr string) bool {
|
targetByAddr[t.Address] = t
|
||||||
ip := net.ParseIP(addr)
|
|
||||||
if ip == nil {
|
|
||||||
return false
|
|
||||||
}
|
}
|
||||||
return ip.To4() == nil
|
|
||||||
|
out := make([]sdk.CheckState, 0, len(results))
|
||||||
|
for _, r := range results {
|
||||||
|
var status sdk.Status
|
||||||
|
switch r.Status {
|
||||||
|
case StatusOK:
|
||||||
|
status = sdk.StatusOK
|
||||||
|
case StatusWarn:
|
||||||
|
status = sdk.StatusWarn
|
||||||
|
case StatusCrit:
|
||||||
|
status = sdk.StatusCrit
|
||||||
|
default:
|
||||||
|
status = sdk.StatusUnknown
|
||||||
|
}
|
||||||
|
|
||||||
|
state := sdk.CheckState{
|
||||||
|
Status: status,
|
||||||
|
Subject: r.Address,
|
||||||
|
Message: r.Message,
|
||||||
|
Code: r.Code,
|
||||||
|
}
|
||||||
|
if t, ok := targetByAddr[r.Address]; ok {
|
||||||
|
state.Meta = map[string]any{"target": t}
|
||||||
|
}
|
||||||
|
out = append(out, state)
|
||||||
|
}
|
||||||
|
return out
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,113 +0,0 @@
|
||||||
// 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 (
|
|
||||||
"context"
|
|
||||||
"encoding/json"
|
|
||||||
"errors"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
sdk "git.happydns.org/checker-sdk-go/checker"
|
|
||||||
)
|
|
||||||
|
|
||||||
// stubObs implements sdk.ObservationGetter for tests. If err is non-nil, Get
|
|
||||||
// returns it; otherwise it JSON-roundtrips data into dest so callers see the
|
|
||||||
// same shape they would get over HTTP.
|
|
||||||
type stubObs struct {
|
|
||||||
data any
|
|
||||||
err error
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s stubObs) Get(_ context.Context, _ sdk.ObservationKey, dest any) error {
|
|
||||||
if s.err != nil {
|
|
||||||
return s.err
|
|
||||||
}
|
|
||||||
raw, err := json.Marshal(s.data)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return json.Unmarshal(raw, dest)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s stubObs) GetRelated(_ context.Context, _ sdk.ObservationKey) ([]sdk.RelatedObservation, error) {
|
|
||||||
return nil, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func obsWith(targets ...PingTargetResult) stubObs {
|
|
||||||
return stubObs{data: PingData{Targets: targets}}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIsIPv6(t *testing.T) {
|
|
||||||
cases := []struct {
|
|
||||||
addr string
|
|
||||||
want bool
|
|
||||||
}{
|
|
||||||
{"::1", true},
|
|
||||||
{"2001:db8::1", true},
|
|
||||||
{"127.0.0.1", false},
|
|
||||||
{"::ffff:192.0.2.1", false}, // IPv4-mapped is treated as IPv4
|
|
||||||
{"example.com", false},
|
|
||||||
{"", false},
|
|
||||||
{"not-an-ip", false},
|
|
||||||
}
|
|
||||||
for _, c := range cases {
|
|
||||||
if got := isIPv6(c.addr); got != c.want {
|
|
||||||
t.Errorf("isIPv6(%q) = %v, want %v", c.addr, got, c.want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadPingDataError(t *testing.T) {
|
|
||||||
_, st := loadPingData(context.Background(), stubObs{err: errors.New("boom")})
|
|
||||||
if st == nil {
|
|
||||||
t.Fatal("expected error CheckState, got nil")
|
|
||||||
}
|
|
||||||
if st.Status != sdk.StatusError {
|
|
||||||
t.Errorf("status = %v, want StatusError", st.Status)
|
|
||||||
}
|
|
||||||
if st.Code != "ping.observation_error" {
|
|
||||||
t.Errorf("code = %q, want ping.observation_error", st.Code)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadPingDataOK(t *testing.T) {
|
|
||||||
d, st := loadPingData(context.Background(), obsWith(PingTargetResult{Address: "1.1.1.1"}))
|
|
||||||
if st != nil {
|
|
||||||
t.Fatalf("unexpected error state: %+v", st)
|
|
||||||
}
|
|
||||||
if len(d.Targets) != 1 || d.Targets[0].Address != "1.1.1.1" {
|
|
||||||
t.Errorf("unexpected data: %+v", d)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRulesContainsAll(t *testing.T) {
|
|
||||||
names := map[string]bool{}
|
|
||||||
for _, r := range Rules() {
|
|
||||||
names[r.Name()] = true
|
|
||||||
}
|
|
||||||
for _, want := range []string{"ping.reachable", "ping.packet_loss", "ping.rtt", "ping.ipv6_reachable"} {
|
|
||||||
if !names[want] {
|
|
||||||
t.Errorf("Rules() missing %q", want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,81 +0,0 @@
|
||||||
// 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 (
|
|
||||||
"context"
|
|
||||||
|
|
||||||
sdk "git.happydns.org/checker-sdk-go/checker"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ipv6ReachabilityRule verifies at least one IPv6 target replied to a probe.
|
|
||||||
// The rule is skipped (StatusUnknown) when no IPv6 target was pinged, which
|
|
||||||
// is expected for IPv4-only hosts.
|
|
||||||
type ipv6ReachabilityRule struct{}
|
|
||||||
|
|
||||||
func (r *ipv6ReachabilityRule) Name() string { return "ping.ipv6_reachable" }
|
|
||||||
func (r *ipv6ReachabilityRule) Description() string {
|
|
||||||
return "Verifies that at least one IPv6 target replied to an ICMP probe."
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *ipv6ReachabilityRule) Evaluate(ctx context.Context, obs sdk.ObservationGetter, _ sdk.CheckerOptions) []sdk.CheckState {
|
|
||||||
data, errSt := loadPingData(ctx, obs)
|
|
||||||
if errSt != nil {
|
|
||||||
return []sdk.CheckState{*errSt}
|
|
||||||
}
|
|
||||||
|
|
||||||
var ipv6Total, ipv6Reachable int
|
|
||||||
for _, t := range data.Targets {
|
|
||||||
probed := t.ResolvedIP
|
|
||||||
if probed == "" {
|
|
||||||
probed = t.Address
|
|
||||||
}
|
|
||||||
if !isIPv6(probed) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
ipv6Total++
|
|
||||||
if t.Received > 0 {
|
|
||||||
ipv6Reachable++
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
switch {
|
|
||||||
case ipv6Total == 0:
|
|
||||||
return []sdk.CheckState{{
|
|
||||||
Status: sdk.StatusUnknown,
|
|
||||||
Message: "No IPv6 target pinged.",
|
|
||||||
Code: "ping.ipv6_reachable.skipped",
|
|
||||||
}}
|
|
||||||
case ipv6Reachable == 0:
|
|
||||||
return []sdk.CheckState{{
|
|
||||||
Status: sdk.StatusWarn,
|
|
||||||
Message: "No IPv6 target replied to ICMP probes.",
|
|
||||||
Code: "ping.ipv6_reachable.unreachable",
|
|
||||||
}}
|
|
||||||
default:
|
|
||||||
return []sdk.CheckState{{
|
|
||||||
Status: sdk.StatusOK,
|
|
||||||
Message: "At least one IPv6 target is reachable.",
|
|
||||||
Code: "ping.ipv6_reachable.ok",
|
|
||||||
}}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,80 +0,0 @@
|
||||||
// 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 (
|
|
||||||
"context"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
sdk "git.happydns.org/checker-sdk-go/checker"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestIPv6ReachabilityEvaluate(t *testing.T) {
|
|
||||||
r := &ipv6ReachabilityRule{}
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
cases := []struct {
|
|
||||||
name string
|
|
||||||
targets []PingTargetResult
|
|
||||||
wantStat sdk.Status
|
|
||||||
wantCode string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "no v6 targets",
|
|
||||||
targets: []PingTargetResult{{Address: "1.1.1.1", Sent: 5, Received: 5}},
|
|
||||||
wantStat: sdk.StatusUnknown,
|
|
||||||
wantCode: "ping.ipv6_reachable.skipped",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "v6 reachable",
|
|
||||||
targets: []PingTargetResult{
|
|
||||||
{Address: "1.1.1.1", Sent: 5, Received: 5},
|
|
||||||
{Address: "2001:db8::1", Sent: 5, Received: 5},
|
|
||||||
},
|
|
||||||
wantStat: sdk.StatusOK,
|
|
||||||
wantCode: "ping.ipv6_reachable.ok",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "all v6 unreachable",
|
|
||||||
targets: []PingTargetResult{
|
|
||||||
{Address: "2001:db8::1", Sent: 5, Received: 0},
|
|
||||||
{Address: "2001:db8::2", Sent: 5, Received: 0},
|
|
||||||
},
|
|
||||||
wantStat: sdk.StatusWarn,
|
|
||||||
wantCode: "ping.ipv6_reachable.unreachable",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
for _, c := range cases {
|
|
||||||
t.Run(c.name, func(t *testing.T) {
|
|
||||||
states := r.Evaluate(ctx, obsWith(c.targets...), sdk.CheckerOptions{})
|
|
||||||
if len(states) != 1 {
|
|
||||||
t.Fatalf("got %d states, want 1", len(states))
|
|
||||||
}
|
|
||||||
if states[0].Status != c.wantStat {
|
|
||||||
t.Errorf("status = %v, want %v", states[0].Status, c.wantStat)
|
|
||||||
}
|
|
||||||
if states[0].Code != c.wantCode {
|
|
||||||
t.Errorf("code = %q, want %q", states[0].Code, c.wantCode)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,79 +0,0 @@
|
||||||
// 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 (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
sdk "git.happydns.org/checker-sdk-go/checker"
|
|
||||||
)
|
|
||||||
|
|
||||||
// packetLossRule evaluates the observed packet-loss ratio of each target
|
|
||||||
// against the configured warning/critical thresholds.
|
|
||||||
type packetLossRule struct{}
|
|
||||||
|
|
||||||
func (r *packetLossRule) Name() string { return "ping.packet_loss" }
|
|
||||||
func (r *packetLossRule) Description() string {
|
|
||||||
return "Flags targets whose packet-loss ratio crosses the warning or critical threshold."
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *packetLossRule) ValidateOptions(opts sdk.CheckerOptions) error {
|
|
||||||
warn := sdk.GetFloatOption(opts, "warningPacketLoss", 10)
|
|
||||||
crit := sdk.GetFloatOption(opts, "criticalPacketLoss", 50)
|
|
||||||
return validateThresholdPair("warningPacketLoss", "criticalPacketLoss", warn, crit, 0, 100)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *packetLossRule) Evaluate(ctx context.Context, obs sdk.ObservationGetter, opts sdk.CheckerOptions) []sdk.CheckState {
|
|
||||||
data, errSt := loadPingData(ctx, obs)
|
|
||||||
if errSt != nil {
|
|
||||||
return []sdk.CheckState{*errSt}
|
|
||||||
}
|
|
||||||
if len(data.Targets) == 0 {
|
|
||||||
return []sdk.CheckState{noTargetsState("ping.packet_loss.no_targets")}
|
|
||||||
}
|
|
||||||
|
|
||||||
warn := sdk.GetFloatOption(opts, "warningPacketLoss", 10)
|
|
||||||
crit := sdk.GetFloatOption(opts, "criticalPacketLoss", 50)
|
|
||||||
|
|
||||||
out := make([]sdk.CheckState, 0, len(data.Targets))
|
|
||||||
for _, t := range data.Targets {
|
|
||||||
state := sdk.CheckState{
|
|
||||||
Subject: t.Address,
|
|
||||||
Message: fmt.Sprintf("Packet loss %.0f%% (warn=%.0f%%, crit=%.0f%%).", t.PacketLoss, warn, crit),
|
|
||||||
Meta: map[string]any{"target": t},
|
|
||||||
}
|
|
||||||
switch {
|
|
||||||
case t.PacketLoss >= crit:
|
|
||||||
state.Status = sdk.StatusCrit
|
|
||||||
state.Code = "ping.packet_loss.critical"
|
|
||||||
case t.PacketLoss >= warn:
|
|
||||||
state.Status = sdk.StatusWarn
|
|
||||||
state.Code = "ping.packet_loss.warning"
|
|
||||||
default:
|
|
||||||
state.Status = sdk.StatusOK
|
|
||||||
state.Code = "ping.packet_loss.ok"
|
|
||||||
}
|
|
||||||
out = append(out, state)
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
@ -1,83 +0,0 @@
|
||||||
// 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 (
|
|
||||||
"context"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
sdk "git.happydns.org/checker-sdk-go/checker"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestPacketLossValidateOptions(t *testing.T) {
|
|
||||||
r := &packetLossRule{}
|
|
||||||
cases := []struct {
|
|
||||||
name string
|
|
||||||
opts sdk.CheckerOptions
|
|
||||||
wantErr bool
|
|
||||||
}{
|
|
||||||
{"defaults", sdk.CheckerOptions{}, false},
|
|
||||||
{"valid", sdk.CheckerOptions{"warningPacketLoss": 5.0, "criticalPacketLoss": 25.0}, false},
|
|
||||||
{"warn negative", sdk.CheckerOptions{"warningPacketLoss": -1.0, "criticalPacketLoss": 50.0}, true},
|
|
||||||
{"crit over 100", sdk.CheckerOptions{"warningPacketLoss": 10.0, "criticalPacketLoss": 150.0}, true},
|
|
||||||
{"crit equal warn", sdk.CheckerOptions{"warningPacketLoss": 20.0, "criticalPacketLoss": 20.0}, true},
|
|
||||||
{"crit below warn", sdk.CheckerOptions{"warningPacketLoss": 30.0, "criticalPacketLoss": 10.0}, true},
|
|
||||||
}
|
|
||||||
for _, c := range cases {
|
|
||||||
t.Run(c.name, func(t *testing.T) {
|
|
||||||
err := r.ValidateOptions(c.opts)
|
|
||||||
if (err != nil) != c.wantErr {
|
|
||||||
t.Errorf("err=%v, wantErr=%v", err, c.wantErr)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPacketLossEvaluate(t *testing.T) {
|
|
||||||
r := &packetLossRule{}
|
|
||||||
ctx := context.Background()
|
|
||||||
opts := sdk.CheckerOptions{"warningPacketLoss": 10.0, "criticalPacketLoss": 50.0}
|
|
||||||
|
|
||||||
states := r.Evaluate(ctx, obsWith(
|
|
||||||
PingTargetResult{Address: "ok", PacketLoss: 0, Sent: 5, Received: 5},
|
|
||||||
PingTargetResult{Address: "warn", PacketLoss: 20, Sent: 5, Received: 4},
|
|
||||||
PingTargetResult{Address: "crit", PacketLoss: 80, Sent: 5, Received: 1},
|
|
||||||
), opts)
|
|
||||||
|
|
||||||
if len(states) != 3 {
|
|
||||||
t.Fatalf("got %d states, want 3", len(states))
|
|
||||||
}
|
|
||||||
want := []sdk.Status{sdk.StatusOK, sdk.StatusWarn, sdk.StatusCrit}
|
|
||||||
for i, s := range states {
|
|
||||||
if s.Status != want[i] {
|
|
||||||
t.Errorf("state[%d] status = %v, want %v", i, s.Status, want[i])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPacketLossEvaluateNoTargets(t *testing.T) {
|
|
||||||
r := &packetLossRule{}
|
|
||||||
states := r.Evaluate(context.Background(), obsWith(), sdk.CheckerOptions{})
|
|
||||||
if len(states) != 1 || states[0].Status != sdk.StatusUnknown {
|
|
||||||
t.Errorf("expected single Unknown state, got %+v", states)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,70 +0,0 @@
|
||||||
// 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 (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
sdk "git.happydns.org/checker-sdk-go/checker"
|
|
||||||
)
|
|
||||||
|
|
||||||
// reachabilityRule verifies each target replied to at least one probe.
|
|
||||||
// A target with 100% packet loss is considered unreachable.
|
|
||||||
type reachabilityRule struct{}
|
|
||||||
|
|
||||||
func (r *reachabilityRule) Name() string { return "ping.reachable" }
|
|
||||||
func (r *reachabilityRule) Description() string {
|
|
||||||
return "Verifies every target replied to at least one ICMP probe."
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *reachabilityRule) Evaluate(ctx context.Context, obs sdk.ObservationGetter, _ sdk.CheckerOptions) []sdk.CheckState {
|
|
||||||
data, errSt := loadPingData(ctx, obs)
|
|
||||||
if errSt != nil {
|
|
||||||
return []sdk.CheckState{*errSt}
|
|
||||||
}
|
|
||||||
if len(data.Targets) == 0 {
|
|
||||||
return []sdk.CheckState{noTargetsState("ping.reachable.no_targets")}
|
|
||||||
}
|
|
||||||
|
|
||||||
out := make([]sdk.CheckState, 0, len(data.Targets))
|
|
||||||
for _, t := range data.Targets {
|
|
||||||
if t.Received == 0 {
|
|
||||||
out = append(out, sdk.CheckState{
|
|
||||||
Status: sdk.StatusCrit,
|
|
||||||
Subject: t.Address,
|
|
||||||
Message: fmt.Sprintf("Target unreachable (0/%d replies).", t.Sent),
|
|
||||||
Code: "ping.reachable.unreachable",
|
|
||||||
Meta: map[string]any{"target": t},
|
|
||||||
})
|
|
||||||
} else {
|
|
||||||
out = append(out, sdk.CheckState{
|
|
||||||
Status: sdk.StatusOK,
|
|
||||||
Subject: t.Address,
|
|
||||||
Message: fmt.Sprintf("Target reachable (%d/%d replies).", t.Received, t.Sent),
|
|
||||||
Code: "ping.reachable.ok",
|
|
||||||
Meta: map[string]any{"target": t},
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
@ -1,55 +0,0 @@
|
||||||
// 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 (
|
|
||||||
"context"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
sdk "git.happydns.org/checker-sdk-go/checker"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestReachabilityEvaluate(t *testing.T) {
|
|
||||||
r := &reachabilityRule{}
|
|
||||||
states := r.Evaluate(context.Background(), obsWith(
|
|
||||||
PingTargetResult{Address: "up", Sent: 5, Received: 5},
|
|
||||||
PingTargetResult{Address: "down", Sent: 5, Received: 0},
|
|
||||||
), sdk.CheckerOptions{})
|
|
||||||
|
|
||||||
if len(states) != 2 {
|
|
||||||
t.Fatalf("got %d states, want 2", len(states))
|
|
||||||
}
|
|
||||||
if states[0].Status != sdk.StatusOK || states[0].Code != "ping.reachable.ok" {
|
|
||||||
t.Errorf("up: %+v", states[0])
|
|
||||||
}
|
|
||||||
if states[1].Status != sdk.StatusCrit || states[1].Code != "ping.reachable.unreachable" {
|
|
||||||
t.Errorf("down: %+v", states[1])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestReachabilityNoTargets(t *testing.T) {
|
|
||||||
r := &reachabilityRule{}
|
|
||||||
states := r.Evaluate(context.Background(), obsWith(), sdk.CheckerOptions{})
|
|
||||||
if len(states) != 1 || states[0].Status != sdk.StatusUnknown {
|
|
||||||
t.Errorf("expected single Unknown state, got %+v", states)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,97 +0,0 @@
|
||||||
// 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 (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
sdk "git.happydns.org/checker-sdk-go/checker"
|
|
||||||
)
|
|
||||||
|
|
||||||
// rttRule evaluates the average round-trip time of each target against
|
|
||||||
// the configured warning/critical thresholds. Unreachable targets (no
|
|
||||||
// reply at all) are skipped; the reachability rule handles those.
|
|
||||||
type rttRule struct{}
|
|
||||||
|
|
||||||
func (r *rttRule) Name() string { return "ping.rtt" }
|
|
||||||
func (r *rttRule) Description() string {
|
|
||||||
return "Flags targets whose average round-trip time crosses the warning or critical threshold."
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *rttRule) ValidateOptions(opts sdk.CheckerOptions) error {
|
|
||||||
warn := sdk.GetFloatOption(opts, "warningRTT", 100)
|
|
||||||
crit := sdk.GetFloatOption(opts, "criticalRTT", 500)
|
|
||||||
if warn <= 0 {
|
|
||||||
return fmt.Errorf("warningRTT must be positive")
|
|
||||||
}
|
|
||||||
if crit <= warn {
|
|
||||||
return fmt.Errorf("criticalRTT (%v) must be greater than warningRTT (%v)", crit, warn)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *rttRule) Evaluate(ctx context.Context, obs sdk.ObservationGetter, opts sdk.CheckerOptions) []sdk.CheckState {
|
|
||||||
data, errSt := loadPingData(ctx, obs)
|
|
||||||
if errSt != nil {
|
|
||||||
return []sdk.CheckState{*errSt}
|
|
||||||
}
|
|
||||||
if len(data.Targets) == 0 {
|
|
||||||
return []sdk.CheckState{noTargetsState("ping.rtt.no_targets")}
|
|
||||||
}
|
|
||||||
|
|
||||||
warn := sdk.GetFloatOption(opts, "warningRTT", 100)
|
|
||||||
crit := sdk.GetFloatOption(opts, "criticalRTT", 500)
|
|
||||||
|
|
||||||
out := make([]sdk.CheckState, 0, len(data.Targets))
|
|
||||||
for _, t := range data.Targets {
|
|
||||||
if t.Received == 0 {
|
|
||||||
out = append(out, sdk.CheckState{
|
|
||||||
Status: sdk.StatusUnknown,
|
|
||||||
Subject: t.Address,
|
|
||||||
Message: "RTT not measurable (no replies).",
|
|
||||||
Code: "ping.rtt.no_replies",
|
|
||||||
Meta: map[string]any{"target": t},
|
|
||||||
})
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
state := sdk.CheckState{
|
|
||||||
Subject: t.Address,
|
|
||||||
Message: fmt.Sprintf("Average RTT %.1fms (warn=%.0fms, crit=%.0fms).", t.RTTAvg, warn, crit),
|
|
||||||
Meta: map[string]any{"target": t},
|
|
||||||
}
|
|
||||||
switch {
|
|
||||||
case t.RTTAvg >= crit:
|
|
||||||
state.Status = sdk.StatusCrit
|
|
||||||
state.Code = "ping.rtt.critical"
|
|
||||||
case t.RTTAvg >= warn:
|
|
||||||
state.Status = sdk.StatusWarn
|
|
||||||
state.Code = "ping.rtt.warning"
|
|
||||||
default:
|
|
||||||
state.Status = sdk.StatusOK
|
|
||||||
state.Code = "ping.rtt.ok"
|
|
||||||
}
|
|
||||||
out = append(out, state)
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
@ -1,79 +0,0 @@
|
||||||
// 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 (
|
|
||||||
"context"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
sdk "git.happydns.org/checker-sdk-go/checker"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestRTTValidateOptions(t *testing.T) {
|
|
||||||
r := &rttRule{}
|
|
||||||
cases := []struct {
|
|
||||||
name string
|
|
||||||
opts sdk.CheckerOptions
|
|
||||||
wantErr bool
|
|
||||||
}{
|
|
||||||
{"defaults", sdk.CheckerOptions{}, false},
|
|
||||||
{"valid", sdk.CheckerOptions{"warningRTT": 50.0, "criticalRTT": 200.0}, false},
|
|
||||||
{"warn zero", sdk.CheckerOptions{"warningRTT": 0.0, "criticalRTT": 100.0}, true},
|
|
||||||
{"crit negative", sdk.CheckerOptions{"warningRTT": 50.0, "criticalRTT": -1.0}, true},
|
|
||||||
{"crit equal warn", sdk.CheckerOptions{"warningRTT": 100.0, "criticalRTT": 100.0}, true},
|
|
||||||
}
|
|
||||||
for _, c := range cases {
|
|
||||||
t.Run(c.name, func(t *testing.T) {
|
|
||||||
err := r.ValidateOptions(c.opts)
|
|
||||||
if (err != nil) != c.wantErr {
|
|
||||||
t.Errorf("err=%v, wantErr=%v", err, c.wantErr)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRTTEvaluate(t *testing.T) {
|
|
||||||
r := &rttRule{}
|
|
||||||
ctx := context.Background()
|
|
||||||
opts := sdk.CheckerOptions{"warningRTT": 100.0, "criticalRTT": 500.0}
|
|
||||||
|
|
||||||
states := r.Evaluate(ctx, obsWith(
|
|
||||||
PingTargetResult{Address: "ok", RTTAvg: 50, Sent: 5, Received: 5},
|
|
||||||
PingTargetResult{Address: "warn", RTTAvg: 200, Sent: 5, Received: 5},
|
|
||||||
PingTargetResult{Address: "crit", RTTAvg: 600, Sent: 5, Received: 5},
|
|
||||||
PingTargetResult{Address: "dead", RTTAvg: 0, Sent: 5, Received: 0},
|
|
||||||
), opts)
|
|
||||||
|
|
||||||
if len(states) != 4 {
|
|
||||||
t.Fatalf("got %d states, want 4", len(states))
|
|
||||||
}
|
|
||||||
want := []sdk.Status{sdk.StatusOK, sdk.StatusWarn, sdk.StatusCrit, sdk.StatusUnknown}
|
|
||||||
wantCode := []string{"ping.rtt.ok", "ping.rtt.warning", "ping.rtt.critical", "ping.rtt.no_replies"}
|
|
||||||
for i, s := range states {
|
|
||||||
if s.Status != want[i] {
|
|
||||||
t.Errorf("state[%d] status = %v, want %v", i, s.Status, want[i])
|
|
||||||
}
|
|
||||||
if s.Code != wantCode[i] {
|
|
||||||
t.Errorf("state[%d] code = %q, want %q", i, s.Code, wantCode[i])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -29,15 +29,9 @@ type PingData struct {
|
||||||
Targets []PingTargetResult `json:"targets"`
|
Targets []PingTargetResult `json:"targets"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// PingTargetResult contains the ping statistics for a single target.
|
// PingTargetResult contains the ping statistics for a single IP address.
|
||||||
//
|
|
||||||
// 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 {
|
type PingTargetResult struct {
|
||||||
Address string `json:"address"`
|
Address string `json:"address"`
|
||||||
ResolvedIP string `json:"resolved_ip,omitempty"`
|
|
||||||
RTTMin float64 `json:"rtt_min"`
|
RTTMin float64 `json:"rtt_min"`
|
||||||
RTTAvg float64 `json:"rtt_avg"`
|
RTTAvg float64 `json:"rtt_avg"`
|
||||||
RTTMax float64 `json:"rtt_max"`
|
RTTMax float64 `json:"rtt_max"`
|
||||||
|
|
|
||||||
4
go.mod
4
go.mod
|
|
@ -3,9 +3,8 @@ module git.happydns.org/checker-ping
|
||||||
go 1.25.0
|
go 1.25.0
|
||||||
|
|
||||||
require (
|
require (
|
||||||
git.happydns.org/checker-sdk-go v1.5.0
|
git.happydns.org/checker-sdk-go v1.2.0
|
||||||
git.happydns.org/happyDomain v0.7.0
|
git.happydns.org/happyDomain v0.7.0
|
||||||
github.com/miekg/dns v1.1.72
|
|
||||||
github.com/prometheus-community/pro-bing v0.8.0
|
github.com/prometheus-community/pro-bing v0.8.0
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
@ -27,6 +26,7 @@ require (
|
||||||
github.com/klauspost/cpuid/v2 v2.3.0 // indirect
|
github.com/klauspost/cpuid/v2 v2.3.0 // indirect
|
||||||
github.com/leodido/go-urn v1.4.0 // indirect
|
github.com/leodido/go-urn v1.4.0 // indirect
|
||||||
github.com/mattn/go-isatty v0.0.20 // indirect
|
github.com/mattn/go-isatty v0.0.20 // indirect
|
||||||
|
github.com/miekg/dns v1.1.72 // indirect
|
||||||
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
|
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
|
||||||
github.com/modern-go/reflect2 v1.0.2 // indirect
|
github.com/modern-go/reflect2 v1.0.2 // indirect
|
||||||
github.com/pelletier/go-toml/v2 v2.2.4 // indirect
|
github.com/pelletier/go-toml/v2 v2.2.4 // indirect
|
||||||
|
|
|
||||||
4
go.sum
4
go.sum
|
|
@ -1,5 +1,5 @@
|
||||||
git.happydns.org/checker-sdk-go v1.5.0 h1:5uD5Cm6xJ+lwnhbJ09iCXGHbYS9zRh+Yh0NeBHkAPBY=
|
git.happydns.org/checker-sdk-go v1.2.0 h1:v4MpKAz0W3PwP+bxx3pya8w893sVH5xTD1of1cc0TV8=
|
||||||
git.happydns.org/checker-sdk-go v1.5.0/go.mod h1:aNAcfYFfbhvH9kJhE0Njp5GX0dQbxdRB0rJ0KvSC5nI=
|
git.happydns.org/checker-sdk-go v1.2.0/go.mod h1:aNAcfYFfbhvH9kJhE0Njp5GX0dQbxdRB0rJ0KvSC5nI=
|
||||||
git.happydns.org/happyDomain v0.7.0 h1:NV82/NbcSeRm0+IUZqaK3Vu9Ovl5+vv4AigUJZMdwws=
|
git.happydns.org/happyDomain v0.7.0 h1:NV82/NbcSeRm0+IUZqaK3Vu9Ovl5+vv4AigUJZMdwws=
|
||||||
git.happydns.org/happyDomain v0.7.0/go.mod h1:5tgkmqFE65kK359rY49V++49wgZ0gco+Gh9X6tbL+bY=
|
git.happydns.org/happyDomain v0.7.0/go.mod h1:5tgkmqFE65kK359rY49V++49wgZ0gco+Gh9X6tbL+bY=
|
||||||
github.com/bytedance/gopkg v0.1.3 h1:TPBSwH8RsouGCBcMBktLt1AymVo2TVsBVCY4b6TnZ/M=
|
github.com/bytedance/gopkg v0.1.3 h1:TPBSwH8RsouGCBcMBktLt1AymVo2TVsBVCY4b6TnZ/M=
|
||||||
|
|
|
||||||
6
main.go
6
main.go
|
|
@ -26,7 +26,7 @@ import (
|
||||||
"log"
|
"log"
|
||||||
|
|
||||||
ping "git.happydns.org/checker-ping/checker"
|
ping "git.happydns.org/checker-ping/checker"
|
||||||
"git.happydns.org/checker-sdk-go/checker/server"
|
sdk "git.happydns.org/checker-sdk-go/checker"
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
|
|
@ -47,8 +47,8 @@ func main() {
|
||||||
// CheckerDefinition.Version.
|
// CheckerDefinition.Version.
|
||||||
ping.Version = Version
|
ping.Version = Version
|
||||||
|
|
||||||
srv := server.New(ping.ProviderWithPrivileged(*privileged))
|
server := sdk.NewServer(ping.ProviderWithPrivileged(*privileged))
|
||||||
if err := srv.ListenAndServe(*listenAddr); err != nil {
|
if err := server.ListenAndServe(*listenAddr); err != nil {
|
||||||
log.Fatalf("server error: %v", err)
|
log.Fatalf("server error: %v", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,24 +1,3 @@
|
||||||
// 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/>.
|
|
||||||
|
|
||||||
// Command plugin is the happyDomain plugin entrypoint for the ping checker.
|
// Command plugin is the happyDomain plugin entrypoint for the ping checker.
|
||||||
//
|
//
|
||||||
// It is built as a Go plugin (`go build -buildmode=plugin`) and loaded at
|
// It is built as a Go plugin (`go build -buildmode=plugin`) and loaded at
|
||||||
|
|
@ -43,6 +22,5 @@ func NewCheckerPlugin() (*sdk.CheckerDefinition, sdk.ObservationProvider, error)
|
||||||
// Propagate the plugin's version to the checker package so it shows up
|
// Propagate the plugin's version to the checker package so it shows up
|
||||||
// in CheckerDefinition.Version.
|
// in CheckerDefinition.Version.
|
||||||
ping.Version = Version
|
ping.Version = Version
|
||||||
prvd := ping.Provider()
|
return ping.Definition(), ping.Provider(), nil
|
||||||
return prvd.(sdk.CheckerDefinitionProvider).Definition(), prvd, nil
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue