README
¶
Pinger is an uptime and status monitoring application. It is an open-source implementation of platforms used to create status pages. Unlike other alternatives, Pinger can be deployed to create a standalone status page from a config file as well as a complete platform to manage users, checks, pages, alerts, etc.
Documentation
All the documentation is available here.
Contributing
Pinger is being actively developed. Head over to the Contribution section of the documentation for more details on how to set up and hack on the project.
License
Pinger, all the source code, is released under the MIT License.
Credits
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd implements all the commands for the pinger components.
|
Package cmd implements all the commands for the pinger components. |
|
pinger
Command pinger is used to start the app-server, central-server or the agent to execute checks.
|
Command pinger is used to start the app-server, central-server or the agent to execute checks. |
|
pkg
|
|
|
alerter
Package alerter defines the Alerter interface to send alerts whenever a check fails or succeed.
|
Package alerter defines the Alerter interface to send alerts whenever a check fails or succeed. |
|
alerter/discord
Package discord implements the slack alerter.
|
Package discord implements the slack alerter. |
|
alerter/mail
Package mail implements the mail alerter.
|
Package mail implements the mail alerter. |
|
alerter/slack
Package slack implements the slack alerter.
|
Package slack implements the slack alerter. |
|
checker
Package checker implements the checkers and probers for the various protocols.
|
Package checker implements the checkers and probers for the various protocols. |
|
checker/dns
Package dns implements the DNS checker and prober.
|
Package dns implements the DNS checker and prober. |
|
checker/http
Package http implements the HTTP checker and prober.
|
Package http implements the HTTP checker and prober. |
|
checker/icmp
Package icmp implements the ICMP checker and prober.
|
Package icmp implements the ICMP checker and prober. |
|
checker/tcp
Package tcp implements the TCP checker and prober.
|
Package tcp implements the TCP checker and prober. |
|
checker/udp
Package udp implements the UDP checker and prober.
|
Package udp implements the UDP checker and prober. |
|
checker/ws
Package ws implements the WS checker and prober.
|
Package ws implements the WS checker and prober. |
|
components/agent
Package agent runs a manager that runs various checks inside controllers.
|
Package agent runs a manager that runs various checks inside controllers. |
|
components/agent/proto
Package proto contains the compiled protobuf files.
|
Package proto contains the compiled protobuf files. |
|
components/app
Package app defines the app server which is the interface for interacting with the app users.
|
Package app defines the app server which is the interface for interacting with the app users. |
|
components/central
Package central implements the central API server for the application.
|
Package central implements the central API server for the application. |
|
config
Package config implements various config structs required in the application.
|
Package config implements various config structs required in the application. |
|
config/configfile
Package configfile contains the config structures for the components which are to be represented by a config file.
|
Package configfile contains the config structures for the components which are to be represented by a config file. |
|
database
Package database contains utilities to connect to the default Postgres (+ Timescale) database.
|
Package database contains utilities to connect to the default Postgres (+ Timescale) database. |
|
exporter
Package exporter defines a metrics exporter interface that is used by an agent to export metrics into the desired metrics provider.
|
Package exporter defines a metrics exporter interface that is used by an agent to export metrics into the desired metrics provider. |
|
exporter/influxdb
Package influxdb implements the influxdb exporter.
|
Package influxdb implements the influxdb exporter. |
|
exporter/log
Package log implements the log metrics exporter.
|
Package log implements the log metrics exporter. |
|
exporter/timescale
Package timescale implements the timescale metrics exporter.
|
Package timescale implements the timescale metrics exporter. |
|
oauther
Package oauther defines the way to authenticate the app using third-party OAuth2 services.
|
Package oauther defines the way to authenticate the app using third-party OAuth2 services. |
|
plugins
Package plugins contains all the standard plugins which includes all the alerters, exporters, checkers, and oauthers.
|
Package plugins contains all the standard plugins which includes all the alerters, exporters, checkers, and oauthers. |
|
util/appcontext
Package appcontext implements the app context.
|
Package appcontext implements the app context. |
|
util/controller
Package controller implements controller and manager.
|
Package controller implements controller and manager. |
|
util/httpserver
Package httpserver implements some utilities for HTTP servers.
|
Package httpserver implements some utilities for HTTP servers. |
|
util/jwt
Package jwt implements the JavaScript Web Token that can be used for authentication of users.
|
Package jwt implements the JavaScript Web Token that can be used for authentication of users. |
|
util/static
Package static includes the blob for generated files that lie in `static` directory of the project and other utilities to access them.
|
Package static includes the blob for generated files that lie in `static` directory of the project and other utilities to access them. |
Click to show internal directories.
Click to hide internal directories.