https://github.com/samber/hyperping-exporter
Prometheus exporter for Hyperping.io
https://github.com/samber/hyperping-exporter
exporter go hyperping hyperping-exporter metrics monitor prometheus stats
Last synced: 11 months ago
JSON representation
Prometheus exporter for Hyperping.io
- Host: GitHub
- URL: https://github.com/samber/hyperping-exporter
- Owner: samber
- License: mit
- Created: 2024-03-13T00:05:54.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-19T00:19:37.000Z (almost 2 years ago)
- Last Synced: 2025-02-16T09:31:35.607Z (11 months ago)
- Topics: exporter, go, hyperping, hyperping-exporter, metrics, monitor, prometheus, stats
- Language: Go
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Hyperping Exporter
[](https://github.com/samber/hyperping-exporter/releases)
[](https://pkg.go.dev/github.com/samber/hyperping-exporter)
[](https://goreportcard.com/report/github.com/samber/hyperping-exporter)
[](https://codecov.io/gh/samber/hyperping-exporter)
[](https://github.com/samber/hyperping-exporter/graphs/contributors)
[](./LICENSE)
> A Prometheus Exporter for [Hyperping.io](https://hyperping.io)
## 🚀 Run
Using Docker:
```sh
docker run --rm -it -p 9312:9312 -e HYPERPING_TOKEN=xxxx samber/hyperping-exporter:v0.1.1
```
Or using a binary:
```sh
wget -O hyperping_exporter https://github.com/samber/hyperping-exporter/releases/download/v0.1.1/hyperping_exporter_0.1.1_linux_amd64
chmod +x hyperping_exporter
./hyperping_exporter --hyperping.token xxxx
```
## 💡 Usage
```sh
./hyperping_exporter
usage: hyperping_exporter --hyperping.token=HYPERPING.TOKEN []
Flags:
-h, --help Show context-sensitive help (also try --help-long and --help-man).
--hyperping.token Hyperping token ($HYPERPING_TOKEN)
--namespace="hyperping" Namespace for metrics ($HYPERPING_EXPORTER_NAMESPACE)
--web.listen-address=":9312" Address to listen on for web interface and telemetry. ($HYPERPING_EXPORTER_WEB_LISTEN_ADDRESS)
--web.telemetry-path="/metrics" Path under which to expose metrics. ($HYPERPING_EXPORTER_WEB_TELEMETRY_PATH)
--log.format="txt" Log format, valid options are txt and json ($HYPERPING_EXPORTER_LOG_FORMAT)
--version Show application version.
```
## 📐 Metrics
### Probe status
Up vs down.
```
# HELP hyperping_monitor_status Probe status (0==down, 1==up)
# TYPE hyperping_monitor_status gauge
hyperping_monitor_status{monitor_id="mon_oungee2XIewoht",name="Landing page",project_id="proj_iiY5oo2Hfiepee",protocol="http",url="https://screeb.app"} 0
hyperping_monitor_status{monitor_id="mon_op3eeNgutahcha",name="API",project_id="proj_qui9looPieT0Ku",protocol="http",url="https://api.screeb.app"} 1
```
### Probe active
Paused vs active.
```
# HELP hyperping_monitor_active Probe active (0==paused, 1==active)
# TYPE hyperping_monitor_active gauge
hyperping_monitor_active{monitor_id="mon_oungee2XIewoht",name="Landing page",project_id="proj_iiY5oo2Hfiepee",protocol="http",url="https://screeb.app"} 0
hyperping_monitor_active{monitor_id="mon_op3eeNgutahcha",name="API",project_id="proj_qui9looPieT0Ku",protocol="http",url="https://api.screeb.app"} 1
```
## 🤝 Contributing
- Ping me on Twitter [@samuelberthe](https://twitter.com/samuelberthe) (DMs, mentions, whatever :))
- Fork the [project](https://github.com/samber/hyperping-exporter)
- Fix [open issues](https://github.com/samber/hyperping-exporter/issues) or request new features
Don't hesitate ;)
```bash
# Install some dev dependencies
make tools
# Run tests
make test
# or
make watch-test
```
## 👤 Contributors
## 💫 Show your support
Give a ⭐️ if this project helped you!
[](https://github.com/sponsors/samber)
## 📝 License
Copyright © 2024 [Samuel Berthe](https://github.com/samber).
This project is [MIT](./LICENSE) licensed.