Class: Gitlab::Database::HealthStatus::Signals::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/gitlab/database/health_status/signals.rb

Overview

Base class for a signal

Direct Known Subclasses

Normal, NotAvailable, Stop, Unknown

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(indicator_class, reason:) ⇒ Base

Returns a new instance of Base.



11
12
13
14
 
# File 'lib/gitlab/database/health_status/signals.rb', line 11

def initialize(indicator_class, reason:)
  @indicator_class = indicator_class
  @reason = reason
end

Instance Attribute Details

#indicator_class ⇒ Object (readonly)

Returns the value of attribute indicator_class.



9
10
11
 
# File 'lib/gitlab/database/health_status/signals.rb', line 9

def indicator_class
  @indicator_class
end

#reason ⇒ Object (readonly)

Returns the value of attribute reason.



9
10
11
 
# File 'lib/gitlab/database/health_status/signals.rb', line 9

def reason
  @reason
end

Instance Method Details

#log_info? ⇒ Boolean

Returns:

  • (Boolean) 


20
21
22
 
# File 'lib/gitlab/database/health_status/signals.rb', line 20

def log_info?
  false
end

#short_name ⇒ Object 



28
29
30
 
# File 'lib/gitlab/database/health_status/signals.rb', line 28

def short_name
  self.class.name.demodulize
end

#stop? ⇒ Boolean

Returns:

  • (Boolean) 


24
25
26
 
# File 'lib/gitlab/database/health_status/signals.rb', line 24

def stop?
  false
end

#to_s ⇒ Object 



16
17
18
 
# File 'lib/gitlab/database/health_status/signals.rb', line 16

def to_s
  "#{short_name} (indicator: #{indicator_class}; reason: #{reason})"
end