https://github.com/cafebazaar/epimetheus
Epimetheus is a lightweight wrpper around Prometheus Go client and Statsd Go client which makes measuring communication, functions, background jobs, etc. easier.
https://github.com/cafebazaar/epimetheus
golang monitoring prometheus statsd
Last synced: 2 months ago
JSON representation
Epimetheus is a lightweight wrpper around Prometheus Go client and Statsd Go client which makes measuring communication, functions, background jobs, etc. easier.
- Host: GitHub
- URL: https://github.com/cafebazaar/epimetheus
- Owner: cafebazaar
- License: mit
- Created: 2019-12-07T11:51:05.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-08-17T08:32:45.000Z (almost 2 years ago)
- Last Synced: 2025-03-26T18:06:28.103Z (3 months ago)
- Topics: golang, monitoring, prometheus, statsd
- Language: Go
- Homepage:
- Size: 61.5 KB
- Stars: 11
- Watchers: 7
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Epimetheus
Epimetheus is a lightweight wrpper around [Prometheus Go client](https://github.com/prometheus/client_golang) and [Statsd Go client](https://github.com/cactus/go-statsd-client) which makes measuring communication, functions, background jobs, etc. easier, simultaneously with both Prometheus and Statsd.
## Getting Started
### Installing
```console
go get -u github.com/cafebazaar/epimetheus
```
### Initialize server
```go
epimetheusServer := epimetheus.NewEpimetheusServer(config)
go epimetheusServer.Listen()
```
### Predefined metrics
```go
epi := epimetheus.NewEpimetheus(config)
commTimer := epi.CommTimer
go epimetheusServer.Listen()
```
### Measuring duration and count
```go
epi := epimetheus.NewEpimetheus(config)
timerWithCounter := epi.NewTimerWithCounter("req1", string[]{"label1"})
rtc := timerWithCounter.Start()
// Do some work here
rtc.Done("dispatch")
```
### Measuring duration
```go
epi := epimetheus.NewEpimetheus(config)
timer := epi.NewTimer("req1", string[]{"label1"})
t := timer.Start()
// Do some work here
t.Done("dispatch")
```
### Measuring count
```go
epi := epimetheus.NewEpimetheus(config)
counter := epi.NewCounter("req1", string[]{"label1"})
// Do some work here
c.Inc("dispatch")
```
## Configuration
Epimetheus uses Viper as it's config engine. Template should be something like this:
```yaml
stats:
prometheus:
enabled: true
port: 1234
statsd:
enabled: true
port: 5678
host: "w.x.y.z"
namespace: search
system-name: octopus
```
## Documentation
Documents are available at [https://godoc.org/github.com/cafebazaar/epimetheus](https://godoc.org/github.com/cafebazaar/epimetheus)
## Built With
* [Prometheus Go clinet](https://github.com/prometheus/client_golang) - The underlying library for Prometheus
* [Statsd Go client](https://github.com/cactus/go-statsd-client) - The underlying library for Statsd
## Contributing
Please read [CONTRIBUTING.md](https://github.com/cafebazaar/epimetheus/blob/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/cafebazaar/epimetheus/tags).
## Roadmap
- Improve documentation
- Add tests
## Authors
* **Ramtin Rostami** - *Initial work* - [rrostami](https://github.com/rrostami)
* **Pedram Teymoori** - *Initial work* - [pedramteymoori](https://github.com/pedramteymoori)
* **Parsa abdollahi** - *Initial work* - []()
See also the list of [contributors](https://github.com/cafebazaar/epimetheus/graphs/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
* [Sepehr nematollahi](https://www.behance.net/sseeppeehhrr) Epimetheus typography designer
Made with ❤ in Cafebazaar search