From 94b672c094846421843552fa07403ca3afff5da7 Mon Sep 17 00:00:00 2001 From: "Ben Sheldon [he/him]" Date: Fri, 5 Jul 2024 18:22:28 -0700 Subject: [PATCH] Add initial Performance panel to dashboard (#1388) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --------- Co-authored-by: Arnaud Levy Co-authored-by: Arnaud Levy Co-authored-by: Sébastien Gaya --- .../good_job/performances_controller.rb | 23 +++++++++ app/helpers/good_job/application_helper.rb | 1 + .../good_job/performances/index.html.erb | 50 +++++++++++++++++++ app/views/good_job/shared/_navbar.erb | 5 ++ config/locales/de.yml | 11 ++++ config/locales/en.yml | 11 ++++ config/locales/es.yml | 11 ++++ config/locales/fr.yml | 11 ++++ config/locales/it.yml | 11 ++++ config/locales/ja.yml | 11 ++++ config/locales/ko.yml | 11 ++++ config/locales/nl.yml | 11 ++++ config/locales/pt-BR.yml | 11 ++++ config/locales/ru.yml | 11 ++++ config/locales/tr.yml | 11 ++++ config/locales/uk.yml | 11 ++++ config/routes.rb | 2 + demo/db/seeds.rb | 5 +- .../good_job/performances_controller_spec.rb | 22 ++++++++ spec/system/performance_spec.rb | 19 +++++++ 20 files changed, 258 insertions(+), 1 deletion(-) create mode 100644 app/controllers/good_job/performances_controller.rb create mode 100644 app/views/good_job/performances/index.html.erb create mode 100644 spec/app/controllers/good_job/performances_controller_spec.rb create mode 100644 spec/system/performance_spec.rb diff --git a/app/controllers/good_job/performances_controller.rb b/app/controllers/good_job/performances_controller.rb new file mode 100644 index 000000000..afbcd3f5e --- /dev/null +++ b/app/controllers/good_job/performances_controller.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +module GoodJob + class PerformancesController < ApplicationController + def index + if GoodJob::DiscreteExecution.monotonic_duration_migrated? + @performances = GoodJob::DiscreteExecution + .where.not(job_class: nil) + .group(:job_class) + .select(" + job_class, + COUNT(*) AS executions_count, + AVG(duration) AS avg_duration, + MIN(duration) AS min_duration, + MAX(duration) AS max_duration + ") + .order("job_class") + else + @needs_upgrade = true + end + end + end +end diff --git a/app/helpers/good_job/application_helper.rb b/app/helpers/good_job/application_helper.rb index 39558e6b7..4fa12f4b0 100644 --- a/app/helpers/good_job/application_helper.rb +++ b/app/helpers/good_job/application_helper.rb @@ -9,6 +9,7 @@ module ApplicationHelper def format_duration(sec) return unless sec + return "" if sec.is_a?(String) # pg interval support added in Rails 6.1 if sec < 1 t 'good_job.duration.milliseconds', ms: (sec * 1000).floor diff --git a/app/views/good_job/performances/index.html.erb b/app/views/good_job/performances/index.html.erb new file mode 100644 index 000000000..be0de2475 --- /dev/null +++ b/app/views/good_job/performances/index.html.erb @@ -0,0 +1,50 @@ +
+

<%= t ".title" %>

+
+ +<% if @needs_upgrade %> +
+ <%= t "shared.needs_migration" %> +
+<% else %> + +
+
+
+
+
<%= t ".job_class" %>
+
<%= t ".executions" %>
+ +
<%= t ".average_duration" %>
+
<%= t ".minimum_duration" %>
+
<%= t ".maximum_duration" %>
+
+
+ + <% @performances.each do |performance| %> +
+
+
<%= performance.job_class %>
+
+
<%= t ".executions" %>
+ <%= performance.executions_count %> +
+ +
+
<%= t ".average_duration" %>
+ <%= format_duration performance.avg_duration %> +
+
+
<%= t ".minimum_duration" %>
+ <%= format_duration performance.min_duration %> +
+
+
<%= t ".maximum_duration" %>
+ <%= format_duration performance.max_duration %> +
+
+
+ <% end %> +
+
+<% end %> diff --git a/app/views/good_job/shared/_navbar.erb b/app/views/good_job/shared/_navbar.erb index c4466af03..5229978ca 100644 --- a/app/views/good_job/shared/_navbar.erb +++ b/app/views/good_job/shared/_navbar.erb @@ -39,6 +39,11 @@ <% end %> +
  • + <%= link_to performances_path, class: ["nav-link", ("active" if controller_name == 'performances')] do %> + <%= t(".performances") %> + <% end %> +
      • diff --git a/config/locales/de.yml b/config/locales/de.yml index 5f09f2f60..1468af95e 100644 --- a/config/locales/de.yml +++ b/config/locales/de.yml @@ -196,6 +196,14 @@ de: thousand: K trillion: T unit: '' + performances: + index: + average_duration: Durchschnittliche Dauer + executions: Hinrichtungen + job_class: Berufsklasse + maximum_duration: Maximale Dauer + minimum_duration: Mindestdauer + title: Leistung processes: index: cron_enabled: Cron aktiviert @@ -225,6 +233,7 @@ de: jobs: Jobs live_poll: Live Poll name: "GoodJob 👍" + performances: Leistung processes: Prozesse theme: auto: Auto @@ -241,3 +250,5 @@ de: running: Laufend scheduled: Geplant succeeded: Erfolgreich + shared: + needs_migration: Bitte führen Sie GoodJob-Migrationen aus. diff --git a/config/locales/en.yml b/config/locales/en.yml index 1ca1343b2..dd154f7b4 100644 --- a/config/locales/en.yml +++ b/config/locales/en.yml @@ -196,6 +196,14 @@ en: thousand: K trillion: T unit: '' + performances: + index: + average_duration: Average duration + executions: Executions + job_class: Job class + maximum_duration: Maximum duration + minimum_duration: Minimum duration + title: Performance processes: index: cron_enabled: Cron enabled @@ -225,6 +233,7 @@ en: jobs: Jobs live_poll: Live Poll name: "GoodJob 👍" + performances: Performance processes: Processes theme: auto: Auto @@ -241,3 +250,5 @@ en: running: Running scheduled: Scheduled succeeded: Succeeded + shared: + needs_migration: Please run GoodJob migrations. diff --git a/config/locales/es.yml b/config/locales/es.yml index 3b2722072..c6beac00c 100644 --- a/config/locales/es.yml +++ b/config/locales/es.yml @@ -196,6 +196,14 @@ es: thousand: k trillion: T unit: '' + performances: + index: + average_duration: Duración promedio + executions: Ejecuciones + job_class: clase de trabajo + maximum_duration: Duración máxima + minimum_duration: Duración mínima + title: Actuación processes: index: cron_enabled: Cron habilitado @@ -225,6 +233,7 @@ es: jobs: Tareas live_poll: En vivo name: "GoodJob 👍" + performances: Actuación processes: Procesos theme: auto: Auto @@ -241,3 +250,5 @@ es: running: Ejecutando scheduled: Programado succeeded: Exitoso + shared: + needs_migration: Ejecute las migraciones de GoodJob. diff --git a/config/locales/fr.yml b/config/locales/fr.yml index 236c68538..36e4093a3 100644 --- a/config/locales/fr.yml +++ b/config/locales/fr.yml @@ -196,6 +196,14 @@ fr: thousand: k trillion: J unit: '' + performances: + index: + average_duration: Durée moyenne + executions: Exécutions + job_class: Catégorie d'emplois + maximum_duration: Durée maximale + minimum_duration: Durée minimale + title: Performance processes: index: cron_enabled: Cron activé @@ -225,6 +233,7 @@ fr: jobs: Jobs live_poll: En direct name: "GoodJob 👍" + performances: Performance processes: Processus theme: auto: Auto @@ -241,3 +250,5 @@ fr: running: En cours scheduled: Planifiés succeeded: Réussis + shared: + needs_migration: Veuillez exécuter des migrations GoodJob. diff --git a/config/locales/it.yml b/config/locales/it.yml index 4877d0e6c..a4cad1a7c 100644 --- a/config/locales/it.yml +++ b/config/locales/it.yml @@ -196,6 +196,14 @@ it: thousand: K trillion: T unit: '' + performances: + index: + average_duration: Durata media + executions: Esecuzioni + job_class: Classe di lavoro + maximum_duration: Durata massima + minimum_duration: Durata minima + title: Prestazione processes: index: cron_enabled: Cron abilitato @@ -225,6 +233,7 @@ it: jobs: Job live_poll: Live Poll name: "GoodJob 👍" + performances: Prestazione processes: Processi theme: auto: Auto @@ -241,3 +250,5 @@ it: running: In esecuzione scheduled: Pianificato succeeded: Riuscito + shared: + needs_migration: Esegui le migrazioni GoodJob. diff --git a/config/locales/ja.yml b/config/locales/ja.yml index 815572b0b..617c7c09d 100644 --- a/config/locales/ja.yml +++ b/config/locales/ja.yml @@ -196,6 +196,14 @@ ja: thousand: K trillion: T unit: '' + performances: + index: + average_duration: 平均所要時間 + executions: 処刑 + job_class: 職種 + maximum_duration: 最大持続時間 + minimum_duration: 最小期間 + title: パフォーマンス processes: index: cron_enabled: Cron が有効になっている @@ -225,6 +233,7 @@ ja: jobs: ジョブ live_poll: リアルタイム更新 name: "GoodJob 👍" + performances: パフォーマンス processes: プロセス theme: auto: 自動 @@ -241,3 +250,5 @@ ja: running: 実行中 scheduled: スケジュール待ち succeeded: 成功済み + shared: + needs_migration: GoodJob 移行を実行してください。 diff --git a/config/locales/ko.yml b/config/locales/ko.yml index 11c924b71..f6e267781 100644 --- a/config/locales/ko.yml +++ b/config/locales/ko.yml @@ -196,6 +196,14 @@ ko: thousand: K trillion: T unit: '' + performances: + index: + average_duration: 평균 지속 시간 + executions: 처형 + job_class: 직업군 + maximum_duration: 최대 기간 + minimum_duration: 최소 기간 + title: 성능 processes: index: cron_enabled: Cron이 활성화되어 있음 @@ -225,6 +233,7 @@ ko: jobs: 작업 live_poll: 실시간 업데이트 name: "GoodJob 👍" + performances: 성능 processes: 프로세스 theme: auto: 자동 @@ -241,3 +250,5 @@ ko: running: 실행 중 scheduled: 예정됨 succeeded: 성공함 + shared: + needs_migration: GoodJob 마이그레이션을 실행하세요. diff --git a/config/locales/nl.yml b/config/locales/nl.yml index 4e1a299f9..4e6d15eb5 100644 --- a/config/locales/nl.yml +++ b/config/locales/nl.yml @@ -196,6 +196,14 @@ nl: thousand: K trillion: T unit: '' + performances: + index: + average_duration: Gemiddelde duur + executions: Executies + job_class: Functie klasse + maximum_duration: Maximale duur + minimum_duration: Minimale duur + title: Prestatie processes: index: cron_enabled: Cron ingeschakeld @@ -225,6 +233,7 @@ nl: jobs: Taken live_poll: Live Poll name: "GoodJob 👍" + performances: Prestatie processes: Processen theme: auto: Auto @@ -241,3 +250,5 @@ nl: running: Rennen scheduled: Gepland succeeded: Geslaagd + shared: + needs_migration: Voer GoodJob-migraties uit. diff --git a/config/locales/pt-BR.yml b/config/locales/pt-BR.yml index c2fb40458..23fe01b5f 100644 --- a/config/locales/pt-BR.yml +++ b/config/locales/pt-BR.yml @@ -196,6 +196,14 @@ pt-BR: thousand: K trillion: T unit: '' + performances: + index: + average_duration: Duração média + executions: Execuções + job_class: Classe de trabalho + maximum_duration: Duração máxima + minimum_duration: Duração mínima + title: Desempenho processes: index: cron_enabled: Agendamento ativado @@ -225,6 +233,7 @@ pt-BR: jobs: Tarefas live_poll: Acompanhamento ao Vivo name: "GoodJob 👍" + performances: Desempenho processes: Processos theme: auto: Automático @@ -241,3 +250,5 @@ pt-BR: running: Em execução scheduled: Agendado succeeded: Concluído com sucesso + shared: + needs_migration: Execute migrações GoodJob. diff --git a/config/locales/ru.yml b/config/locales/ru.yml index 2ab11b07d..e945f6791 100644 --- a/config/locales/ru.yml +++ b/config/locales/ru.yml @@ -222,6 +222,14 @@ ru: thousand: К trillion: Т unit: '' + performances: + index: + average_duration: Средняя продолжительность + executions: Казни + job_class: Класс работы + maximum_duration: Максимальная продолжительность + minimum_duration: Минимальная продолжительность + title: Производительность processes: index: cron_enabled: Cron включен @@ -251,6 +259,7 @@ ru: jobs: Задания live_poll: Обновления в реальном времени name: "GoodJob 👍" + performances: Производительность processes: Процессы theme: auto: Авто @@ -267,3 +276,5 @@ ru: running: Исполняется scheduled: Запланировано succeeded: Успешно + shared: + needs_migration: Пожалуйста, запустите миграцию GoodJob. diff --git a/config/locales/tr.yml b/config/locales/tr.yml index c1732e124..6d348b188 100644 --- a/config/locales/tr.yml +++ b/config/locales/tr.yml @@ -196,6 +196,14 @@ tr: thousand: Bin trillion: Trilyon unit: '' + performances: + index: + average_duration: Ortalama süre + executions: İnfazlar + job_class: İş sınıfı + maximum_duration: Maksimum süre + minimum_duration: Minimum süre + title: Verim processes: index: cron_enabled: Cron etkin @@ -225,6 +233,7 @@ tr: jobs: İşler live_poll: Anlık Güncelleme name: "GoodJob 👍" + performances: Verim processes: Süreçler theme: auto: Oto @@ -241,3 +250,5 @@ tr: running: Çalışıyor scheduled: Planlandı succeeded: Başarılı + shared: + needs_migration: Lütfen GoodJob geçişlerini çalıştırın. diff --git a/config/locales/uk.yml b/config/locales/uk.yml index b189e1b70..dd9f37047 100644 --- a/config/locales/uk.yml +++ b/config/locales/uk.yml @@ -222,6 +222,14 @@ uk: thousand: Тис trillion: Трлн unit: '' + performances: + index: + average_duration: Середня тривалість + executions: Страти + job_class: Клас роботи + maximum_duration: Максимальна тривалість + minimum_duration: Мінімальна тривалість + title: Продуктивність processes: index: cron_enabled: Cron увімкнено @@ -251,6 +259,7 @@ uk: jobs: Задачі live_poll: Живе Опитування name: "GoodJob 👍" + performances: Продуктивність processes: Процеси theme: auto: Авто @@ -267,3 +276,5 @@ uk: running: Виконується scheduled: Заплановано succeeded: Успішно виконано + shared: + needs_migration: Запустіть міграції GoodJob. diff --git a/config/routes.rb b/config/routes.rb index bb65575f2..13ef59399 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -31,6 +31,8 @@ resources :processes, only: %i[index] + resources :performances, only: %i[index] + scope :frontend, controller: :frontends do get "modules/:name", action: :module, as: :frontend_module, constraints: { format: 'js' } get "static/:name", action: :static, as: :frontend_static, constraints: { format: %w[css js] } diff --git a/demo/db/seeds.rb b/demo/db/seeds.rb index 4b4f9595e..db6fea939 100644 --- a/demo/db/seeds.rb +++ b/demo/db/seeds.rb @@ -2,6 +2,7 @@ time_increments = (1.minute..10.minutes).to_a job_classes = ['ExampleJob', 'OtherJob'] queue_names = ["default", "mice", "elephants"] +discrete_is_supported = GoodJob::BaseExecution.discrete_support? jobs_data = [] loop do @@ -29,12 +30,14 @@ created_at: enqueued_at, updated_at: enqueued_at, queue_name: queue_name, + job_class: job_class, priority: 0, serialized_params: serialized_params, scheduled_at: nil, performed_at: nil, finished_at: nil, - error: nil + error: nil, + is_discrete: discrete_is_supported } start_date += time_increments.sample diff --git a/spec/app/controllers/good_job/performances_controller_spec.rb b/spec/app/controllers/good_job/performances_controller_spec.rb new file mode 100644 index 000000000..48aa6a329 --- /dev/null +++ b/spec/app/controllers/good_job/performances_controller_spec.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +require "rails_helper" + +RSpec.describe GoodJob::PerformancesController, type: :controller do + render_views # seems required for Rails HEAD + + before do + @routes = GoodJob::Engine.routes + ActiveJob::Base.queue_adapter = GoodJob::Adapter.new(execution_mode: :external) + ExampleJob.perform_later + GoodJob.perform_inline + end + + describe '#index' do + it 'renders the index page' do + get :index + expect(response).to have_http_status(:ok) + expect(response.body).to include('Performance') + end + end +end diff --git a/spec/system/performance_spec.rb b/spec/system/performance_spec.rb new file mode 100644 index 000000000..7ce4cafaf --- /dev/null +++ b/spec/system/performance_spec.rb @@ -0,0 +1,19 @@ +# frozen_string_literal: true + +require 'rails_helper' + +describe 'Performance Page', :js do + before do + ActiveJob::Base.queue_adapter = GoodJob::Adapter.new(execution_mode: :external) + ExampleJob.perform_later + GoodJob.perform_inline + end + + it 'renders properly' do + visit good_job.root_path + click_link 'Performance' + expect(page).to have_css 'h2', text: 'Performance' + + expect(page).to have_content 'ExampleJob' + end +end