Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yabeda-rb/yabeda-prometheus-mmap
Yabeda Prometheus exporter based on prometheus-client-mmap
https://github.com/yabeda-rb/yabeda-prometheus-mmap
monitoring prometheus yabeda
Last synced: 27 days ago
JSON representation
Yabeda Prometheus exporter based on prometheus-client-mmap
- Host: GitHub
- URL: https://github.com/yabeda-rb/yabeda-prometheus-mmap
- Owner: yabeda-rb
- License: mit
- Created: 2020-03-19T20:55:11.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-24T22:39:45.000Z (12 months ago)
- Last Synced: 2024-05-10T22:02:12.014Z (8 months ago)
- Topics: monitoring, prometheus, yabeda
- Language: Ruby
- Size: 49.8 KB
- Stars: 14
- Watchers: 4
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 
Adapter for easy exporting your collected metrics from your application to the [Prometheus]!
It is based on [Prometheus Ruby Mmap Client](https://gitlab.com/gitlab-org/prometheus-client-mmap), that uses mmap'ed files to share metrics from multiple processes.
This allows efficient metrics processing for Ruby web apps running in multiprocess setups like Unicorn or Puma (clustered mode).
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'yabeda-prometheus-mmap'
```
And then execute:
$ bundle
## Usage
1. Exporting from running web servers:
Place following in your `config.ru` _before_ running your application:
```ruby
require 'yabeda/prometheus/mmap'
use Yabeda::Prometheus::Exporter
```
Metrics will be available on `/metrics` path (configured by `:path` option).
Also you can mount it in Rails application routes as standalone Rack application.
2. Run web-server from long-running processes (delayed jobs, …):
```ruby
require 'yabeda/prometheus/mmap'
Yabeda::Prometheus::Exporter.start_metrics_server!
```
WEBrick will be launched in separate thread and will serve metrics on `/metrics` path.
See [yabeda-sidekiq] for example.
Listening address is configured via `PROMETHEUS_EXPORTER_BIND` env variable (default is `0.0.0.0`).
Port is configured by `PROMETHEUS_EXPORTER_PORT` or `PORT` variables (default is `9394`).
## Debugging metrics
- Time of already collected metrics rendering in response for Prometheus: `yabeda_prometheus_mmap_render_duration`.
These are only enabled in debug mode. See [Yabeda debugging metrics](https://github.com/yabeda-rb/yabeda#debugging-metrics) on how to enable it (e.g. by specifying `YABEDA_DEBUG=true` in your environment variables).
## Development with Docker
Get local development environment working and tests running is very easy with docker-compose:
```bash
docker-compose run app bundle
docker-compose run app bundle exec rspec
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/yabeda-rb/yabeda-prometheus-mmap.
### Releasing
1. Bump version number in `lib/yabeda/prometheus/mmap/version.rb`
In case of pre-releases keep in mind [rubygems/rubygems#3086](https://github.com/rubygems/rubygems/issues/3086) and check version with command like `Gem::Version.new(Yabeda::Prometheus::Mmap::VERSION).to_s`
2. Fill `CHANGELOG.md` with missing changes, add header with version and date.
3. Make a commit:
```sh
git add lib/yabeda/prometheus/mmap/version.rb CHANGELOG.md
version=$(ruby -r ./lib/yabeda/prometheus/mmap/version.rb -e "puts Gem::Version.new(Yabeda::Prometheus::Mmap::VERSION)")
git commit --message="${version}: " --edit
```
4. Create annotated tag:
```sh
git tag v${version} --annotate --message="${version}: " --edit --sign
```
5. Fill version name into subject line and (optionally) some description (list of changes will be taken from changelog and appended automatically)
6. Push it:
```sh
git push --follow-tags
```
7. GitHub Actions will create a new release, build and push gem into RubyGems! You're done!
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
[Prometheus]: https://prometheus.io/ "Open-source monitoring solution"
[yabeda-sidekiq]: https://github.com/yabeda-rb/yabeda-sidekiq