prometheus-client-mmap 0.9.10 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea7b6fe48f2d5019181dcc236a5a8d187ea5aeb7e7d8e2acc8d31bfb6bc62207
-  data.tar.gz: 6231f6c5e44fc07b7084d4f9e816c9eb97916bb00235829349b9903af4c9621b
+  metadata.gz: 77dda8e211c5981651a160500f0332b886e124935e969136abe4fd234ae311e1
+  data.tar.gz: 4ba3176b93611a3bcf63b0aed029408a5f22f33ca16635d05c9c244e33b0bfaa
 SHA512:
-  metadata.gz: 48cc3fa10e0879d90340349ccc118dbd4b3eca40ee8e513f5600f58354f089c4ac7e8598ede6a696b24aafca51f75baeb8e2f4b1967a42b32dcacb2d408c83bb
-  data.tar.gz: 2a01473c292535c2931efdbb1b5e958389d71521cb55f25edddef6f097eddec7d5cac08e0e4bab3b85ee5757626f67930312fefce99f24d7184541a1ab07b559
+  metadata.gz: 75cbb10eed65af805c4cccda2e91783ec0ce0987150881ecc763d8de07ea3af150eb20bc41fbaf414dc66d4341141d163cf83514f7f4c913aaf1fdb0efc99dad
+  data.tar.gz: d4b2e4e7a3a78a315cb490a5d07125eaeb2782c6e7c0cb1cbfa0ff302d44ca343b752a29912d3f46b2acc7a6999d84ffe5ee3903d2004a501c2d4dac62f93846

data/ext/fast_mmaped_file/fast_mmaped_file.c

@@ -1,20 +1,17 @@
 #include <errno.h>
+#include <hashmap.h>
+#include <jsmn.h>
 #include <ruby.h>
 #include <ruby/intern.h>
-
 #include <sys/mman.h>
 
-#include <hashmap.h>
-#include <jsmn.h>
-
-#include "globals.h"
-#include "utils.h"
-#include "value_access.h"
-
 #include "file_parsing.h"
 #include "file_reading.h"
+#include "globals.h"
 #include "mmap.h"
 #include "rendering.h"
+#include "utils.h"
+#include "value_access.h"
 
 VALUE MMAPED_FILE = Qnil;
 

data/ext/fast_mmaped_file/file_parsing.c

@@ -1,9 +1,9 @@
+#include "file_parsing.h"
+
 #include <hashmap.h>
 #include <jsmn.h>
-#include <ruby.h>
 
 #include "file_format.h"
-#include "file_parsing.h"
 #include "globals.h"
 #include "utils.h"
 

data/ext/fast_mmaped_file/file_parsing.h

@@ -2,6 +2,7 @@
 #define FILE_PARSING_H
 #include <file_reading.h>
 #include <hashmap.h>
