emrb 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6e20fbc173d54e5dee120c775aa0e7c151c24c1522ca31f7fc1fe5836efaf9f
-  data.tar.gz: e372fbfef1ffe52102c001cc67a48e04c20e2ffc1eae7d0544f98dec19721d4f
+  metadata.gz: bfc0b3aabe0d926c2a7c7ef914fbbf2c064bf3db8a27aefa68f4bd348d6d3d43
+  data.tar.gz: 9d689ec83548b4ed363f5872779b50069e42d70e3f34028074b5eaaab1d27de0
 SHA512:
-  metadata.gz: d318b59fd1d34d7b56100827935318c890840a1c4277ae79ba88e43f882ca6bc8e2c0d692d176b3c0e244777a76e22d6ef1d1d4944d5dce5d036a236734403c6
-  data.tar.gz: 04f4decea7589c1af30961ab387c2fb99fab85cb3de1cdfc6db24947a013e37b303be7baad099d83d8a802d7e5549ac32881ee8a50c9c571a5b2403bb2f420a1
+  metadata.gz: 2b25cede10a5a9baec6060076ccbd0d7b7b7ef3839d2ba6b0f8a97c1f1b5b915b2516b61bd3a45257f692ea3a8e4406e8438e993d7ab48aeb165f14130213bd9
+  data.tar.gz: 24baf13019ce92585d581578404c532a4e44b2d89471339e5bdd51e2fdc90af70076aedf697ba59377f6c8094c159611061e4f58965f1ee7924a65b7ed672d3d

data/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.{rb,yml,yaml,jbuilder}]
+charset = utf-8
+indent_style = space
+indent_size = 2

data/.rubocop.yml

@@ -29,3 +29,12 @@ Layout/ArgumentAlignment:
 
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
+
+Metrics/MethodLength:
+  Exclude:
+    - lib/emrb/server.rb
+
+Style/Documentation:
+  Exclude:
+    - lib/emrb/server.rb
+    - spec/**/*

data/compose.yaml

@@ -0,0 +1,10 @@
+services:
+  emrb:
+    image: ruby:3
+    volumes:
+      - ".:/app"
+      - gems:/usr/local/bundle
+    working_dir: "/app"
+
+volumes:
+  gems:

data/example/http/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    emrb (0.1.1)
+    emrb (0.1.3)
       prometheus-client (~> 4)
 
 GEM

data/example/push/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    emrb (0.1.1)
+    emrb (0.1.3)
       prometheus-client (~> 4)
 
 GEM

data/lib/emrb/instruments/instruments.rb

@@ -70,7 +70,7 @@ module Emrb
       # For a full list of options and functionalities for creating and utilizing a Gauge,
       # refer to the Prometheus client documentation:
       # https://github.com/prometheus/client_ruby?tab=readme-ov-file#gauge
-      def gauge(identifier, docs, **, &)
+      def gauge(identifier, docs = "...", **, &)
         check_identifier!(identifier)
         opts = block_opts(**, &)
         State.gauge(id_for(identifier), docs, **opts).tap do |g|
@@ -108,7 +108,7 @@ module Emrb
       # For all available options and functionalities for creating and utilizing a Histogram,
       # refer to the Prometheus client documentation:
       # https://github.com/prometheus/client_ruby?tab=readme-ov-file#histogram
-      def histogram(identifier, docs, **, &)
+      def histogram(identifier, docs = "...", **, &)
         check_identifier!(identifier)
         opts = block_opts(**, &)
         State.histogram(id_for(identifier), docs, **opts).tap do |h|
@@ -139,7 +139,7 @@ module Emrb
       # For a complete list of options and functionalities for creating and utilizing a Summary,
       # refer to the Prometheus client documentation:
       # https://github.com/prometheus/client_ruby?tab=readme-ov-file#summary
-      def summary(identifier, docs, **, &)
+      def summary(identifier, docs = "...", **, &)
         check_identifier!(identifier)
         opts = block_opts(**, &)
         State.summary(id_for(identifier), docs, **opts).tap do |s|

data/lib/emrb/server.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+begin
+  require "sinatra/base"
+rescue LoadError
+  raise(<<~MESSAGE)
+    ERROR: You attempted to use emrb/server, but sinatra is not available.
+    Add sinatra to your application's dependencies before using this feature.
+  MESSAGE
+end
+
+begin
+  require "puma"
+rescue LoadError
+  raise(<<~MESSAGE)
+    ERROR: You attempted to use emrb/server, but puma is not available.
+    Add puma to your application's dependencies before using this feature.
+  MESSAGE
+end
+
+module Emrb
+  # expose_metrics starts a simple sinatra server on a given port and
+  # address that exposes a single /metrics endpoint for scrapers to access.
+  # It is a courtesy utility for applications not exposing an HTTP server
+  # by default.
+  #
+  # To use this method, the application calling it must bundle both sinatra
+  # and puma gems.
+  #
+  # port    - Port to expose the server
+  # address - Address to expose the server. Defaults to `0.0.0.0`.
+  #
+  # Returns nothing.
+  def self.expose_metrics(port, address = "0.0.0.0")
+    return if @metrics_app
+
+    metrics_app = Class.new(Sinatra::Base) do
+      set :bind, address
+      set :port, port
+      use Emrb::Exporter
+      use Rack::Deflater
+    end
+
+    @metrics_app = metrics_app.new
+    puma_server = Puma::Server.new(metrics_app)
+    puma_server.add_tcp_listener(address, port)
+    @puma_server = puma_server
+    @metrics_thr = Thread.new { puma_server.run }
+  end
+
+  # Stops the metrics server previously started by #expose_metrics.
+  #
+  # Returns nothing.
+  def self.stop_exposing_metrics
+    return unless @metrics_app
+
+    @puma_server.stop(true)
+    @metrics_thr.join
+  end
+end

data/lib/emrb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Emrb
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: emrb
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Felipe Mariotti
@@ -33,11 +33,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".rspec"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - README.md
 - Rakefile
+- compose.yaml
 - example/http/Gemfile
 - example/http/Gemfile.lock
 - example/http/main.rb
@@ -52,6 +54,7 @@ files:
 - lib/emrb/instruments/exporters.rb
 - lib/emrb/instruments/instruments.rb
 - lib/emrb/instruments/state.rb
+- lib/emrb/server.rb
 - lib/emrb/version.rb
 homepage: https://github.com/ofeefo/emrb
 licenses: