Module: SolidQueueGuard

Defined in:

lib/solid_queue_guard.rb,
lib/solid_queue_guard/cli.rb,
lib/solid_queue_guard/engine.rb,
lib/solid_queue_guard/report.rb,
lib/solid_queue_guard/runner.rb,
lib/solid_queue_guard/version.rb,
lib/solid_queue_guard/notifier.rb,
lib/solid_queue_guard/checks/base.rb,
lib/solid_queue_guard/check/result.rb,
lib/solid_queue_guard/health/cache.rb,
lib/solid_queue_guard/configuration.rb,
lib/solid_queue_guard/health/payload.rb,
lib/solid_queue_guard/metrics/statsd.rb,
lib/solid_queue_guard/notifiers/base.rb,
lib/solid_queue_guard/queue_coverage.rb,
lib/solid_queue_guard/checks/registry.rb,
lib/solid_queue_guard/formatters/json.rb,
lib/solid_queue_guard/metrics/exporter.rb,
lib/solid_queue_guard/http_status_policy.rb,
lib/solid_queue_guard/metrics/prometheus.rb,
lib/solid_queue_guard/checks/runtime/base.rb,
lib/solid_queue_guard/formatters/terminal.rb,
lib/solid_queue_guard/puma_plugin_support.rb,
lib/solid_queue_guard/metrics/open_telemetry.rb,
lib/solid_queue_guard/recommendations/topology.rb,
lib/solid_queue_guard/schema/solid_queue_tables.rb,
lib/solid_queue_guard/checks/config/adapter_check.rb,
lib/solid_queue_guard/checks/runtime/pidfile_check.rb,
app/controllers/solid_queue_guard/health_controller.rb,
lib/solid_queue_guard/checks/config/env_flags_check.rb,
lib/solid_queue_guard/checks/runtime/queue_lag_check.rb,
lib/generators/solid_queue_guard/install/ci_generator.rb,
lib/solid_queue_guard/checks/config/connects_to_check.rb,
lib/solid_queue_guard/checks/config/thread_pool_check.rb,
lib/solid_queue_guard/checks/runtime/database_support.rb,
lib/solid_queue_guard/checks/runtime/dispatcher_check.rb,
lib/solid_queue_guard/checks/config/queue_schema_check.rb,
lib/solid_queue_guard/checks/runtime/failed_jobs_check.rb,
lib/solid_queue_guard/checks/runtime/blocked_jobs_check.rb,
app/controllers/solid_queue_guard/application_controller.rb,
lib/solid_queue_guard/checks/config/puma_colocated_check.rb,
lib/solid_queue_guard/checks/config/queue_database_check.rb,
lib/solid_queue_guard/checks/runtime/stale_process_check.rb,
lib/solid_queue_guard/checks/config/worker_coverage_check.rb,
lib/generators/solid_queue_guard/install/install_generator.rb,
lib/solid_queue_guard/checks/config/scheduler_config_check.rb,
lib/solid_queue_guard/checks/runtime/orphaned_claims_check.rb,
lib/solid_queue_guard/checks/runtime/recurring_stale_check.rb,
lib/solid_queue_guard/checks/runtime/paused_queue_lag_check.rb,
lib/solid_queue_guard/checks/runtime/process_topology_check.rb,
lib/solid_queue_guard/checks/runtime/scheduled_backlog_check.rb,
lib/solid_queue_guard/checks/runtime/puma_plugin_runtime_check.rb,
lib/solid_queue_guard/checks/runtime/finished_jobs_growth_check.rb,
lib/solid_queue_guard/checks/config/async_supervisor_config_check.rb,
lib/solid_queue_guard/checks/config/topology_recommendation_check.rb,
lib/solid_queue_guard/checks/config/process_heartbeat_config_check.rb

Defined Under Namespace

Modules: CLI, Check, Checks, Formatters, Generators, Health, HttpStatusPolicy, Metrics, Notifiers, PumaPluginSupport, QueueCoverage, Recommendations, Schema Classes: ApplicationController, Configuration, Engine, HealthController, Notifier, Report, Runner

Constant Summary

VERSION =

'1.0.1'

Class Attribute Summary

• .configuration ⇒ Object

  Returns the value of attribute configuration.

Class Method Summary

• .config ⇒ Object
• .configure {|configuration| ... } ⇒ Object
• .deprecator ⇒ Object
• .enabled? ⇒ Boolean

Class Attribute Details

.configuration ⇒ Object

Returns the value of attribute configuration.

# File 'lib/solid_queue_guard.rb', line 18

def configuration
  @configuration
end

Class Method Details

.config ⇒ Object

# File 'lib/solid_queue_guard.rb', line 30

def config
  configuration || configure
end

.configure {|configuration| ... } ⇒ Object

Yields:

• (configuration)

# File 'lib/solid_queue_guard.rb', line 24

def configure
  self.configuration ||= Configuration.new
  yield(configuration) if block_given?
  configuration
end

.deprecator ⇒ Object

# File 'lib/solid_queue_guard.rb', line 20

def deprecator
  @deprecator ||= ActiveSupport::Deprecation.new('2.0', 'SolidQueueGuard')
end

.enabled? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/solid_queue_guard.rb', line 34

def enabled?
  config.enabled
end