prometheus-client-mmap 0.7.0.beta12 → 0.7.0.beta13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d37ca4308c9dbdb10a22066b37df88b7e456cfb3
-  data.tar.gz: a27b2e124d343da9bb5b8f639894cd84f846334a
+  metadata.gz: 6fcba3cc4377e6b167f11073280a999e4df75717
+  data.tar.gz: 9635faeeb5c2fb643176954f417acc738ee60756
 SHA512:
-  metadata.gz: 8fba7137a3ea1f5fa1ea375bb1999d85b1765a6c73adb69ef77a0f6f2d77db4f1ac057a37de600baf8b6abe355aaac97ee4db88e4ccf82aa81b4b14f4d845df9
-  data.tar.gz: e785931142ce33b5485b6dcb6742adaedc238235fd1c92e5117cfd3d483945912b9a721719a91ad6b013f4a8038dcb20c1a10e3bfe5fb47fff20115168055f9f
+  metadata.gz: 85ebce9a92214fb77be47134d3282a5a71661e9c0c8d2140f6aeed8abc00bf6780541ca33cb67f2394047137740f27098725406668eda36d4b1091ae4fbec126
+  data.tar.gz: 259e6ea42822d509900da3c97602774e4b69cf1384439202d53924fc12d16d7c814298adeeeefd7a553027f66b028601fe9be16701da3680f4fb14c7cb364932

data/README.md

