emrb 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f15f9f402475d30026e70a8cce75b215795571fce2f9dcd4136bf1dba606531c
-  data.tar.gz: e067cdaeed6f55961b1575092eb568bda41ac599b076ae43f2e4d6dee6573ba6
+  metadata.gz: 28e29346fc4f54537087ca4b1ca4b179bc33f70266d4dc78de4cbdf5065dcd5a
+  data.tar.gz: eb0ef1dfb40da2d96604380880646b793837d8e5f1a8bd62146ff5ee1f24a3cf
 SHA512:
-  metadata.gz: 7c1b89985d30211a1d78c1243ad8ca36cd20147230c93ee19140e2ad79dbff05655c1ca973f56936544ca9f446bb550e1036acebfdf12457831de7783ca2fe8d
-  data.tar.gz: bb6f9946b27080c769f5a9d258e5385548d1a043aed15c1b4d1f97cf1bef95d271a75b9c95c5056a8196743ff3f9f9b7dee7e57f95de2f49db2cd81770b021a7
+  metadata.gz: 225ca18957ba3fc5cc5b26236a7fd0a38311a01bccae67ab3730ce053e8ef74e5fe7be1f589db9df1cc61833a051b5afdf6c179fab00872cdd88b3f51035cfa8
+  data.tar.gz: d999b2801431ba962d6ae0177f1d976b0568ce2c847248e2091f74c241f3645ff2c5fdfd68d7e3d4f7104e836bea988e6dc8d6aa6db197449449e8dcd1663e06

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.2)
+    emrb (0.1.4)
       prometheus-client (~> 4)
 
 GEM

data/example/push/Gemfile.lock

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

data/lib/emrb/instruments/instruments.rb

@@ -176,6 +176,19 @@ module Emrb
       # end
       def push(job, **) = State.push(job, **)
 
+      # Periodically invokes #push in a given frequency.
+      #
+      # job       - Job identifier
+      # frequency - Frequency, in seconds, in which #push will be called.
+      #
+      # Returns nothing.
+      def push_periodically(job, frequency = 10)
+        Thread.new do
+          sleep(frequency)
+          push(job)
+        end
+      end
+
       # Allows instruments to be declared with preset labels.
       #
       # labels - A hash containing the preset labels and values

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.2"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: emrb
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 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: