Module: JobWorkflow::Monitoring

Defined in:
lib/job_workflow/monitoring.rb,
lib/job_workflow/monitoring/engine.rb,
lib/job_workflow/monitoring/dag_layout.rb,
lib/job_workflow/monitoring/execution_page.rb,
lib/job_workflow/monitoring/parameter_filter.rb,
lib/job_workflow/monitoring/workflow_registry.rb,
lib/job_workflow/monitoring/execution_registry.rb,
lib/job_workflow/monitoring/workflow_definition.rb,
lib/job_workflow/monitoring/execution_view_model.rb,
app/controllers/job_workflow/monitoring/workflows_controller.rb,
app/controllers/job_workflow/monitoring/executions_controller.rb,
app/controllers/job_workflow/monitoring/application_controller.rb,
sig/generated/job_workflow/monitoring.rbs,
sig/generated/job_workflow/monitoring/engine.rbs,
sig/generated/job_workflow/monitoring/dag_layout.rbs,
sig/generated/job_workflow/monitoring/execution_page.rbs,
sig/generated/job_workflow/monitoring/parameter_filter.rbs,
sig/generated/job_workflow/monitoring/workflow_registry.rbs,
sig/generated/job_workflow/monitoring/execution_registry.rbs,
sig/generated/job_workflow/monitoring/workflow_definition.rbs,
sig/generated/job_workflow/monitoring/execution_view_model.rbs,
sig/generated/controllers/job_workflow/monitoring/workflows_controller.rbs,
sig/generated/controllers/job_workflow/monitoring/executions_controller.rbs,
sig/generated/controllers/job_workflow/monitoring/application_controller.rbs

Defined Under Namespace

Classes: ApplicationController, DagLayout, Engine, ExecutionPage, ExecutionRegistry, ExecutionViewModel, ExecutionsController, ParameterFilter, WorkflowDefinition, WorkflowRegistry, WorkflowsController

Class Method Summary collapse

Class Method Details

.base_controller_class ⇒ Object

Returns:

  • (Object) 


5
 
# File 'sig/generated/job_workflow/monitoring.rbs', line 5

def self.base_controller_class: () -> untyped

.configure_engine_config(config) ⇒ void

This method returns an undefined value.

: (untyped config) -> void

Parameters:

  • config (Object) 


48
49
50
51
52
53
54
55
56
57
 
# File 'lib/job_workflow/monitoring.rb', line 48

def configure_engine_config(config)
  config.job_workflow = ActiveSupport::OrderedOptions.new unless config.try(:job_workflow)
  config.job_workflow.monitoring ||= ActiveSupport::OrderedOptions.new

  config.before_initialize do
    config.job_workflow.monitoring.each do |key, value|
      JobWorkflow::Monitoring.public_send("#{key}=", value)
    end
  end
end

.mission_control_job_path(job_id, status: nil) ⇒ String?

: (String?, ?status: Symbol?) -> String?

Parameters:

  • (String, nil)
  • status: (Symbol, nil) (defaults to: nil)

Returns:

  • (String, nil) 


25
26
27
28
29
30
31
32
33
34
 
# File 'lib/job_workflow/monitoring.rb', line 25

def mission_control_job_path(job_id, status: nil)
  return if job_id.nil?

  path_template = mission_control_job_route_path
  return if path_template.nil?

  path = path_template.sub(":id", job_id.to_s)
  path += "#error" if status == :failed
  path
end

.resolved_base_controller_class ⇒ String

: () -> String

Returns:

  • (String) 


37
38
39
40
41
42
43
44
45
 
# File 'lib/job_workflow/monitoring.rb', line 37

def resolved_base_controller_class
  return base_controller_class if base_controller_class.present?

  mission_control_base_controller_class = defined?(MissionControl::Jobs) &&
                                          MissionControl::Jobs.base_controller_class
  return mission_control_base_controller_class if mission_control_base_controller_class.present?

  "::ApplicationController"
end

.workflows ⇒ Array[WorkflowDefinition]

: () -> Array

Returns:



20
21
22
 
# File 'lib/job_workflow/monitoring.rb', line 20

def workflows
  WorkflowRegistry.all.map { |job_class| WorkflowDefinition.new(job_class:) }
end