yabeda-prometheus-mmap 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f0ebd6b2f081245c79f4d97b2e00e51897b26015bf96217f77236e3c0020279
-  data.tar.gz: 0f44b6533da9d8106ea693d932da4dccc38d9360a2a81af211bef93eb838e154
+  metadata.gz: 3a4b12a39360e1ca4b9f1d849bee55f6022f904f444197e3e11776d3c35d10e5
+  data.tar.gz: 443b04248da339a56b1e37476e52a11ac6a1240cd1216102e994142902304cf0
 SHA512:
-  metadata.gz: c73cb144636f784778ccde67f7f9f6f48d47544ca145a63c2425714fb76efe40940e4a4b9f593054eb4723699244310fdb567e3423ecebc55744695952b5976c
-  data.tar.gz: e2f9adf3f4ce17dbf4552a8922378b06ddda1a22ec4b987d8c0bdb5f5d0632e9c88083fd7daf81229e26cab7cfa528909fc6817a13d0635e4fb873153ddebe1c
+  metadata.gz: f72aa5a161e28a3a050a605ea39db45cd903fd5d24306a1fff778fffe829f304240b92e9e838258bbe9b1a90301dabc7f4c730f73f77845c5424116d87de0afb
+  data.tar.gz: 2f52032cc8f4dad25227d18a88184622a6b7d3c902a7bf823a189ef28791369473cd5e5dcbf6694bdcc0a7e14ba2e07518ede35e197e6d65ba10d634f3076986

data/README.md

@@ -1,8 +1,15 @@
-# Yabeda::Prometheus::Mmap
+<a href="https://amplifr.com/?utm_source=yabeda-prometheus-mmap">
+  <img width="100" height="140" align="right"
+    alt="Sponsored by Amplifr" src="https://amplifr-direct.s3-eu-west-1.amazonaws.com/social_images/image/37b580d9-3668-4005-8d5a-137de3a3e77c.png" />
+</a>
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yabeda/prometheus/mmap`. To experiment with that code, run `bin/console` for an interactive prompt.
+# Yabeda::[Prometheus]::Mmap
+
+
+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).
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -14,27 +21,57 @@ gem 'yabeda-prometheus-mmap'
 
 And then execute:
 
-    $ bundle install
+    $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install yabeda-prometheus-mmap
+ 1. Exporting from running web servers:
 
-## Usage
+    Place following in your `config.ru` _before_ running your application:
 
-TODO: Write usage instructions here
+    ```ruby
+    require 'yabeda/prometheus/mmap'
 
-## Development
+    use Yabeda::Prometheus::Exporter
+    ```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+    Metrics will be available on `/metrics` path (configured by `:path` option).
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+    Also you can mount it in Rails application routes as standalone Rack application.
 
-## Contributing
+ 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.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yabeda-prometheus-mmap.
+    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`).
+
+
+## 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.
 
 ## 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
+

data/lib/yabeda/prometheus/mmap/exporter.rb

@@ -16,7 +16,7 @@ module Yabeda
         class << self
           # Allows to use middleware as standalone rack application
           def call(env)
-            @app ||= new(NOT_FOUND_HANDLER, path: '/metrics')
+            @app ||= new(NOT_FOUND_HANDLER, path: '/')
             @app.call(env)
           end
 

data/lib/yabeda/prometheus/mmap/version.rb

@@ -3,7 +3,7 @@
 module Yabeda
   module Prometheus
     module Mmap
-      VERSION = '0.1.0'
+      VERSION = '0.1.1'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-prometheus-mmap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dmitry Salahutdinov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-20 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prometheus-client-mmap