prometheus_exporter 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e93d3054e02dcc5bc4dc87df3be0b87ce3715850d4d116465f31ee525bb9c9f6
-  data.tar.gz: 681a91ab3490d12b095b5bde5a9eb303202e5c6b688cf57afe38752e49b2d9d4
+  metadata.gz: b60596255e84ca5aedae095d4ae7dda21f1c324e49a495e73e5f8e8a6adb3472
+  data.tar.gz: 990f03708492b5a2b5d13cf6a9bf67e091bdf62c819b1a559a0a240e6d9660bc
 SHA512:
-  metadata.gz: b4b875a1d7799aab1ec0c6ec69570a070a730774cd58cd7a61e54d19bf4f327ddf0f47e6fa10e33084b86fbdcbd407a0e0e715bb190f9bf412b59ce17b9963dd
-  data.tar.gz: 1face6bafbf0da750d2b88f3d5ed010cb136fad3da776928f7a327db20cc81fd972208f7cbfeb298dd72492489a8838c76429cbe448b87d478dfff79292c2f00
+  metadata.gz: d914be65e9857dcf5173e03a8fd230d0a2004aea8cf454fd1671229c856730ee72a9793624eddcf01ee561768d228e9e2e06eddd1a72629726d1dc994f34614b
+  data.tar.gz: 6a05a048eaa75641b749761ed823be1aa694e83d3c2f0d35e860e9237dd0f82569dc31c4c3d0e24293b10d1dcd5d36f16d893348c620f21efae9c16596b29b3c

data/README.md

