Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rnd-soft/prometheus-enumerated-store

Enchanced File Store for ruby Prometheus library
https://github.com/rnd-soft/prometheus-enumerated-store

Last synced: about 7 hours ago
JSON representation

Enchanced File Store for ruby Prometheus library

Host: GitHub
URL: https://github.com/rnd-soft/prometheus-enumerated-store
Owner: RND-SOFT
License: mit
Created: 2023-09-12T14:45:28.000Z (about 1 year ago)
Default Branch: master
Last Pushed: 2023-09-15T08:03:34.000Z (about 1 year ago)
Last Synced: 2023-09-15T23:27:57.470Z (about 1 year ago)
Language: Ruby
Size: 15.6 KB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Enumerated File Store



[![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_vuln.svg)](https://lysander.rnds.pro/api/v1/badges/enumerated_vuln.html)



`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).



  

    

  



## Возможности / 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).