+#include <ruby.h>
 
 typedef struct {
     char *json;

data/ext/fast_mmaped_file/file_reading.c

@@ -1,8 +1,8 @@
+#include "file_reading.h"
+
 #include <errno.h>
 #include <fcntl.h>
-#include <ruby.h>
 
-#include "file_reading.h"
 #include "utils.h"
 
 static int file_open(file_t *source, const char *filepath) {

data/ext/fast_mmaped_file/mmap.c

@@ -1,11 +1,11 @@
+#include "mmap.h"
+
 #include <errno.h>
 #include <fcntl.h>
-#include <ruby.h>
 #include <ruby/util.h>
 #include <sys/mman.h>
 
 #include "file_format.h"
-#include "mmap.h"
 #include "utils.h"
 
 #if 0
@@ -42,7 +42,6 @@ static VALUE mm_str(VALUE obj, int modify) {
     GET_MMAP(obj, i_mm, modify & ~MM_ORIGIN);
     if (modify & MM_MODIFY) {
         if (i_mm->t->flag & MM_FROZEN) rb_error_frozen("mmap");
-        if (!OBJ_TAINTED(ret) && rb_safe_level() >= 4) rb_raise(rb_eSecurityError, "Insecure: can't modify mmap");
     }
     ret = rb_obj_alloc(rb_cString);
     if (rb_obj_tainted(obj)) {
@@ -170,6 +169,35 @@ VALUE mm_s_alloc(VALUE obj) {
     return res;
 }
 
+size_t next_page_boundary(size_t value) {
+    size_t page_size = sysconf(_SC_PAGESIZE);
+
+    while (page_size < value) {
+        page_size *= 2;
+    }
+
+    return page_size;
+}
+
+/* Reference implementations:
+ * mozilla: https://hg.mozilla.org/mozilla-central/file/3d846420a907/xpcom/glue/FileUtils.cpp#l71
+ * glibc: https://github.com/lattera/glibc/blob/master/sysdeps/posix/posix_fallocate.c
+ */
+int reserve_mmap_file_bytes(int fd, size_t size) {
+#if __linux__
+    /* From https://stackoverflow.com/a/22820221: The difference with
+     * ftruncate(2) is that (on file systems supporting it, e.g. Ext4)
+     * disk space is indeed reserved by posix_fallocate but ftruncate
+     * extends the file by adding holes (and without reserving disk
+     * space). */
+    return posix_fallocate(fd, 0, size);
+#else
+    /* We simplify the reference implemnetations since we generally
+     * don't need to reserve more than a page size. */
+    return ftruncate(fd, size);
+#endif
+}
+
 VALUE mm_init(VALUE obj, VALUE fname) {
     struct stat st;
     int fd, smode = 0, pmode = 0, vscope, perm, init;
@@ -187,13 +215,6 @@ VALUE mm_init(VALUE obj, VALUE fname) {
     SafeStringValue(fname);
     path = StringValuePtr(fname);
 
-    {
-        if (rb_safe_level() > 0 && OBJ_TAINTED(fname)) {
-            rb_raise(rb_eSecurityError, "Insecure operation");
-        }
-        rb_secure(1);
-    }
-
     vscope = MAP_SHARED;
     size = 0;
     perm = 0666;
@@ -206,6 +227,7 @@ VALUE mm_init(VALUE obj, VALUE fname) {
     }
 
     if (fstat(fd, &st) == -1) {
+        close(fd);
         rb_raise(rb_eArgError, "Can't stat %s", path);
     }
     size = st.st_size;
@@ -215,17 +237,21 @@ VALUE mm_init(VALUE obj, VALUE fname) {
     offset = 0;
     init = 0;
 
-    if (size == 0 && (smode & O_RDWR)) {
-        if (lseek(fd, INITIAL_SIZE - 1, SEEK_END) == -1) {
-            rb_raise(rb_eIOError, "Can't lseek %zu", INITIAL_SIZE - 1);
-        }
-        if (write(fd, "\000", 1) != 1) {
-            rb_raise(rb_eIOError, "Can't extend %s", path);
-        }
+    if (size == 0) {
         init = 1;
         size = INITIAL_SIZE;
     }
 
+    /* We need to ensure the underlying file descriptor is at least a page size.
+     * Otherwise, we could get a SIGBUS error if mmap() attempts to read or write
+     * past the file. */
+    size_t reserve_size = next_page_boundary(size);
+
+    if (reserve_mmap_file_bytes(fd, reserve_size) != 0) {
+        close(fd);
+        rb_raise(rb_eIOError, "Can't reserve %zu bytes for memory-mapped file in %s", reserve_size, path);
+    }
+
     addr = mmap(0, size, pmode, vscope, fd, offset);
 
     if (addr == MAP_FAILED || !addr) {

data/ext/fast_mmaped_file/rendering.c

@@ -1,9 +1,10 @@
+#include "rendering.h"
+
 #include <float.h>
 #include <jsmn.h>
 
 #include "file_parsing.h"
 #include "globals.h"
-#include "rendering.h"
 #include "utils.h"
 
 #ifndef DBL_DECIMAL_DIG

data/ext/fast_mmaped_file/utils.c

@@ -1,8 +1,7 @@
-#include <errno.h>
-#include <ruby.h>
-
 #include "utils.h"
 
+#include <errno.h>
+
 static void rb_save_exception(VALUE exception, VALUE message) {
     VALUE current_thread = rb_thread_current();
 

data/ext/fast_mmaped_file/utils.h

@@ -1,5 +1,6 @@
 #ifndef UNUSED_H
 #define UNUSED_H
+#include <ruby.h>
 
 #ifdef UNUSED
 #elif defined(__GNUC__)

data/ext/fast_mmaped_file/value_access.c

@@ -1,15 +1,13 @@
-#include <ruby.h>
-#include <ruby/intern.h>
+#include "value_access.h"
 
 #include <errno.h>
 #include <fcntl.h>
+#include <ruby/intern.h>
 #include <sys/mman.h>
 #include <unistd.h>
 
 #include "file_format.h"
 #include "mmap.h"
-#include "value_access.h"
-
 #include "utils.h"
 
 static void close_file(mm_ipc *i_mm) {

data/ext/fast_mmaped_file/value_access.h

@@ -1,5 +1,6 @@
 #ifndef VALUE_ACCESS_H
 #define VALUE_ACCESS_H
+#include <ruby.h>
 
 VALUE method_load_used(VALUE self);
 

data/lib/prometheus/client/gauge.rb

@@ -31,6 +31,10 @@ module Prometheus
       def increment(labels, value)
         @values[label_set_for(labels)].increment(value)
       end
+
+      def decrement(labels, value)
+        @values[label_set_for(labels)].decrement(value)
+      end
     end
   end
 end

data/lib/prometheus/client/mmaped_dict.rb

@@ -57,6 +57,10 @@ module Prometheus
         Prometheus::Client.logger.warn("munmap raised error #{e}")
       end
 
+      def inspect
+        "#<#{self.class}:0x#{(object_id << 1).to_s(16)}>"
+      end
+
       private
 
       def init_value(key)

data/lib/prometheus/client/mmaped_value.rb

@@ -36,6 +36,10 @@ module Prometheus
         end
       end
 
+      def decrement(amount = 1)
+        increment(-amount)
+      end
+
       def set(value)
         @mutex.synchronize do
           initialize_file if pid_changed?

data/lib/prometheus/client/push.rb

@@ -1,7 +1,9 @@
 # encoding: UTF-8
 
+require 'thread'
 require 'net/http'
 require 'uri'
+require 'erb'
 
 require 'prometheus/client'
 require 'prometheus/client/formats/text'
@@ -13,31 +15,45 @@ module Prometheus
     # Pushgateway.
     class Push
       DEFAULT_GATEWAY = 'http://localhost:9091'.freeze
-      PATH            = '/metrics/jobs/%s'.freeze
-      INSTANCE_PATH   = '/metrics/jobs/%s/instances/%s'.freeze
-      HEADER          = { 'Content-Type' => Formats::Text::CONTENT_TYPE }.freeze
+      PATH            = '/metrics/job/%s'.freeze
+      INSTANCE_PATH   = '/metrics/job/%s/instance/%s'.freeze
+      SUPPORTED_SCHEMES = %w(http https).freeze
 
       attr_reader :job, :instance, :gateway, :path
 
-      def initialize(job, instance = nil, gateway = nil)
+      def initialize(job:, instance: nil, gateway: DEFAULT_GATEWAY, **kwargs)
+        raise ArgumentError, "job cannot be nil" if job.nil?
+        raise ArgumentError, "job cannot be empty" if job.empty?
+
+        @mutex = Mutex.new
         @job = job
         @instance = instance
         @gateway = gateway || DEFAULT_GATEWAY
-        @uri = parse(@gateway)
         @path = build_path(job, instance)
+        @uri = parse("#{@gateway}#{@path}")
+
         @http = Net::HTTP.new(@uri.host, @uri.port)
+        @http.use_ssl = (@uri.scheme == 'https')
+        @http.open_timeout = kwargs[:open_timeout] if kwargs[:open_timeout]
+        @http.read_timeout = kwargs[:read_timeout] if kwargs[:read_timeout]
       end
 
       def add(registry)
-        request('POST', registry)
+        synchronize do
+          request(Net::HTTP::Post, registry)
+        end
       end
 
       def replace(registry)
-        request('PUT', registry)
+        synchronize do
+          request(Net::HTTP::Put, registry)
+        end
       end
 
       def delete
-        @http.send_request('DELETE', path)
+        synchronize do
+          request(Net::HTTP::Delete)
+        end
       end
 
       private
@@ -45,27 +61,34 @@ module Prometheus
       def parse(url)
         uri = URI.parse(url)
 
-        if uri.scheme == 'http'
-          uri
-        else
+        unless SUPPORTED_SCHEMES.include?(uri.scheme)
           raise ArgumentError, 'only HTTP gateway URLs are supported currently.'
         end
+
+        uri
       rescue URI::InvalidURIError => e
         raise ArgumentError, "#{url} is not a valid URL: #{e}"
       end
 
       def build_path(job, instance)
-        if instance
-          format(INSTANCE_PATH, URI.escape(job), URI.escape(instance))
+        if instance && !instance.empty?
+          format(INSTANCE_PATH, ERB::Util::url_encode(job), ERB::Util::url_encode(instance))
         else
-          format(PATH, URI.escape(job))
+          format(PATH, ERB::Util::url_encode(job))
         end
       end
 
-      def request(method, registry)
-        data = Formats::Text.marshal(registry)
+      def request(req_class, registry = nil)
+        req = req_class.new(@uri)
+        req.content_type = Formats::Text::CONTENT_TYPE
+        req.basic_auth(@uri.user, @uri.password) if @uri.user
+        req.body = Formats::Text.marshal(registry) if registry
+
+        @http.request(req)
+      end
 
-        @http.send_request(method, path, data, HEADER)
+      def synchronize
+        @mutex.synchronize { yield }
       end
     end
   end

data/lib/prometheus/client/simple_value.rb

@@ -15,6 +15,10 @@ module Prometheus
         @value += by
       end
 
+      def decrement(by = 1)
+        @value -= by
+      end
+
       def get
         @value
       end

data/lib/prometheus/client/version.rb

@@ -1,5 +1,5 @@
 module Prometheus
   module Client
-    VERSION = '0.9.10'.freeze
+    VERSION = '0.13.0'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prometheus-client-mmap
 version: !ruby/object:Gem::Version
-  version: 0.9.10
+  version: 0.13.0
 platform: ruby
 authors:
 - Tobias Schmidt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-16 00:00:00.000000000 Z
+date: 2021-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fuzzbert
@@ -181,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A suite of instrumentation metric primitivesthat can be exposed through a