Bump yabeda-prometheus from 0.1.4 to 0.1.5 #283

dependabot-preview · 2019-12-31T13:19:45Z

Bumps yabeda-prometheus from 0.1.4 to 0.1.5.

Changelog

Sourced from yabeda-prometheus's changelog.

0.1.5 - 2019-10-15

Fixed

Issue #7 with counters and gauges when using prometheus-client-mmap gem. Fixed in #8 by [@alexander37137]

Commits

3ff352f Release v0.1.5 with fix for counters with prometheus-client-mmap
ff28135 Clean up unused code after changes in #8
a702bf5 Fix for counter metricts with prometheus-client-mmap (#8)
See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR
@dependabot recreate will recreate this PR, overwriting any edits that have been made to it
@dependabot merge will merge this PR after your CI passes on it
@dependabot squash and merge will squash and merge this PR after your CI passes on it
@dependabot cancel merge will cancel a previously requested merge and block automerging
@dependabot reopen will reopen this PR if it is closed
@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
@dependabot use these labels will set the current labels as the default for future PRs for this repo and language
@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language
@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language
@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language
@dependabot badge me will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot dashboard:

Update frequency (including time of day and day of week)
Pull request limits (per update run and/or open at any time)
Automerge options (never/patch/minor, and dev/runtime dependencies)
Out-of-range updates (receive only lockfile updates, if desired)
Security updates (receive only security updates, if desired)

Tests are failing :(

guicassolato

About the test failing...

This is because of a change in the Yabeda Ruby gem: https://github.com/yabeda-rb/yabeda/compare/v0.1.3..v0.8.0. Particularly, the way Yabeda.configure works.

TL;DR
There is a now a new method Yabeda.configure! (with the bang) that needs to be called once (and only once) after all "configurators" have been called.

The long story
Yabeda.configure can be still called multiple times. It is usually – always, actually, in zync's case – called when the classes, modules, etc are loaded. When the ActiveJobSubscriber class is loaded, Yabeda.configure is called once, for a group named que. In the old version of https://github.com/yabeda-rb/yabeda (currently in zync's master branch), whenever Yabeda.configure was invoked with a group, the gem "registered" this group name in its internal cache of groups of metrics.

This was of course also the case of when ActiveJobSubscriber invoked Yabeda.configure – the gem then registered a group called que and also defined a singleton class method Yabeda.que. Later on, when the application was already running and some event created a job, an instance of ActiveJobSubscriber was initiated, which called Yabeda.que. The method exists because it was "registered" in the gem.

The new version of the yabeda gem now demands an invocation of another method to effectively register groups and metrics. This new method is the Yabeda.configure! method (with a bang). The new recommended usage is: first, store all "configurators" by calling Yabeda.configure with a block as many times as you want, then call Yabeda.configure! once and only once. It is only after calling this new method that the gem will really register the groups and metrics and therefore also create any corresponding singleton class methods (e.g. Yabeda.que).

In this PR, since we aren't invoking Yabeda.configure! anywhere, the groups and metrics haven't been registered. Possibly, by just adding Yabeda.configure! to https://github.com/3scale/zync/blob/master/config/initializers/prometheus.rb, the problem will be fixed, but we must be careful, because there's also another process that we start in OpenShift that configures Yabeda groups and metrics, i.e. the zync-que process. This process requires another ruby file, https://github.com/3scale/zync/blob/master/lib/que/prometheus.rb. However, if we invoke Yabeda.configure! from this file as well, it will not work, because, as I mentioned, this method can be called only once.

In the end, we may need to move some code, perhaps rearrange the order Yabeda.configure is called the multiple times and then ensure Yabeda.configure! is called, once and only once, for both processes, i.e., the Rails server and the zync que process.

hallelujah · 2021-03-03T15:14:00Z

@guicassolato Yes I am working at it

Registering then configuring is the way to go, otherwise you could override some configurations ... Nothing wrong in Yabeda fixing it.

The issue lies on attach_to

zync/lib/prometheus/active_job_subscriber.rb

Line 81 in 82e4cd7

attach_to :active_job

which is creating a new instance in the definition of the class ...

# File activesupport/lib/active_support/subscriber.rb, line 30
      def attach_to(namespace, subscriber = new, notifier = ActiveSupport::Notifications)
        @namespace  = namespace
        @subscriber = subscriber
        @notifier   = notifier

        subscribers << subscriber

        # Add event subscribers for all existing methods on the class.
        subscriber.public_methods(false).each do |event|
          add_event_subscriber(event)
        end
      end

We must do that after Yabeda.configure! because the https://github.com/yabeda-rb/yabeda/blob/bd3b49fe0fd293fe6ac2d29f9e04fa5bdde79b0c/lib/yabeda/dsl/class_methods.rb#L85 is not yet called

The way our code is organized is a bit disorganized :)
So I am reorganizing it to have attach_to called at the very last, at least after Yabeda.configure!

Commit coming soon but the idea is to use https://guides.rubyonrails.org/configuring.html#initialization-events

Signed-off-by: HemaHG <hhg@redhat.com>

hallelujah · 2021-03-09T11:53:31Z

lib/prometheus/active_record.rb

-    waiting = gauge :waiting, comment: 'Number of waiting in the queue of the connection pool'
-
-    no_labels = {}.freeze
+    no_labels = { state: nil }.freeze


This is because you can't set different labels (empty and other with :state) to the same gauge
A gauge needs to consistently set the same labels

hallelujah · 2021-03-09T11:54:05Z

lib/prometheus/active_record.rb

+    size = gauge :size, comment: 'Size of the connection pool'
+    connections = gauge :connections, comment: 'Number of connections in the connection pool'
+    waiting = gauge :waiting, comment: 'Number of waiting in the queue of the connection pool'
+


Just moved the definition of gauges below the labels

hallelujah · 2021-03-09T11:54:54Z

lib/prometheus/que_stats.rb

@@ -30,7 +30,7 @@ def execute

    class WorkerStats < Stats
      WORKER_STATS = <<~SQL
-        SELECT SUM(worker_count) AS workers_count, COUNT(*) AS nodes_count FROM que_lockers
+        SELECT COALESCE(SUM("worker_count"),0) AS workers_count, COUNT(*) AS nodes_count FROM que_lockers


If no record or the worker_count column is NULL then SUM will return nil
The gem update validates the value is an number

hallelujah · 2021-03-09T11:57:33Z

lib/prometheus/que_stats.rb

@@ -101,7 +101,7 @@ def expired
      JOB_CLASSES = %w[ApplicationJob ProcessEntryJob ProcessIntegrationEntryJob UpdateJob].inspect.tr('"', "'").freeze
      private_constant :JOB_CLASSES

-      JOB_CLASS_COLUMN_NAME = 'job'
+      JOB_CLASS_COLUMN_NAME = 'job_name'


job is a reserved label.
It was not validated before this update

yabeda-rb/yabeda-prometheus@v0.1.4...v0.1.5#diff-22016af103dc675d6642ae3cc94786811e87be9e35d53e38fbc416a011168fd8R27

hallelujah · 2021-03-09T11:58:14Z

lib/prometheus/que_stats.rb

@@ -136,7 +136,7 @@ def call(type = nil)
      protected

      def type_hash_and_stats_count(type)
-        type_hash = type ? { type: type } : {}
+        type_hash = { type: type }


Not sending an empty hash, same as https://github.com/3scale/zync/pull/283/files#diff-f903aea79c99fca32c1fafbb2b9e0cd134020edf41088b78f090b2a00faf7978R5

hallelujah · 2021-03-09T11:58:31Z

lib/prometheus/que_stats.rb

@@ -153,7 +153,7 @@ def initialize(gauge, stats, grouped_by:)
      def call(type = nil)
        type_hash, grouped_stats_count = type_hash_and_stats_count(type)
        grouped_stats_count.each do |stats_count|
-          gauge.set({ grouped_by => stats_count.fetch(grouped_by) }.merge(type_hash), stats_count.fetch('count'))
+          gauge.set({ grouped_by.to_sym => stats_count.fetch(grouped_by) }.merge(type_hash), stats_count.fetch('count'))


labels must be Symbol

hallelujah · 2021-03-09T11:58:46Z

lib/prometheus/que_stats.rb

@@ -173,7 +173,7 @@ def call(type = nil)
  group :que do
    jobs = gauge :jobs_scheduled_total, comment: 'Que Jobs to be executed'
    job_stats = Prometheus::QueStats::JobStats.new
-    collector = Prometheus::QueStats::GroupedStatsCollector.new(jobs, job_stats, grouped_by: 'job')
+    collector = Prometheus::QueStats::GroupedStatsCollector.new(jobs, job_stats, grouped_by: 'job_name')


job is a reserved label

Done

hallelujah · 2021-03-09T13:06:02Z

config/initializers/prometheus.rb

@@ -1,2 +1,5 @@
 require 'prometheus/active_job_subscriber'
 require 'prometheus/active_record'
+
+Yabeda.configure! if Yabeda.respond_to?(:configure!)
+Prometheus::ActiveJobSubscriber.attach_to :active_job


This needs to be called after the Yabeda.configure! otherwise it will instanciate a Prometheus::ActiveJobSubscriber instance in the class definition which is not possible because it uses a not yet defined Yabeda.que method

* COALESCE a sum for que workers * Rename `job` label to `job_name` * Call `Yabeda.configure!`` after all definition * `attach_to :active_job` subscriber after Yabeda.configure! otherwise `Yabeda.que` is not defined

dependabot-preview bot added the dependencies Pull requests that update a dependency file label Dec 31, 2019

dependabot-preview bot force-pushed the dependabot/bundler/yabeda-prometheus-0.1.5 branch 7 times, most recently from 90fa83f to 472869a Compare January 2, 2020 12:20

dependabot-preview bot force-pushed the dependabot/bundler/yabeda-prometheus-0.1.5 branch from 472869a to 2b56fda Compare February 12, 2020 16:45

dependabot-preview bot force-pushed the dependabot/bundler/yabeda-prometheus-0.1.5 branch 2 times, most recently from 3dcd870 to cf9bbbb Compare April 23, 2020 17:11

dependabot-preview bot force-pushed the dependabot/bundler/yabeda-prometheus-0.1.5 branch 3 times, most recently from 0710fb5 to 72bcf1a Compare May 19, 2020 09:16

dependabot-preview bot force-pushed the dependabot/bundler/yabeda-prometheus-0.1.5 branch from 72bcf1a to 62f01b2 Compare June 6, 2020 15:58

dependabot-preview bot force-pushed the dependabot/bundler/yabeda-prometheus-0.1.5 branch 3 times, most recently from b3dc46b to 8f94a15 Compare July 2, 2020 09:57

dependabot-preview bot force-pushed the dependabot/bundler/yabeda-prometheus-0.1.5 branch 2 times, most recently from 726bb5c to dc4abe4 Compare August 25, 2020 09:23

hallelujah previously approved these changes Aug 25, 2020

View reviewed changes

dependabot-preview bot dismissed hallelujah’s stale review via 40176eb September 15, 2020 12:57

dependabot-preview bot force-pushed the dependabot/bundler/yabeda-prometheus-0.1.5 branch 6 times, most recently from 7a17052 to d6f1b72 Compare September 16, 2020 12:23

dependabot-preview bot force-pushed the dependabot/bundler/yabeda-prometheus-0.1.5 branch 2 times, most recently from 14ad65d to e247aa0 Compare February 16, 2021 07:05

dependabot-preview bot force-pushed the dependabot/bundler/yabeda-prometheus-0.1.5 branch 7 times, most recently from ea50828 to 43a858c Compare February 22, 2021 12:43

hemahg force-pushed the dependabot/bundler/yabeda-prometheus-0.1.5 branch from 43a858c to d93d1c5 Compare February 24, 2021 07:42

hallelujah previously approved these changes Feb 24, 2021

View reviewed changes

guicassolato previously requested changes Mar 3, 2021

View reviewed changes

hallelujah self-assigned this Mar 3, 2021

Bump yabeda-prometheus from 0.1.4 to 0.1.5

7aae374

Signed-off-by: HemaHG <hhg@redhat.com>

hallelujah force-pushed the dependabot/bundler/yabeda-prometheus-0.1.5 branch from 8406341 to 21aac65 Compare March 9, 2021 11:52

hallelujah reviewed Mar 9, 2021

View reviewed changes

hallelujah previously approved these changes Mar 9, 2021

View reviewed changes

hallelujah requested a review from guicassolato March 9, 2021 13:02

hallelujah reviewed Mar 9, 2021

View reviewed changes

[yabeda] Fix configuration of yabeda prometheus

7706422

* COALESCE a sum for que workers * Rename `job` label to `job_name` * Call `Yabeda.configure!`` after all definition * `attach_to :active_job` subscriber after Yabeda.configure! otherwise `Yabeda.que` is not defined

hallelujah dismissed their stale review via 7706422 March 9, 2021 16:25

hallelujah force-pushed the dependabot/bundler/yabeda-prometheus-0.1.5 branch from 21aac65 to 7706422 Compare March 9, 2021 16:25

hallelujah approved these changes Mar 9, 2021

View reviewed changes

hallelujah merged commit 7d7ca2f into master Mar 9, 2021

hallelujah deleted the dependabot/bundler/yabeda-prometheus-0.1.5 branch March 9, 2021 17:49

slopezz mentioned this pull request Jul 2, 2021

Fix zync grafana dashboard 3scale-ops/saas-operator#114

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bump yabeda-prometheus from 0.1.4 to 0.1.5 #283

Bump yabeda-prometheus from 0.1.4 to 0.1.5 #283

dependabot-preview bot commented Dec 31, 2019 •

edited

Loading

guicassolato left a comment

hallelujah commented Mar 3, 2021 •

edited

Loading

hallelujah Mar 9, 2021

hallelujah Mar 9, 2021

hallelujah Mar 9, 2021

hallelujah Mar 9, 2021

hallelujah Mar 9, 2021

hallelujah Mar 9, 2021

hallelujah Mar 9, 2021

hallelujah Mar 9, 2021

Bump yabeda-prometheus from 0.1.4 to 0.1.5 #283

Bump yabeda-prometheus from 0.1.4 to 0.1.5 #283

Conversation

dependabot-preview bot commented Dec 31, 2019 • edited Loading

0.1.5 - 2019-10-15

Fixed

guicassolato left a comment

Choose a reason for hiding this comment

hallelujah commented Mar 3, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dependabot-preview bot commented Dec 31, 2019 •

edited

Loading

hallelujah commented Mar 3, 2021 •

edited

Loading