@@ -56,10 +56,20 @@ Simplest way of consuming Prometheus exporter is in a single process mode.
 ```ruby
 require 'prometheus_exporter/server'
 
+# client allows instrumentation to send info to server
+require 'prometheus_exporter/client'
+require 'prometheus_exporter/instrumentation'
+
 # port is the port that will provide the /metrics route
 server = PrometheusExporter::Server::WebServer.new port: 12345
 server.start
 
+# wire up a default local client
+PrometheusExporter::Client.default = PrometheusExporter::LocalClient.new(collector: server.collector)
+
+# this ensures basic process instrumentation metrics are added such as RSS and Ruby metrics
+PrometheusExporter::Instrumentation::Process.start
+
 gauge = PrometheusExporter::Metric::Gauge.new("rss", "used RSS for process")
 counter = PrometheusExporter::Metric::Counter.new("web_requests", "number of web requests")
 summary = PrometheusExporter::Metric::Summary.new("page_load_time", "time it took to load page")

data/lib/prometheus_exporter/client.rb

@@ -3,197 +3,213 @@
 require 'socket'
 require 'thread'
 
-class PrometheusExporter::Client
+module PrometheusExporter
+
+  class Client
+    class RemoteMetric
+      def initialize(name:, help:, type:, client:)
+        @name = name
+        @help = help
+        @client = client
+        @type = type
+      end
 
-  class RemoteMetric
-    def initialize(name:, help:, type:, client:)
-      @name = name
-      @help = help
-      @client = client
-      @type = type
-    end
+      def standard_values(value, keys, prometheus_exporter_action = nil)
+        values = {
+          type: @type,
+          help: @help,
+          name: @name,
+          keys: keys,
+          value: value
+        }
+        values[:prometheus_exporter_action] = prometheus_exporter_action if prometheus_exporter_action
+        values
+      end
 
-    def standard_values(value, keys, prometheus_exporter_action = nil)
-      values = {
-        type: @type,
-        help: @help,
-        name: @name,
-        keys: keys,
-        value: value
-      }
-      values[:prometheus_exporter_action] = prometheus_exporter_action if prometheus_exporter_action
-      values
-    end
+      def observe(value = 1, keys = nil)
+        @client.send_json(standard_values(value, keys))
+      end
+
+      def increment(keys = nil, value = 1)
+        @client.send_json(standard_values(value, keys, :increment))
+      end
+
+      def decrement(keys = nil, value = 1)
+        @client.send_json(standard_values(value, keys, :decrement))
+      end
 
-    def observe(value = 1, keys = nil)
-      @client.send_json(standard_values(value, keys))
     end
 
-    def increment(keys = nil, value = 1)
-      @client.send_json(standard_values(value, keys, :increment))
+    def self.default
+      @default ||= new
     end
 
-    def decrement(keys = nil, value = 1)
-      @client.send_json(standard_values(value, keys, :decrement))
+    def self.default=(client)
+      @default = client
     end
 
-  end
+    MAX_SOCKET_AGE = 25
+    MAX_QUEUE_SIZE = 10_000
 
-  def self.default
-    @default ||= new
-  end
+    def initialize(host: 'localhost', port: PrometheusExporter::DEFAULT_PORT, max_queue_size: nil, thread_sleep: 0.5, json_serializer: nil, custom_labels: nil)
+      @metrics = []
 
-  def self.default=(client)
-    @default = client
-  end
+      @queue = Queue.new
+      @socket = nil
+      @socket_started = nil
 
-  MAX_SOCKET_AGE = 25
-  MAX_QUEUE_SIZE = 10_000
+      max_queue_size ||= MAX_QUEUE_SIZE
+      max_queue_size = max_queue_size.to_i
 
-  def initialize(host: 'localhost', port: PrometheusExporter::DEFAULT_PORT, max_queue_size: nil, thread_sleep: 0.5, json_serializer: nil, custom_labels: nil)
-    @metrics = []
+      if max_queue_size.to_i <= 0
+        raise ArgumentError, "max_queue_size must be larger than 0"
+      end
 
-    @queue = Queue.new
-    @socket = nil
-    @socket_started = nil
+      @max_queue_size = max_queue_size
+      @host = host
+      @port = port
+      @worker_thread = nil
+      @mutex = Mutex.new
+      @thread_sleep = thread_sleep
 
-    max_queue_size ||= MAX_QUEUE_SIZE
-    max_queue_size = max_queue_size.to_i
+      @json_serializer = json_serializer == :oj ? PrometheusExporter::OjCompat : JSON
 
-    if max_queue_size.to_i <= 0
-      raise ArgumentError, "max_queue_size must be larger than 0"
+      @custom_labels = custom_labels
     end
 
-    @max_queue_size = max_queue_size
-    @host = host
-    @port = port
-    @worker_thread = nil
-    @mutex = Mutex.new
-    @thread_sleep = thread_sleep
-
-    @json_serializer = json_serializer == :oj ? PrometheusExporter::OjCompat : JSON
-
-    @custom_labels = custom_labels
-  end
-
-  def custom_labels=(custom_labels)
-    @custom_labels = custom_labels
-  end
-
-  def register(type, name, help)
-    metric = RemoteMetric.new(type: type, name: name, help: help, client: self)
-    @metrics << metric
-    metric
-  end
+    def custom_labels=(custom_labels)
+      @custom_labels = custom_labels
+    end
 
-  def send_json(obj)
-    payload = @custom_labels.nil? ? obj : obj.merge(custom_labels: @custom_labels)
-    send(@json_serializer.dump(payload))
-  end
+    def register(type, name, help)
+      metric = RemoteMetric.new(type: type, name: name, help: help, client: self)
+      @metrics << metric
+      metric
+    end
 
-  def send(str)
-    @queue << str
-    if @queue.length > @max_queue_size
-      STDERR.puts "Prometheus Exporter client is dropping message cause queue is full"
-      @queue.pop
+    def send_json(obj)
+      payload = @custom_labels.nil? ? obj : obj.merge(custom_labels: @custom_labels)
+      send(@json_serializer.dump(payload))
     end
 
-    ensure_worker_thread!
-  end
+    def send(str)
+      @queue << str
+      if @queue.length > @max_queue_size
+        STDERR.puts "Prometheus Exporter client is dropping message cause queue is full"
+        @queue.pop
+      end
 
-  def process_queue
-    while @queue.length > 0
-      ensure_socket!
+      ensure_worker_thread!
+    end
 
-      begin
-        message = @queue.pop
-        @socket.write(message.bytesize.to_s(16).upcase)
-        @socket.write("\r\n")
-        @socket.write(message)
-        @socket.write("\r\n")
-      rescue => e
-        STDERR.puts "Prometheus Exporter is dropping a message: #{e}"
-        @socket = nil
-        raise
+    def process_queue
+      while @queue.length > 0
+        ensure_socket!
+
+        begin
+          message = @queue.pop
+          @socket.write(message.bytesize.to_s(16).upcase)
+          @socket.write("\r\n")
+          @socket.write(message)
+          @socket.write("\r\n")
+        rescue => e
+          STDERR.puts "Prometheus Exporter is dropping a message: #{e}"
+          @socket = nil
+          raise
+        end
       end
     end
-  end
 
-  def stop
-    @mutex.synchronize do
-      @worker_thread&.kill
-      while @worker_thread.alive?
-        sleep 0.001
+    def stop
+      @mutex.synchronize do
+        @worker_thread&.kill
+        while @worker_thread.alive?
+          sleep 0.001
+        end
+        @worker_thread = nil
       end
-      @worker_thread = nil
-    end
 
-    close_socket!
-  end
+      close_socket!
+    end
 
-  private
+    private
 
-  def worker_loop
-    close_socket_if_old!
-    process_queue
-  rescue => e
-    STDERR.puts "Prometheus Exporter, failed to send message #{e}"
-  end
+    def worker_loop
+      close_socket_if_old!
+      process_queue
+    rescue => e
+      STDERR.puts "Prometheus Exporter, failed to send message #{e}"
+    end
 
-  def ensure_worker_thread!
-    unless @worker_thread&.alive?
-      @mutex.synchronize do
-        return if @worker_thread&.alive?
+    def ensure_worker_thread!
+      unless @worker_thread&.alive?
+        @mutex.synchronize do
+          return if @worker_thread&.alive?
 
-        @worker_thread = Thread.new do
-          while true
-            worker_loop
-            sleep @thread_sleep
+          @worker_thread = Thread.new do
+            while true
+              worker_loop
+              sleep @thread_sleep
+            end
           end
         end
       end
     end
-  end
 
-  def close_socket!
-    begin
-      if @socket
-        @socket.write("0\r\n")
+    def close_socket!
+      begin
+        if @socket
+          @socket.write("0\r\n")
+          @socket.write("\r\n")
+          @socket.flush
+          @socket.close
+        end
+      rescue Errno::EPIPE
+      end
+
+      @socket = nil
+      @socket_started = nil
+    end
+
+    def close_socket_if_old!
+      if @socket && ((@socket_started + MAX_SOCKET_AGE) < Time.now.to_f)
+        close_socket!
+      end
+    end
+
+    def ensure_socket!
+      close_socket_if_old!
+      if !@socket
+        @socket = TCPSocket.new @host, @port
+        @socket.write("POST /send-metrics HTTP/1.1\r\n")
+        @socket.write("Transfer-Encoding: chunked\r\n")
+        @socket.write("Host: #{@host}\r\n")
+        @socket.write("Connection: Close\r\n")
+        @socket.write("Content-Type: application/octet-stream\r\n")
         @socket.write("\r\n")
-        @socket.flush
-        @socket.close
+        @socket_started = Time.now.to_f
       end
-    rescue Errno::EPIPE
+
+      nil
+    rescue
+      @socket = nil
+      @socket_started = nil
+      raise
     end
 
-    @socket = nil
-    @socket_started = nil
   end
 
-  def close_socket_if_old!
-    if @socket && ((@socket_started + MAX_SOCKET_AGE) < Time.now.to_f)
-      close_socket!
+  class LocalClient < Client
+    attr_reader :collector
+
+    def initialize(collector:, json_serializer: nil, custom_labels: nil)
+      @collector = collector
+      super(json_serializer: json_serializer, custom_labels: custom_labels)
     end
-  end
 
-  def ensure_socket!
-    close_socket_if_old!
-    if !@socket
-      @socket = TCPSocket.new @host, @port
-      @socket.write("POST /send-metrics HTTP/1.1\r\n")
-      @socket.write("Transfer-Encoding: chunked\r\n")
-      @socket.write("Host: #{@host}\r\n")
-      @socket.write("Connection: Close\r\n")
-      @socket.write("Content-Type: application/octet-stream\r\n")
-      @socket.write("\r\n")
-      @socket_started = Time.now.to_f
-    end
-
-    nil
-  rescue
-    @socket = nil
-    @socket_started = nil
-    raise
+    def send(json)
+      @collector.process(json)
+    end
   end
 
 end

data/lib/prometheus_exporter/instrumentation/process.rb

@@ -1,10 +1,15 @@
+# frozen_string_literal: true
+
 # collects stats from currently running process
 module PrometheusExporter::Instrumentation
   class Process
     def self.start(client: nil, type: "ruby", frequency: 30)
       process_collector = new(type)
       client ||= PrometheusExporter::Client.default
-      Thread.new do
+
+      stop if @thread
+
+      @thread = Thread.new do
         while true
           begin
             metric = process_collector.collect
@@ -18,6 +23,13 @@ module PrometheusExporter::Instrumentation
       end
     end
 
+    def self.stop
+      if t = @thread
+        t.kill
+        @thread = nil
+      end
+    end
+
     def initialize(type)
       @type = type
     end

data/lib/prometheus_exporter/instrumentation.rb

@@ -2,6 +2,5 @@ require_relative "instrumentation/process"
 require_relative "instrumentation/method_profiler"
 require_relative "instrumentation/sidekiq"
 require_relative "instrumentation/delayed_job"
-require_relative "instrumentation/global"
 require_relative "instrumentation/puma"
 require_relative "instrumentation/hutch"

data/lib/prometheus_exporter/server/collector.rb

@@ -3,22 +3,6 @@
 module PrometheusExporter::Server
 
   class Collector < CollectorBase
-    MAX_PROCESS_METRIC_AGE = 60
-    PROCESS_GAUGES = {
-      heap_free_slots: "Free ruby heap slots.",
-      heap_live_slots: "Used ruby heap slots.",
-      v8_heap_size: "Total JavaScript V8 heap size (bytes).",
-      v8_used_heap_size: "Total used JavaScript V8 heap size (bytes).",
-      v8_physical_size: "Physical size consumed by V8 heaps.",
-      v8_heap_count: "Number of V8 contexts running.",
-      rss: "Total RSS used by process.",
-    }
-
-    PROCESS_COUNTERS = {
-      major_gc_ops_total: "Major GC operations by process.",
-      minor_gc_ops_total: "Minor GC operations by process.",
-      allocated_objects_total: "Total number of allocated objects by process.",
-    }
 
     def initialize(json_serializer: nil)
       @process_metrics = []
@@ -39,7 +23,10 @@ module PrometheusExporter::Server
     end
 
     def process(str)
-      obj = @json_serializer.parse(str)
+      process_hash(@json_serializer.parse(str))
+    end
+
+    def process_hash(obj)
       @mutex.synchronize do
         if collector = @collectors[obj["type"]]
           collector.collect(obj)

data/lib/prometheus_exporter/version.rb

@@ -1,3 +1,3 @@
 module PrometheusExporter
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prometheus_exporter
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-11 00:00:00.000000000 Z
+date: 2019-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,7 +162,6 @@ files:
 - lib/prometheus_exporter/client.rb
 - lib/prometheus_exporter/instrumentation.rb
 - lib/prometheus_exporter/instrumentation/delayed_job.rb
-- lib/prometheus_exporter/instrumentation/global.rb
 - lib/prometheus_exporter/instrumentation/hutch.rb
 - lib/prometheus_exporter/instrumentation/method_profiler.rb
 - lib/prometheus_exporter/instrumentation/process.rb