README
¶
Panto
Develop 
Panto is a platform for monitoring your infrastructure, servers and applications in production. Agents collect metrics about your systems in real time, and report their health and performance to the server. The server stores metrics, evaluates the state according to user-defined rules, and, in case the state is considered dysfunctional, dispatches alerts to your teams.
Downloading Panto
Pre-build panto binaries (linux/x86_64 only) can be downloaded directly from the downloads page.
Building Panto from source
After installing the prerequisites, clone the repository and run make from the repository root. The built executables will be in the bin directory. The built web client will be in the web/dist directory.
``shell git clone https://gitlab.com/pantomath-io/panto cd panto make
Detailed build instructions can be found [here](doc/BUILD.md).
## Running Panto
### Server
The Panto server can be run by creating a configuration file ([example](conf/panto.yaml)) in `/etc/panto/panto.yaml` and running the executable:
```shell
panto
Web client
The web client is a static site served with Caddy. After building Panto (see below), cd to the web directory and run the server:
cd web
caddy
Agent
The Panto agent should be run from the targets you want to monitor. Download the agent binary from the downloads page, create a configuration file (example), and run:
panto-agent
Detailed configuration file and command-line options can be found here
Docker
Docker images are available for the panto agent and server. See the Panto registry. Detailed documentation here.
Documentation
See the official documentation site.
License
Copyright 2017-18 Pantomath SAS
The Panto source code is licensed under the Apache License, Version 2.0.
By contributing to Pantomath SAS, You accept and agree to the following terms and conditions for Your present and future Contributions submitted to Pantomath SAS. Except for the license granted herein to Pantomath SAS and recipients of software distributed by Pantomath SAS, You reserve all right, title, and interest in and to Your Contributions. All Contributions are subject to the following Developer Certificate of Origin and License terms.
All Documentation content that resides under the docs directory of this repository is licensed under Creative Commons: CC BY-SA 4.0.
Directories
¶
| Path | Synopsis |
|---|---|
|
probe
Package probe contains everything to register, schedule and run probes, as well as the default set of probes bundled into Panto <TODO> Conceptual documentation about the scheduler <TODO> Conceptual documentation about the registry
|
Package probe contains everything to register, schedule and run probes, as well as the default set of probes bundled into Panto <TODO> Conceptual documentation about the scheduler <TODO> Conceptual documentation about the registry |
|
Package api is a reverse proxy.
|
Package api is a reverse proxy. |
|
cmd
|
|
|
panto-ctl/ask
Package ask collects information from the user through the command line in a Q&A style.
|
Package ask collects information from the user through the command line in a Q&A style. |
|
docs
|
|
|
site-docs/generate_config_doc
This is a helper to turn configurations into markdown for the documentation
|
This is a helper to turn configurations into markdown for the documentation |
|
Package server manages the gRPC service and defines the protobuf services and message
|
Package server manages the gRPC service and defines the protobuf services and message |
|
datapipe
Package datapipe handles the processing of results from the agents' probes.
|
Package datapipe handles the processing of results from the agents' probes. |
|
dbconf
Package dbconf manages everything related to the SQL database.
|
Package dbconf manages everything related to the SQL database. |
|
services
Package services manages "service discovery".
|
Package services manages "service discovery". |
|
tsdb
Package tsdb manages everything related to the time-series database.
|
Package tsdb manages everything related to the time-series database. |
|
Package util contains utility functions for Panto.
|
Package util contains utility functions for Panto. |