https://github.com/clivern/glove
🐺 Prometheus Exporter Boilerplate.
https://github.com/clivern/glove
prometheus prometheus-exporter
Last synced: 3 months ago
JSON representation
🐺 Prometheus Exporter Boilerplate.
- Host: GitHub
- URL: https://github.com/clivern/glove
- Owner: Clivern
- License: mit
- Created: 2022-01-16T11:34:04.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T09:32:30.000Z (over 1 year ago)
- Last Synced: 2024-09-17T12:08:12.470Z (over 1 year ago)
- Topics: prometheus, prometheus-exporter
- Language: Go
- Homepage:
- Size: 246 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Glove
Prometheus Exporter Boilerplate
## Documentation
### Linux Deployment
Download [the latest Glove binary](https://github.com/clivern/glove/releases). Make it executable from everywhere.
```zsh
$ export LATEST_VERSION=$(curl --silent "https://api.github.com/repos/clivern/glove/releases/latest" | jq '.tag_name' | sed -E 's/.*"([^"]+)".*/\1/' | tr -d v)
$ curl -sL https://github.com/clivern/glove/releases/download/v{$LATEST_VERSION}/glove_{$LATEST_VERSION}_Linux_x86_64.tar.gz | tar xz
```
Create the configs file `config.yml` from `config.dist.yml`. Something like the following:
```yaml
# App configs
app:
# App name
name: ${APP_NAME:-glove}
# Env mode (dev or prod)
mode: ${APP_MODE:-prod}
# HTTP port
port: ${API_PORT:-9253}
# Hostname
hostname: ${API_HOSTNAME:-127.0.0.1}
# TLS configs
tls:
status: ${API_TLS_STATUS:-off}
crt_path: ${API_TLS_PEMPATH:-cert/server.crt}
key_path: ${API_TLS_KEYPATH:-cert/server.key}
# Global timeout
timeout: ${API_TIMEOUT:-50}
# Log configs
log:
# Log level, it can be debug, info, warn, error, panic, fatal
level: ${LOG_LEVEL:-info}
# Output can be stdout or abs path to log file /var/logs/glove.log
output: ${LOG_OUTPUT:-/var/logs/glove.log}
# Format can be json
format: ${LOG_FORMAT:-json}
```
The run the `Glove` with `systemd`
```zsh
$ glove server -c /path/to/config.yml
```
## Versioning
For transparency into our release cycle and in striving to maintain backward compatibility, Glove is maintained under the [Semantic Versioning guidelines](https://semver.org/) and release process is predictable and business-friendly.
See the [Releases section of our GitHub project](https://github.com/Clivern/glove/releases) for changelogs for each release version of Glove. It contains summaries of the most noteworthy changes made in each release.
## Bug tracker
If you have any suggestions, bug reports, or annoyances please report them to our issue tracker at https://github.com/Clivern/glove/issues
## Security Issues
If you discover a security vulnerability within Glove, please send an email to [hello@clivern.com](mailto:hello@clivern.com)
## Contributing
We are an open source, community-driven project so please feel free to join us. see the [contributing guidelines](CONTRIBUTING.md) for more details.
## License
© 2022, Clivern. Released under [MIT License](https://opensource.org/licenses/mit-license.php).
**Glove** is authored and maintained by [@Clivern](http://github.com/Clivern).