Skip to content

Commit

Permalink
Add link to Chia blockchain repo
Browse files Browse the repository at this point in the history
  • Loading branch information
philippnormann committed Jan 15, 2022
1 parent b80079e commit 8f80799
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# chia-monitor [![discord](https://img.shields.io/discord/845771315118080020.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/K5KyD9mXDh)

A monitoring tool to collect all important metrics from your Chia farming node and connected harvesters. It can send you push notifications with regular status updates and will alert you in case something goes wrong or a proof is found. All metrics are exported to a [Prometheus](https://prometheus.io) compatible `/metrics` endpoint and a [Grafana](https://grafana.com/) dashboard is also provided:
A monitoring tool to collect all important metrics from your [Chia](https://github.com/Chia-Network/chia-blockchain) farming node and connected harvesters.

These metrics are collected from the Chia daemon via RPC and WebSocket interfaces and can also be used to send you push notifications with regular status updates, alert you if something goes wrong, a proof is found, or you receive payments to your farmer wallet.

All metrics are exported to a [Prometheus](https://github.com/prometheus/prometheus) compatible `/metrics` endpoint and a [Grafana](https://github.com/grafana/grafana) dashboard is also provided:

![grafana](.readme/grafana.png)

Expand Down Expand Up @@ -95,7 +99,7 @@ Your wallet received a new payment

## Metrics

The following statistics are collected from your local [Chia](https://chia.net) node using the [RPC](https://github.com/Chia-Network/chia-blockchain/wiki/RPC-Interfaces) and WebSocket APIs and are then exported via a [Prometheus](https://prometheus.io) compatible `/metrics` HTTP endpoint on the `exporter_port` from your `config.json`.
The following statistics are collected from your local [Chia](https://github.com/Chia-Network/chia-blockchain) node using the [RPC](https://github.com/Chia-Network/chia-blockchain/wiki/RPC-Interfaces) and WebSocket APIs and are then exported via a [Prometheus](https://github.com/prometheus/prometheus) compatible `/metrics` HTTP endpoint on the `exporter_port` from your `config.json`.

### Supported wallet metrics

Expand Down Expand Up @@ -213,6 +217,7 @@ pipenv run alembic upgrade head
```

4. Import (Overwrite) the Grafana dashboard using the ID `14544` or using the `grafana/dashboard.json`

## Usage

To use the tool, run the `monitor` module using `pipenv` from the `chia-monitor` directory
Expand Down

0 comments on commit 8f80799

Please sign in to comment.