prometheus-client-mmap 0.24.5 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66c6ba03c473f782b6e00d5c138f11fda68c2e127b0fc325a49f55a741b50df5
-  data.tar.gz: f8c9f2e3e99e96e373cf2ef595f33abb73c5d6ae45c9ac2b7f02f8932da41362
+  metadata.gz: 94ad1d9acceaff1f75911cfe6665b1ed016916305e51865d5c4b49c22c81b880
+  data.tar.gz: 990a2ebcdf397bf025b8cd11eb3dc49227733b4590ab2cfff5a1b564e882362f
 SHA512:
-  metadata.gz: 66529e56dfa0110bbc7fafb1f1145c807f7daba272483a75ae752418f7a0dcc5b66a98d122c14ae3bfb390d0195ebc5a3109c9540c11dfae776a49a414950057
-  data.tar.gz: c13e0e6bc6e941b5a81968002d0e1666454fdc69e3cb1293b2711407b1d96dfa2e44d07aec725fda33e259896c656e5690d4bcd14cf8f96fda4a37b14218e61f
+  metadata.gz: 4d6919e8a5c0c61fc3cbfce2a2e09ba9f5eb71e9bca9710533c950d6a93c6ba2f9539e6e194b08707f5e0722a1d65d7d85c152cf007e893957f35f6135d5695c
+  data.tar.gz: 90ddef5880f7f48f82488abe9a4dd124d6520af0c42fc2f25fab8bb3599cd38258755737c2a0eb1fdf23c8a8d7982b1a8ae6bcffddfffb31f624178ba042c177

data/README.md

@@ -34,7 +34,7 @@ http_requests = prometheus.counter(:http_requests, 'A counter of HTTP requests m
 http_requests.increment
 ```
 
-## Rust extension (experimental)
+## Rust extension
 
 In an effort to improve maintainability, there is now an optional Rust
 implementation that reads the metric files and outputs the multiprocess
@@ -202,14 +202,21 @@ prometheus_multiproc_dir=/tmp
 
 ### Multiprocess metrics via Rust extension
 
-If the environment variable `prometheus_rust_multiprocess_metrics=true` is set or if the `rust_multiprocess_metrics`
-configuration setting is `true` and the `fast_mmaped_file_rs` extension is available, it will be used to generate
-multiprocess metrics. This should be significantly faster than the C extension.
+By default, the Rust extension will be used to read and write multiprocess
+metrics if the `fast_mmaped_file_rs` extension is available. This should
+be significantly faster than the C extension.
+
+If the environment variable `prometheus_rust_multiprocess_metrics=false`
+is set or if the `rust_multiprocess_metrics` configuration setting is
+`false` , the C extension will be used.
 
 ### Read and write metrics via Rust extension
 
-If the environment variable `prometheus_rust_mmaped_file=true` is set then if the `fast_mmaped_file_rs`
-extension is available it will be used to read and write metrics from the mmapped file.
+By default, the Rust extension will be used to read and write metrics
+from the mmaped file if the `fast_mmaped_file_rs` extension is available.
+
+To use the C extension, set the environment variable
+`prometheus_rust_mmaped_file=false`.
 
 ## Pitfalls
 

data/ext/fast_mmaped_file/mmap.c

@@ -3,6 +3,7 @@
 #include <errno.h>
 #include <fcntl.h>
 #include <ruby/util.h>
+#include <ruby/version.h>
 #include <sys/mman.h>
 
 #include "file_format.h"
@@ -27,6 +28,16 @@
  */
 static VALUE weak_obj_tracker_get_key(VALUE val) { return val; }
 
+static void update_rstring_len(VALUE val, size_t len) {
+#if defined(RUBY_API_VERSION_MAJOR) && defined(RUBY_API_VERSION_MINOR) && (RUBY_API_VERSION_MAJOR == 3) && \
+    (RUBY_API_VERSION_MINOR >= 3)
+
+    RSTRING(val)->len = len;
+#else
+    RSTRING(val)->as.heap.len = len;
+#endif
+}
+
 /**
  * Adds a T_STRING type to the WeakMap. The WeakMap should be stored
  * as an instance variable.
@@ -52,7 +63,7 @@ VALUE mm_update_obj_i(RB_BLOCK_CALL_FUNC_ARGLIST(i, self)) {
     GET_MMAP(self, i_mm, MM_MODIFY);
 
     RSTRING(i)->as.heap.ptr = i_mm->t->addr;
-    RSTRING(i)->as.heap.len = i_mm->t->real;
+    update_rstring_len(i, i_mm->t->real);
 
     return Qtrue;
 }
@@ -98,7 +109,7 @@ static VALUE mm_str(VALUE obj, int modify) {
     ret = rb_obj_alloc(rb_cString);
     RSTRING(ret)->as.heap.ptr = i_mm->t->addr;
     RSTRING(ret)->as.heap.aux.capa = i_mm->t->len;
-    RSTRING(ret)->as.heap.len = i_mm->t->real;
+    update_rstring_len(ret, i_mm->t->real);
 
     weak_obj_tracker_add(obj, ret);
 

data/ext/fast_mmaped_file_rs/Cargo.lock

@@ -30,9 +30,9 @@ checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa"
 
 [[package]]
 name = "bindgen"
-version = "0.60.1"
+version = "0.62.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "062dddbc1ba4aca46de6338e2bf87771414c335f7b2f2036e8f3e9befebf88e6"
+checksum = "c6720a8b7b2d39dd533285ed438d458f65b31b5c257e6ac7bb3d7e82844dd722"
 dependencies = [
  "bitflags",
  "cexpr",
@@ -45,6 +45,7 @@ dependencies = [
  "regex",
  "rustc-hash",
  "shlex",
+ "syn 1.0.109",
 ]
 
 [[package]]
@@ -169,6 +170,7 @@ dependencies = [
  "nix",
  "rand",
  "rb-sys",
+ "rb-sys-env",
  "serde",
  "serde_json",
  "sha2",
@@ -297,7 +299,7 @@ checksum = "d59d8c75012853d2e872fb56bc8a2e53718e2cafe1a4c823143141c6d90c322f"
 [[package]]
 name = "magnus"
 version = "0.5.0"
-source = "git+https://github.com/matsadler/magnus?branch=main#b10aab48119eb87a872bf0bb4480b1fcebe5d1b9"
+source = "git+https://github.com/matsadler/magnus?branch=main#50cab2380103c39c14765a10bdc4b38a74082285"
 dependencies = [
  "magnus-macros",
  "rb-sys",
@@ -308,7 +310,7 @@ dependencies = [
 [[package]]
 name = "magnus-macros"
 version = "0.4.0"
-source = "git+https://github.com/matsadler/magnus?branch=main#b10aab48119eb87a872bf0bb4480b1fcebe5d1b9"
+source = "git+https://github.com/matsadler/magnus?branch=main#50cab2380103c39c14765a10bdc4b38a74082285"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -443,18 +445,18 @@ dependencies = [
 
 [[package]]
 name = "rb-sys"
-version = "0.9.71"
+version = "0.9.79"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "156bfedced1e236600bcaad538477097ff2ed5c6b474e411d15b791e1d24c0f1"
+checksum = "939fb78db3e4f26665c1d4c7b91ca66d3578335a19aba552d4a6445811d07072"
 dependencies = [
  "rb-sys-build",
 ]
 
 [[package]]
 name = "rb-sys-build"
-version = "0.9.71"
+version = "0.9.79"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5cb2e4a32cbc290b543a74567072ad24b708aff7bb5dde5a68d5690379cd7938"
+checksum = "335a95eb0420d52fa94ef12019df3c2c250c6b19cbb3c60bd05cb7e9c362072c"
 dependencies = [
  "bindgen",
  "lazy_static",

data/ext/fast_mmaped_file_rs/Cargo.toml

@@ -27,6 +27,9 @@ rand = "0.8"
 sha2 = "0.10"
 tempfile = "3.5"
 
+[build-dependencies]
+rb-sys-env = "0.1"
+
 [lib]
 # Integration tests won't work if crate is only `cdylib`.
 crate-type = ["cdylib","lib"]

data/ext/fast_mmaped_file_rs/build.rs

@@ -0,0 +1,5 @@
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let _ = rb_sys_env::activate()?;
+
+    Ok(())
+}

data/ext/fast_mmaped_file_rs/src/mmap.rs

@@ -418,10 +418,10 @@ impl MmapedFile {
 
                     raw_str.as_mut().as_.heap.ptr = self.as_mut_ptr().offset(offset);
 
-                    let current_len = raw_str.as_ref().as_.heap.len;
+                    let current_len = str.len() as c_long;
                     let new_shared_len = old_cap + current_len;
 
-                    raw_str.as_mut().as_.heap.len = new_shared_len;
+                    self.update_rstring_len(raw_str, new_shared_len);
                     continue;
                 }
 
@@ -436,7 +436,7 @@ impl MmapedFile {
                 //
                 // See https://gitlab.com/gitlab-org/ruby/gems/prometheus-client-mmap/-/issues/45
                 raw_str.as_mut().as_.heap.ptr = self.as_mut_ptr();
-                raw_str.as_mut().as_.heap.len = new_len;
+                self.update_rstring_len(raw_str, new_len);
             }
         }
 
@@ -632,6 +632,16 @@ impl MmapedFile {
     unsafe fn rb_string_internal(rb_str: RString) -> NonNull<rb_sys::RString> {
         mem::transmute::<RString, NonNull<rb_sys::RString>>(rb_str)
     }
+
+    #[cfg(ruby_lte_3_2)]
+    unsafe fn update_rstring_len(&self, mut raw_str: NonNull<rb_sys::RString>, new_len: c_long) {
+        raw_str.as_mut().as_.heap.len = new_len;
+    }
+
+    #[cfg(ruby_gte_3_3)]
+    unsafe fn update_rstring_len(&self, mut raw_str: NonNull<rb_sys::RString>, new_len: c_long) {
+        raw_str.as_mut().len = new_len;
+    }
 }
 
 #[cfg(test)]
@@ -772,8 +782,7 @@ mod test {
                     if str.as_raw() == child_id {
                         assert_eq!(parent_id, raw_str.as_ref().as_.heap.aux.shared);
 
-                        let child_offset =
-                            mmap_len as isize - raw_str.as_ref().as_.heap.len as isize;
+                        let child_offset = mmap_len as isize - str.len() as isize;
                         assert_eq!(mmap_ptr.offset(child_offset), raw_str.as_ref().as_.heap.ptr);
 
                         child_checked = true;
@@ -781,7 +790,7 @@ mod test {
                         assert_eq!(parent_id, str.as_raw());
 
                         assert_eq!(mmap_ptr, raw_str.as_ref().as_.heap.ptr);
-                        assert_eq!(mmap_len as c_long, raw_str.as_ref().as_.heap.len);
+                        assert_eq!(mmap_len as c_long, str.len() as c_long);
                         assert!(raw_str.as_ref().basic.flags & (STR_SHARED | STR_NOEMBED) > 0);
                         assert!(str.is_frozen());
 

data/lib/prometheus/client/configuration.rb

@@ -14,7 +14,7 @@ module Prometheus
         @initial_mmap_file_size = ::Prometheus::Client::PageSize.page_size(fallback_page_size: 4096)
         @logger = Logger.new($stdout)
         @pid_provider = Process.method(:pid)
-        @rust_multiprocess_metrics = ENV.fetch('prometheus_rust_multiprocess_metrics', nil) == 'true'
+        @rust_multiprocess_metrics = ENV.fetch('prometheus_rust_multiprocess_metrics', 'true') == 'true'
         @multiprocess_files_dir = ENV.fetch('prometheus_multiproc_dir') do
           Dir.mktmpdir("prometheus-mmap")
         end

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

@@ -27,7 +27,7 @@ module Prometheus
             Helper::MetricsRepresentation.to_text(metrics)
           end
 
-          def marshal_multiprocess(path = Prometheus::Client.configuration.multiprocess_files_dir, use_rust: false)
+          def marshal_multiprocess(path = Prometheus::Client.configuration.multiprocess_files_dir, use_rust: true)
             file_list = Dir.glob(File.join(path, '*.db')).sort
               .map {|f| Helper::PlainFile.new(f) }
               .map {|f| [f.filepath, f.multiprocess_mode.to_sym, f.type.to_sym, f.pid] }

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

@@ -14,7 +14,7 @@ module Prometheus
   module Client
     module Helper
       # We can't check `Prometheus::Client.configuration` as this creates a circular dependency
-      if (ENV.fetch('prometheus_rust_mmaped_file', nil) == "true" &&
+      if (ENV.fetch('prometheus_rust_mmaped_file', 'true') == "true" &&
           Prometheus::Client::Helper::Loader.rust_impl_available?)
         class MmapedFile < FastMmapedFileRs
         end

data/lib/prometheus/client/version.rb

@@ -1,5 +1,5 @@
 module Prometheus
   module Client
-    VERSION = '0.24.5'.freeze
+    VERSION = '0.26.0'.freeze
   end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: prometheus-client-mmap
 version: !ruby/object:Gem::Version
-  version: 0.24.5
+  version: 0.26.0
 platform: ruby
 authors:
 - Tobias Schmidt
 - Paweł Chojnacki
 - Stan Hu
 - Will Chandler
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-13 00:00:00.000000000 Z
+date: 2023-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys
@@ -117,7 +117,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.16.2
-description: 
+description:
 email:
 - ts@soundcloud.com
 - pawel@gitlab.com
@@ -152,6 +152,7 @@ files:
 - ext/fast_mmaped_file_rs/Cargo.lock
 - ext/fast_mmaped_file_rs/Cargo.toml
 - ext/fast_mmaped_file_rs/README.md
+- ext/fast_mmaped_file_rs/build.rs
 - ext/fast_mmaped_file_rs/extconf.rb
 - ext/fast_mmaped_file_rs/src/error.rs
 - ext/fast_mmaped_file_rs/src/file_entry.rs
@@ -217,7 +218,7 @@ homepage: https://gitlab.com/gitlab-org/prometheus-client-mmap
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -233,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.26
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A suite of instrumentation metric primitivesthat can be exposed through a
   web services interface.