prometheus-client-mmap 0.25.0-x86_64-linux → 0.26.1-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8392f2d676133039741efc162c8365a692a8dd3ce2d584af4a97f40ed39981db
-  data.tar.gz: '01139643ee538a1c765f86cc54c2ab36a72282d6484378ba713041f30385ece8'
+  metadata.gz: a4ade5caf1a2ec3858fd08bb0ed14320a0161a993c09ba196e33bbb44c94e239
+  data.tar.gz: 68bd8a66570599e9081383080857eb1dbde4b9d8e05f8e7df8274de3cfeedbfd
 SHA512:
-  metadata.gz: 9bace69a5e6398cc35ee32aad8b0ca99229e6e5313b6a9bb4f54aa767c24ddef2780c89759ce17586732c82d456782a53818dae8d9cf459962c894324f690b3e
-  data.tar.gz: 6b13dc1cad92df550e802addaceec0891d720ee602b1083cc8e82cd35523b3ca74614c171fe13300992b342fba67bc16374718629a794246031f76a6cf0f7ce3
+  metadata.gz: acb4b2fedbc1486d4e8b576e2d9afe9efb13776bc73238045db5a20af34a2e45ee5790992a7b9f25c264c5685e91443103fa56edfb2831e215455d01f3c5ad3d
+  data.tar.gz: af443c257293a85694d9e6b59532b93e38a3cfb1267c6b0bae53365256cd2ed5f10aa67043d3e83bfce8359ac330893be5c3114a9c8dcc02bcc04f80c4328ed2

data/README.md

@@ -10,7 +10,24 @@ through a HTTP interface. Intended to be used together with a
 
 [![Gem Version][4]](http://badge.fury.io/rb/prometheus-client-mmap)
 [![Build Status][3]](https://gitlab.com/gitlab-org/prometheus-client-mmap/commits/master)
-[![Dependency Status][5]](https://gemnasium.com/prometheus/prometheus-client-mmap)
+
+## Installation
+
+prometheus-client-mmap ships with [precompiled native gems](https://rubygems.org/gems/prometheus-client-mmap).
+Install the gem via:
+
+```shell
+gem install prometheus-client-mmap
+```
+
+### Requirements for building from source
+
+Building from source requires a number of dependencies:
+
+* Rust v1.65+
+* clang 5.0 or higher for [bindgen](https://rust-lang.github.io/rust-bindgen/requirements.html)
+* `make`
+* A C compiler (for legacy extension, which will be removed soon)
 
 ## Usage
 
@@ -34,9 +51,9 @@ 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
+In an effort to improve maintainability, there is now a Rust
 implementation that reads the metric files and outputs the multiprocess
 metrics to text. If `rustc` is available, then the Rust extension will
 be built automatically. The `use_rust` keyword argument can be used:
@@ -45,8 +62,10 @@ be built automatically. The `use_rust` keyword argument can be used:
 puts Prometheus::Client::Formats::Text.marshal_multiprocess(use_rust: true)
 ```
 
+Starting with v0.26.0, `use_rust` defaults to `true`.
+
 Note that this parameter will likely be deprecated and removed once the Rust
-extension becomes the default mode.
+extension becomes the only supported mode.
 
 ### Rack middleware
 
@@ -202,14 +221,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/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/loader.rb

@@ -29,7 +29,11 @@ module Prometheus
               load_rust_extension
               true
             rescue LoadError
-              Prometheus::Client.logger.info('FastMmapedFileRs unavailable')
+              warn <<~WARN
+WARNING: The Rust extension for prometheus-client-mmap is unavailable, falling back to the legacy C extension.
+  The Rust extension will be required in the next version. If you are compiling this gem from source,
+  ensure your build system has a Rust compiler and clang: https://gitlab.com/gitlab-org/ruby/gems/prometheus-client-mmap
+WARN
               false
             end
           end

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.25.0'.freeze
+    VERSION = '0.26.1'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prometheus-client-mmap
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.1
 platform: x86_64-linux
 authors:
 - Tobias Schmidt
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-15 00:00:00.000000000 Z
+date: 2023-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys