Rename job attribute to name to fix prometheus reserved key error

yabeda-rb · Apr 5, 2021 · c5bec1b · c5bec1b
1 parent e561934
commit c5bec1b
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,8 +7,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Fixed
+
+- Rename `job` attribute to `name` to fix prometheus reserved key error. [@skryukov]
+
 ## 0.1.0 (2021-04-03)
 
+### Added
+
 - Initial release of yabeda-schked gem. [@skryukov]
 
 [@skryukov]: https://github.com/skryukov
diff --git a/lib/yabeda/schked.rb b/lib/yabeda/schked.rb
@@ -26,19 +26,19 @@ def self.job_name(job)
       group :schked
 
       counter :jobs_executed_total,
-        tags: %i[job success],
+        tags: %i[name success],
         comment: "A counter of the number of jobs executed."
 
       histogram :job_execution_runtime,
         comment: "A histogram of the job execution time.",
         unit: :seconds,
         per: :job,
-        tags: %i[job success],
+        tags: %i[name success],
         buckets: LONG_RUNNING_JOB_RUNTIME_BUCKETS
     end
 
     ::Schked.config.register_callback(:after_finish) do |job|
-      labels = {success: !job.opts[:failed], job: job_name(job)}
+      labels = {success: !job.opts[:failed], name: job_name(job)}
       Yabeda.schked.job_execution_runtime.measure(labels, job.last_work_time.round(3))
       Yabeda.schked.jobs_executed_total.increment(labels)
     end

diff --git a/spec/yabeda/schked_spec.rb b/spec/yabeda/schked_spec.rb
@@ -19,10 +19,10 @@
         job.trigger_off_schedule
 
         expect(Yabeda.schked.jobs_executed_total.values).to include(
-          {job: job_name, success: true} => 1
+          {name: job_name, success: true} => 1
         )
         expect(Yabeda.schked.job_execution_runtime.values).to include(
-          {job: job_name, success: true} => kind_of(Numeric)
+          {name: job_name, success: true} => kind_of(Numeric)
         )
       end
     end
@@ -37,10 +37,10 @@
         job.trigger_off_schedule
 
         expect(Yabeda.schked.jobs_executed_total.values).to include(
-          {job: job_name, success: false} => 1
+          {name: job_name, success: false} => 1
         )
         expect(Yabeda.schked.job_execution_runtime.values).to include(
-          {job: job_name, success: false} => kind_of(Numeric)
+          {name: job_name, success: false} => kind_of(Numeric)
         )
       end
     end
@@ -56,10 +56,10 @@
           /Warning: No name specified for the job/
         ).to_stderr
         expect(Yabeda.schked.jobs_executed_total.values).to include(
-          {job: "none", success: true} => 1
+          {name: "none", success: true} => 1
         )
         expect(Yabeda.schked.job_execution_runtime.values).to include(
-          {job: "none", success: true} => kind_of(Numeric)
+          {name: "none", success: true} => kind_of(Numeric)
         )
       end
     end