prometheus_enumerated_store 0.0.1.183933

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 514c84eb0f23127b7ecf237e33f32a5e4b33c7b63437feecde65e44bf4a085ec
+  data.tar.gz: 1ae0fc91c573feb22cdfe1110f176ddd408ed7feed9ec9aed8cf9115a67bfe4e
+SHA512:
+  metadata.gz: a6093fada7f4b37ba58bc68ce5a92a9a87437c9c6249dfb8c2e16431db13f7aa755aa992a7dd917acd7177ee462175367b3248f6fe7db5cb7bec4f63ac20f5b9
+  data.tar.gz: abefba09ff32857c324cf36953cce55c72a71a91cdcb6d435b2d0fc47673bdd17dd2dede0e213a84e1d8be9b2cc66ac3f5e17c39ac4fe1c1d6ad37f6465fcb6d

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014-2023 Рнд Софт
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# Enumerated File Store
+
+<div align="center">
+
+[![Gem Version](https://badge.fury.io/rb/prometheus_enumerated_store.svg)](https://rubygems.org/gems/prometheus_enumerated_store)
+[![Gem](https://img.shields.io/gem/dt/prometheus_enumerated_store.svg)](https://rubygems.org/gems/prometheus_enumerated_store/versions)
+[![YARD](https://badgen.net/badge/YARD/doc/blue)](http://www.rubydoc.info/gems/prometheus_enumerated_store)
+
+
+[![coverage](https://lysander.rnds.pro/api/v1/badges/enumerated_coverage.svg)](https://lysander.rnds.pro/api/v1/badges/enumerated_coverage.html)
+[![quality](https://lysander.rnds.pro/api/v1/badges/enumerated_quality.svg)](https://lysander.rnds.pro/api/v1/badges/enumerated_quality.html)
+[![outdated](https://lysander.rnds.pro/api/v1/badges/enumerated_outdated.svg)](https://lysander.rnds.pro/api/v1/badges/enumerated_outdated.html)
+[![vulnerable](https://lysander.rnds.pro/api/v1/badges/enumerated_vulnerable.svg)](https://lysander.rnds.pro/api/v1/badges/enumerated_vulnerable.html)
+
+</div>
+
+`Enumerated File Store` - это гем для реализации [специального Data Store](https://github.com/prometheus/client_ruby#data-stores) для библиотеки [prometheus-client](https://github.com/prometheus/client_ruby).
+
+Данная библиотека решает [проблему огромного числа файлов-метрик](https://github.com/prometheus/client_ruby/issues/143) при использовании стандартного [DirectFileStore](https://github.com/prometheus/client_ruby#directfilestore-caveats-and-things-to-keep-in-mind)
+
+---
+
+`Enumerated File Store` provides [custom Data Store](https://github.com/prometheus/client_ruby#data-stores) for [prometheus-client](https://github.com/prometheus/client_ruby) library.
+
+It fixes issue with [too many files for long running applications](https://github.com/prometheus/client_ruby/issues/143) when using [DirectFileStore](https://github.com/prometheus/client_ruby#directfilestore-caveats-and-things-to-keep-in-mind).
+
+<div align="left">
+  <a href="https://rnds.pro/" >
+    <img src="https://library.rnds.pro/repository/public-blob/logo/RNDS.svg" alt="Supported by RNDSOFT"  height="60">
+  </a>
+</div>
+
+## Возможности / Features
+
+Библиоетка использует последовательное присвоение номеров файлам метри вместо использования PID / It uses sequential numbering for metric filenames instead of PID-stamps.
+
+
+## Начало работы / Getting started
+
+```sh
+gem install prometheus-enumerated-store
+```
+
+При установке `prometheus_enumerated_store` через bundler добавьте следующую строку в `Gemfile`:
+
+---
+
+If you'd rather install `prometheus_enumerated_store` using bundler, add a line for it in your `Gemfile`:
+
+```sh
+gem 'prometheus_enumerated_store'
+```
+
+Затем выполните / Then run:
+
+```sh
+bundle install # для установки гема / gem installation
+
+```
+## Использование / Usage
+
+Для использования необходимо в каком-нибудь файле `config/initializers/` настройить `Data Store` для библиотеки `prometheus-client`:
+
+---
+
+Now you need to set `Data Store` for `prometheus-client` gem somewhere in  `config/initializers/`:
+
+
+```ruby
+Prometheus::Client.config.data_store = Prometheus::Enumerated::Store.new(dir: Rails.root.join('tmp', 'prometheus_metrics'))
+
+if defined?(PhusionPassenger)
+  PhusionPassenger.on_event(:starting_worker_process) do |_forked|
+    Prometheus::Client.config.data_store.reset
+  end
+end
+
+
+# Or somewhere in Pum config if any:
+
+on_restart do
+  Prometheus::Client.config.data_store.reset
+end
+
+on_worker_boot do
+  Prometheus::Client.config.data_store.reset
+end
+```
+
+## Лицензия / License
+
+Библиотека доступна с открытым исходным кодом в соответствии с условиями [лицензии MIT](./LICENSE).
+
+---
+
+The gem is available as open source under the terms of the [MIT License](./LICENSE).
+

data/lib/prometheus/enumerated-store.rb

@@ -0,0 +1 @@
+require_relative 'enumerated_store'

data/lib/prometheus/enumerated_store/pid_enumerator.rb

@@ -0,0 +1,95 @@
+module Prometheus
+  # Класс мапит текущий PID на минимальный "свободный" номер
+  # "свободность" определяется по принципу процесс с пидом есть? - значит занято
+  # реестр хранится в файле в виде {"22655":1,"22760":2,"22813":3,"22832":4}
+  #  где слева PID, справа занятый им (когда-то) номер
+  # Информация актуализируется (удаляются несуществующие записи) при очередном выделении
+  # многопроцессность синхронизируется через механизм эксключзивных блокировок flock
+  module EnumeratedStore
+    class PidEnumerator
+
+      MAX_INSTANCES = 1000
+
+      attr_reader :dir, :instances_path, :lock_path
+
+      def initialize(dir:)
+        @dir = dir
+
+        @lock_path = File.join(@dir, 'enumetated_instances.lock')
+        @instances_path = File.join(@dir, 'enumetated_instances.json')
+        reset
+      end
+
+      def reset
+        @obtained = nil
+      end
+
+      def with_lock
+        File.open(lock_path, File::RDWR | File::CREAT, 0o644) do |file|
+          file.flock(File::LOCK_EX)
+          Dir.chdir(@dir) do
+            tmpfilename = ".tmp-#{$$}-#{rand(0x100000000).to_s(36)}.json"
+            yield(tmpfilename)
+          ensure
+            File.delete(tmpfilename) rescue nil
+          end
+        end
+      end
+
+      def read_instances
+        raw = File.read(instances_path).strip
+        raw.empty? ? '{}' : raw
+      rescue Errno::ENOENT
+        # there is no file yet
+        '{}'
+      end
+
+      def obtained
+        @obtained ||= obtain_enumerated_number
+      end
+
+      def obtain_enumerated_number
+        with_lock do |tmpfilename|
+          break @obtained if @obtained # double check-lock
+
+          raw_data = read_instances
+          data = JSON.parse(raw_data) || {} # set {} if "null" in file
+          data = clean_dead_instances(data)
+
+          current = find_minimal_number(data)
+          File.write(tmpfilename, data.to_json) # We are inside tmpdir
+          File.rename(tmpfilename, instances_path)
+          current
+        end
+      end
+
+      def find_minimal_number(data)
+        values = data.values
+        current = data[Process.pid.to_s] || (1..MAX_INSTANCES).find{|i| !values.include?(i) }
+        raise "Unable to find any number between 1 and #{MAX_INSTANCES}" unless current
+
+        data[Process.pid.to_s] = current
+      end
+
+      def clean_dead_instances(data)
+        data.select do |pid, num|
+          next nil if num.to_i <= 0 || num.to_i > MAX_INSTANCES
+
+          alive?(pid.to_i)
+        end
+      end
+
+      def alive?(pid)
+        return nil if pid <= 1
+
+        Process.getpgid(pid)
+        true
+      rescue Errno::ESRCH
+        false
+      end
+
+
+    end
+  end
+end
+

data/lib/prometheus/enumerated_store/store.rb

@@ -0,0 +1,35 @@
+require 'prometheus/client/data_stores/direct_file_store'
+
+module Prometheus
+  module EnumeratedStore
+    class Store < Prometheus::Client::DataStores::DirectFileStore
+
+      attr_reader :pid_enumerator
+
+      def initialize(*_args, dir:, **_kwargs)
+        super
+        @pid_enumerator = PidEnumerator.new(dir: dir)
+        # pass enumerator through store_settings to every MetricStore
+        @store_settings[:pid_enumerator] = @pid_enumerator
+      end
+
+      def reset
+        @pid_enumerator.reset
+      end
+
+      def self.metric_store_class
+        MetricStore
+      end
+
+      MetricStore.class_eval do
+        # Monkeypatch! there is no normal method to overload filename generation
+        # https://github.com/prometheus/client_ruby/blob/e144d6225d3c346e9a4dd0a11f41f8acde386dd8/lib/prometheus/client/data_stores/direct_file_store.rb#L190
+        def process_id
+          @store_settings[:pid_enumerator].obtained
+        end
+      end
+
+    end
+  end
+end
+

data/lib/prometheus/enumerated_store/version.rb

@@ -0,0 +1,8 @@
+module Prometheus
+  module EnumeratedStore
+
+    VERSION = '0.0.1'.freeze
+
+  end
+end
+

data/lib/prometheus/enumerated_store.rb

@@ -0,0 +1,11 @@
+require 'prometheus/enumerated_store/version'
+require 'prometheus/enumerated_store/pid_enumerator'
+require 'prometheus/enumerated_store/store'
+
+
+module Prometheus
+  module EnumeratedStore
+
+  end
+end
+

data/lib/prometheus-enumerated-store.rb

@@ -0,0 +1 @@
+require_relative 'prometheus_enumerated_store'

data/lib/prometheus_enumerated_store.rb

@@ -0,0 +1,5 @@
+require 'prometheus/enumerated_store'
+
+module Prometheus
+end
+

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: prometheus_enumerated_store
+version: !ruby/object:Gem::Version
+  version: 0.0.1.183933
+platform: ruby
+authors:
+- Samoilenko Yuri
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prometheus-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Enchanced File Store for ruby Prometheus library
+email:
+- kinnalru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/prometheus-enumerated-store.rb
+- lib/prometheus/enumerated-store.rb
+- lib/prometheus/enumerated_store.rb
+- lib/prometheus/enumerated_store/pid_enumerator.rb
+- lib/prometheus/enumerated_store/store.rb
+- lib/prometheus/enumerated_store/version.rb
+- lib/prometheus_enumerated_store.rb
+homepage: https://github.com/RnD-Soft/prometheus_enumerated_store
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Enchanced File Store for ruby Prometheus library
+test_files: []