Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sch8ill/propmon
A Prometheus exporter that monitors Mysterium Network node service proposals
https://github.com/sch8ill/propmon
golang metrics mysteriumnetwork nats prometheus-exporter
Last synced: about 19 hours ago
JSON representation
A Prometheus exporter that monitors Mysterium Network node service proposals
- Host: GitHub
- URL: https://github.com/sch8ill/propmon
- Owner: Sch8ill
- License: mit
- Created: 2023-11-16T15:57:38.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2024-03-04T14:17:38.000Z (8 months ago)
- Last Synced: 2024-03-04T16:13:42.296Z (8 months ago)
- Topics: golang, metrics, mysteriumnetwork, nats, prometheus-exporter
- Language: Go
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# propmon
[](https://github.com/sch8ill/propmon/releases)
[](https://goreportcard.com/report/github.com/sch8ill/propmon)
---
`propmon` is a Prometheus metrics exporter designed to monitor service proposals within
the [Mysterium Network](https://mysterium.network). Each [node](https://github.com/mysteriumnetwork/node) in
the [Mysterium Network](https://mysterium.network) advertises its services by transmitting service proposals to a
message broker through [nats](https://github.com/nats-io).
The [discovery](https://github.com/mysteriumnetwork/discovery) service captures these service proposals and compiles
them into a list, which is then made accessible to Mysterium Network clients through
a [REST API](https://discovery.mysterium.network/api/v4/proposals).
Similar to the [discovery](https://github.com/mysteriumnetwork/discovery) service, `propmon` listens for incoming
service proposals. It stores these proposals and generates metrics related to them, which are exposed on
port [9500](http://localhost:9500/metrics).
A service proposal includes:
- Provider ID of the node
- Service type
- Approximate GEO-location of the node
- Access policies for the service
- Compatibility information
- ...
---
## Installation
### Docker
```bash
docker run -p 9500:9500 sch8ill/propmon:latest
```
### Build
Requires:
```
go >= 1.21
make
```
Build command:
```bash
make build
```
---
## Usage
### Prometheus config
Example `prometheus.yml` scrape config:
```yaml
scrape_configs:
- job_name: propmon
scrape_interval: 15s
static_configs:
- targets: [ "localhost:9500" ]
```
### Metrics
| name | description | labels | type |
|-------------------------------|-------------------------------------------|--------------------|---------|
| propmon_proposal_ping | Service Proposal ping | | counter |
| propmon_proposal_registered | Service Proposal registered | | counter |
| propmon_proposal_unregistered | Service Proposal unregistered | | counter |
| propmon_proposal_expired | Service Proposal expired | | counter |
| propmon_proposal_invalid | Service Proposal invalid | | counter |
| propmon_proposal_count | Service Proposal count | service_type | gauge |
| propmon_provider_count | Provider count | country, node_type | gauge |
| propmon_nats_bytes_rx | Number of bytes received by NATS listener | subject | counter |
### CLI flags
```
--broker-address value broker address to listen for proposals (default: "nats://broker.mysterium.network:4222")
--proposal-lifetime value lifetime of a proposal until it expires if not renewed (default: 3m10s)
--expiration-job-delay value delay between expiration job runs (default: 20s)
--metrics-address value address the prometheus metrics exporter listens on (default: ":9500")
--help, -h show help
```
## License
This package is licensed under the [MIT License](LICENSE).
---