@@ -164,6 +164,27 @@ summary.get({ service: 'database' })
 # => { 0.5 => 0.1233122, 0.9 => 3.4323, 0.99 => 5.3428231 }
 ```
 
+## Pitfalls
+
+### PID cardinality
+
+In multiprocess setup e.g. running under Unicorn, having worker process restart often can
+lead to performance problems when proccesing metric files. By default each process using
+Prometheus metrics will create a set of files based on that process PID. With high worker
+churn this will lead to creation of thousands of files and in turn will cause very noticable 
+slowdown when displaying metrics
+
+To reduce this problem, a surrogate process id can be used. Set of all such IDs needs
+have low cardinality, and each process id must be unique among all running process.
+
+For Unicorn a worker id/number can be used to greatly speedup the metrics rendering.
+
+To use it add this line to your `configure` block:
+
+```ruby
+  config.pid_provider = Prometheus::Client::Support::Unicorn.method(:worker_pid_provider)
+```
+
 ## Tests
 
 Install necessary development gems with `bundle install` and run tests with

data/lib/prometheus/client.rb

@@ -25,6 +25,10 @@ module Prometheus
         configuration.logger
       end
 
+      def pid
+        configuration.pid_provider.call
+      end
+
       def reinitialize_on_pid_change
         ::Prometheus::Client::MmapedValue.reinitialize_on_pid_change
       end

data/lib/prometheus/client/configuration.rb

@@ -5,13 +5,14 @@ require 'logger'
 module Prometheus
   module Client
     class Configuration
-      attr_accessor :value_class, :multiprocess_files_dir, :initial_mmap_file_size, :logger
+      attr_accessor :value_class, :multiprocess_files_dir, :initial_mmap_file_size, :logger, :pid_provider
 
       def initialize
         @value_class = ::Prometheus::Client::MmapedValue
         @multiprocess_files_dir = ENV['prometheus_multiproc_dir']
         @initial_mmap_file_size = 4 * 1024
         @logger = Logger.new($stdout)
+        @pid_provider = Process.method(:pid)
       end
     end
   end

data/lib/prometheus/client/formats/text.rb

@@ -1,4 +1,5 @@
 require 'prometheus/client/uses_value_type'
+require 'prometheus/client/helper/json_parser'
 
 module Prometheus
   module Client
@@ -96,29 +97,24 @@ module Prometheus
             Dir.glob(File.join(path, '*.db')).sort.each do |f|
               parts = File.basename(f, '.db').split('_')
               type = parts[0].to_sym
-              d = MmapedDict.new(f)
-
-              begin
-                d.all_values.each do |key, value|
-                  metric_name, name, labelnames, labelvalues = JSON.parse(key)
-                  metric = metrics.fetch(metric_name,
-                                         metric_name: metric_name,
-                                         help: 'Multiprocess metric',
-                                         type: type,
-                                         samples: []
-                  )
-                  if type == :gauge
-                    pid = parts[2]
-                    metric[:multiprocess_mode] = parts[1]
-                    metric[:samples] += [[name, labelnames.zip(labelvalues) + [['pid', pid]], value]]
-                  else
-                    # The duplicates and labels are fixed in the next for.
-                    metric[:samples] += [[name, labelnames.zip(labelvalues), value]]
-                  end
-                  metrics[metric_name] = metric
+
+              MmapedDict.read_all_values(f).each do |key, value|
+                metric_name, name, labelnames, labelvalues = Helper::JsonParser.load(key)
+                metric = metrics.fetch(metric_name,
+                                       metric_name: metric_name,
+                                       help: 'Multiprocess metric',
+                                       type: type,
+                                       samples: []
+                )
+                if type == :gauge
+                  pid = parts[2]
+                  metric[:multiprocess_mode] = parts[1]
+                  metric[:samples] += [[name, labelnames.zip(labelvalues) + [['pid', pid]], value]]
+                else
+                  # The duplicates and labels are fixed in the next for.
+                  metric[:samples] += [[name, labelnames.zip(labelvalues), value]]
                 end
-              ensure
-                d.close
+                metrics[metric_name] = metric
               end
             end
             metrics

data/lib/prometheus/client/helper/json_parser.rb

@@ -0,0 +1,19 @@
+module Prometheus
+  module Client
+    module Helper
+      module JsonParser
+        class << self
+          if defined?(Oj)
+            def load(s)
+              Oj.load(s)
+            end
+          else
+            def load(s)
+              JSON.parse(s)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/prometheus/client/mmaped_dict.rb

@@ -3,7 +3,8 @@ require 'mmap'
 
 module Prometheus
   module Client
-    class ParsingError < StandardError; end
+    class ParsingError < StandardError
+    end
 
     # A dict of doubles, backed by an mmapped file.
     #
@@ -23,30 +24,45 @@ module Prometheus
         @f = File.open(filename, 'a+b')
         process_file
       rescue StandardError => e
-        raise ParsingError.new("exception #{e} while processing metrics file #{@f.path}")
+        raise ParsingError, "exception #{e} while processing metrics file #{@f.path}"
       end
 
-      # Yield (key, value, pos). No locking is performed.
-      def all_values
-        read_all_values.map { |k, v, p| [k, v] }
+      # Yield (key, value). No locking is performed.
+      def self.read_all_values(f)
+        m = Mmap.new(f, 'rw', Mmap::MAP_SHARED)
+        used, = m[0..3].unpack('l')
+        pos = 8
+        values = []
+        while pos < used
+          data = m.slice(pos..-1)
+          encoded_len, = data.unpack('l')
+          value_offset = 4 + encoded_len + (8 - (encoded_len + 4) % 8)
+
+          encoded, value = data.unpack(format('@4A%d@%dd', encoded_len, value_offset))
+          values << [encoded, value]
+          pos += value_offset + 8
+        end
+        values
+      ensure
+        m.munmap
       end
 
       def read_value(key)
         @mutex.synchronize do
-          init_value(key) unless @positions.has_key?(key)
+          init_value(key) unless @positions.key?(key)
         end
         pos = @positions[key]
         # We assume that reading from an 8 byte aligned value is atomic.
-        @m[pos..pos+7].unpack('d')[0]
+        @m[pos..pos + 7].unpack('d')[0]
       end
 
       def write_value(key, value)
         @mutex.synchronize do
-          init_value(key) unless @positions.has_key?(key)
+          init_value(key) unless @positions.key?(key)
         end
         pos = @positions[key]
         # We assume that writing to an 8 byte aligned value is atomic.
-        @m[pos..pos+7] = [value].pack('d')
+        @m[pos..pos + 7] = [value].pack('d')
       end
 
       def close
@@ -64,9 +80,7 @@ module Prometheus
       private
 
       def process_file
-        if @f.size < MINIMUM_SIZE
-          @f.truncate(initial_mmap_file_size)
-        end
+        @f.truncate(initial_mmap_file_size) if @f.size < MINIMUM_SIZE
 
         @capacity = @f.size
         @m = Mmap.new(@f.path, 'rw', Mmap::MAP_SHARED)
@@ -78,7 +92,7 @@ module Prometheus
           @used = 8
           @m[0..3] = [@used].pack('l')
         else
-          read_all_values.each do |key, _, pos|
+          read_all_positions.each do |key, _, pos|
             @positions[key] = pos
           end
         end
@@ -104,21 +118,20 @@ module Prometheus
       end
 
       # Yield (key, value, pos). No locking is performed.
-      def read_all_values
+      def read_all_positions
         pos = 8
         values = []
         while pos < @used
-          encoded_len = @m[pos..-1].unpack('l')[0]
-          pos += 4
-          encoded = @m[pos..-1].unpack("A#{encoded_len}")[0]
-          padded_len = encoded_len + (8 - (encoded_len + 4) % 8)
-          pos += padded_len
-          value = @m[pos..-1].unpack('d')[0]
-          values << [encoded, value, pos]
+          data = @m.slice(pos..-1)
+          encoded_len = data.unpack('l')[0]
+          padding_len = 8 - (encoded_len + 4) % 8
+          encoded = data.unpack(format('@4A%d', encoded_len))
+          pos += 4 + encoded_len + padding_len
+          values << [encoded, pos]
           pos += 8
         end
         values
       end
     end
   end
-end
+end

data/lib/prometheus/client/mmaped_value.rb

@@ -1,3 +1,4 @@
+require 'prometheus/client'
 require 'prometheus/client/mmaped_dict'
 require 'json'
 
@@ -7,10 +8,10 @@ module Prometheus
     class MmapedValue
       @@files = {}
       @@files_lock = Mutex.new
-      @@pid = Process.pid
+      @@pid = -1
 
       def initialize(type, metric_name, name, labels, multiprocess_mode = '')
-        @pid = Process.pid
+        @pid = Prometheus::Client.pid
         @file_prefix = type.to_s
         @metric_name = metric_name
         @name = name
@@ -50,7 +51,7 @@ module Prometheus
       def self.reset_on_pid_change
         @@files_lock.synchronize do
           if pid_changed?
-            @@pid = Process.pid
+            @@pid = Prometheus::Client.pid
             @@files = {}
           end
         end
@@ -62,7 +63,7 @@ module Prometheus
       end
 
       def self.pid_changed?
-        @@pid != Process.pid
+        @@pid != Prometheus::Client.pid
       end
 
       def self.multiprocess
@@ -70,8 +71,8 @@ module Prometheus
       end
 
       def reinitialize
-        if @pid != Process.pid
-          @pid = Process.pid
+        if @pid != Prometheus::Client.pid
+          @pid = Prometheus::Client.pid
           initialize_file
         end
       end

data/lib/prometheus/client/support/unicorn.rb

@@ -0,0 +1,24 @@
+module Prometheus
+  module Client
+    module Support
+      module Unicorn
+        def self.worker_pid_provider
+          wid = worker_id
+          Process.pid if wid.nil?
+
+          "worker_id_#{wid}"
+        end
+
+        def self.worker_id
+          return unless defined?(::Unicorn::Worker)
+
+          workers = ObjectSpace.each_object(::Unicorn::Worker)
+          return if workers.nil?
+
+          workers_first = workers.first
+          workers_first.nr unless workers_first.nil?
+        end
+      end
+    end
+  end
+end

data/lib/prometheus/client/version.rb

@@ -2,6 +2,6 @@
 
 module Prometheus
   module Client
-    VERSION = '0.7.0.beta12'
+    VERSION = '0.7.0.beta13'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prometheus-client-mmap
 version: !ruby/object:Gem::Version
-  version: 0.7.0.beta12
+  version: 0.7.0.beta13
 platform: ruby
 authors:
 - Tobias Schmidt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-18 00:00:00.000000000 Z
+date: 2017-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mmap2
@@ -44,6 +44,7 @@ files:
 - lib/prometheus/client/counter.rb
 - lib/prometheus/client/formats/text.rb
 - lib/prometheus/client/gauge.rb
+- lib/prometheus/client/helper/json_parser.rb
 - lib/prometheus/client/histogram.rb
 - lib/prometheus/client/label_set_validator.rb
 - lib/prometheus/client/metric.rb
@@ -55,6 +56,7 @@ files:
 - lib/prometheus/client/registry.rb
 - lib/prometheus/client/simple_value.rb
 - lib/prometheus/client/summary.rb
+- lib/prometheus/client/support/unicorn.rb
 - lib/prometheus/client/uses_value_type.rb
 - lib/prometheus/client/version.rb
 homepage: https://gitlab.com/gitlab-org/prometheus-client-mmap