https://github.com/bleemeo/glouton
Monitoring agent for servers, containers, and applications 🔬
https://github.com/bleemeo/glouton
dashboard docker golang graphite kubernetes metrics monitoring observability prometheus prometheus-metrics statsd
Last synced: 5 months ago
JSON representation
Monitoring agent for servers, containers, and applications 🔬
- Host: GitHub
- URL: https://github.com/bleemeo/glouton
- Owner: bleemeo
- License: apache-2.0
- Created: 2019-11-03T09:23:13.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T14:20:56.000Z (6 months ago)
- Last Synced: 2024-10-25T17:56:02.089Z (6 months ago)
- Topics: dashboard, docker, golang, graphite, kubernetes, metrics, monitoring, observability, prometheus, prometheus-metrics, statsd
- Language: Go
- Homepage: https://bleemeo.com/glouton
- Size: 12.5 MB
- Stars: 42
- Watchers: 7
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://goreportcard.com/report/github.com/bleemeo/glouton)
[](https://github.com/bleemeo/glouton/blob/master/LICENSE)
[](https://hub.docker.com/r/bleemeo/glouton/tags)
[](https://hub.docker.com/r/bleemeo/glouton)
**Glouton** is a monitoring agent that makes observing your infrastructure easy. Glouton retrieves metrics from **node_exporter** and multiple **telegraf inputs** and expose them through a **Prometheus endpoint** and a **dashboard**. It also automatically discovers your [services](#automatically-discovered-services) to retrieve relevant metrics.
Glouton is the agent used in the **Bleemeo cloud monitoring solution**. Deploying a **robust, scalable monitoring solution** can be time consuming. At Bleemeo, we focus on making users life **easier**. Check out the solution we offer on our [website](https://bleemeo.com) and try it now for free!
## Features
- [**Automatic discovery and configuration of services**](#automatically-discovered-services) to generate checks and metrics
- Can be used as the main **[Prometheus endpoint](#metrics-endpoint)** for another scrapper
- Support **[Nagios checks](https://go.bleemeo.com/l/custom-service-check), [NRPE](https://go.bleemeo.com/l/agent-configuration-nagios-nrpe) and [StatsD](https://go.bleemeo.com/l/doc-statsd)** metrics ingester
- **Kubernetes native:** create metrics and checks for pods
- Monitor your printers and network devices with [**SNMP**](https://go.bleemeo.com/l/network-monitoring-installation)
- **[JMX support](https://go.bleemeo.com/l/java-monitoring)** to monitor your Java applications.
- Integrated **web dashboard**
- Support [pushing metrics](#mqtt) to an external **[MQTT](https://mqtt.org/) broker**
### Automatically discovered services
Glouton automatically detects and generates metrics for your services. Supported services include **Apache**, **Cassandra**, **Redis**, **Elasticsearch**, **Nginx**, **PostgreSQL**, and many others. The full list of services and generated metrics can be found [here](https://go.bleemeo.com/l/services-metrics).
### Metrics endpoint
A metrics endpoint is available on port http://localhost:8015/metrics by default (this can be configured [here](https://go.bleemeo.com/l/agent-configuration-web-server)). This endpoint can be scrapped by Prometheus for example to retrieve the metrics and show them in Grafana.
A docker compose file is available to quickly setup a full monitoring stack. It includes Grafana, Glouton and a Prometheus configured to scrap Glouton's metrics endpoint.
```sh
# For Linux
(cd examples/prometheus; docker-compose up -d)
# For MacOS
(cd examples/prometheus_mac; docker-compose up -d)
```
Then go to the Grafana dashboard at http://localhost:3000/d/83ceCuenk/, and log
in with the user "admin" and the password "password".
### Push metrics to MQTT
Glouton can periodically push metrics to an external MQTT broker.
A docker compose file is available to show a working monitoring setup with a Glouton pushing points
to MQTT. [SquirrelDB Ingestor](https://github.com/bleemeo/squirreldb-ingestor) is used to receive the metrics from MQTT and to write them to
[SquirrelDB](https://github.com/bleemeo/squirreldb), a scalable timeseries database. This setup
uses [NATS](https://nats.io/) as the broker, any other broker will work but we prefer NATS for its scalability.
```sh
(cd examples/mqtt; docker-compose up -d)
```
Then go to the Grafana dashboard at http://localhost:3000/d/83ceCuenk/, and log
in with the user "admin" and the password "password". You might have to wait a
little before seeing data on the graph.
More details are available on [SquirrelDB Ingestor](https://github.com/bleemeo/squirreldb-ingestor) on how to use authenticated MQTT
connections and how this setup can be scaled for high availability.
You can use your own ingestor if you want, the messages sent to MQTT are encoded in JSON and
compressed with zlib. Glouton sends its messages to the topic `v1/agent/fqdn/data` with `fqdn`
replaced by the host FQDN (`.` are replaced by `,` in the FQDN because NATS doesn't support `.`
in MQTT topics). Here is an example of a MQTT message:
```json
[
{
"labels_text": "__name__=cpu_used",
"time_ms": 1665479613948,
"value": 46.8,
}
]
```
## Install
Glouton can be installed with Docker, Kubernetes, on Windows or as a native Linux package.
If you use Glouton with the Bleemeo solution, you should follow the [documentation](https://go.bleemeo.com/l/agent-installation).
### Docker
A docker image is provided to install Glouton easily.
```sh
docker run -d --name="bleemeo-agent" \
-v /var/lib/glouton:/var/lib/glouton -v /var/run/docker.sock:/var/run/docker.sock -v /:/hostroot:ro \
-e GLOUTON_BLEEMEO_ENABLE='false' --pid=host --net=host \
--cap-add SYS_PTRACE --cap-add SYS_ADMIN bleemeo/bleemeo-agent
```
### Docker compose
The docker compose will run Glouton with jmxtrans (a JMX proxy which queries the JVM over JMX and sends
metrics over the graphite protocol to Glouton).
To use jmxtrans, two containers will be run, one with Glouton and one with jmxtrans and a shared volume between
them will allow Glouton to write the jmxtrans configuration file.
```sh
docker-compose up -d
```
### Other platforms
If you are not a Bleemeo user, disable the Bleemeo connector in `/etc/glouton/conf.d/30-install.conf`:
```yaml
bleemeo:
enable: false
```
To install Glouton as a native package on Linux, or to install it on Windows or Kubernetes, check out the [documentation](https://go.bleemeo.com/l/agent-installation). Note that this documentation is made for users of the Bleemeo Cloud solution, but it also works without a Bleemeo account if you skip adding the credentials to the config.
## Configuration
The full configuration file with all available options is available [here](https://go.bleemeo.com/l/agent-configuration).
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md).