Class: NagiosOutput::Nagios

Inherits:
Object
  • Object
show all
Defined in:
lib/nagios_output.rb

Overview

Docs to follow

Class Method Summary collapse

Class Method Details

.check_colour(use_colour_local = nil) ⇒ Object 



24
25
26
27
28
29
30
31
 
# File 'lib/nagios_output.rb', line 24

def self.check_colour(use_colour_local = nil)
    unless use_colour_local.nil?
        return true if use_colour_local
        return false unless use_colour_local
    end
    return true if $use_colour
    return false unless $use_colour
end

.clean_string(message) ⇒ Object 



33
34
35
36
37
38
39
40
 
# File 'lib/nagios_output.rb', line 33

def self.clean_string(message)
    return nil if message.nil?

    message = message.to_s.rstrip
    return nil if message.empty?

    message
end

.critical(message = nil, use_colour_local = nil) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/nagios_output.rb', line 68

def self.critical(message = nil, use_colour_local = nil)
    message = clean_string(message)

    exit 2 if message.nil?

    if check_colour(use_colour_local)
        puts "CRITICAL - #{message}".red
    else
        puts "CRITICAL - #{message}"
    end
    exit 2
end

.ok(message = nil, use_colour_local = nil) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/nagios_output.rb', line 42

def self.ok(message = nil, use_colour_local = nil)
    message = clean_string(message)

    exit 0 if message.nil?

    if check_colour(use_colour_local)
        puts "OK - #{message}".green
    else
        puts "OK - #{message}"
    end
    exit 0
end

.unknown(message = nil, use_colour_local = nil) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/nagios_output.rb', line 81

def self.unknown(message = nil, use_colour_local = nil)
    message = clean_string(message)

    exit 3 if message.nil?

    if check_colour(use_colour_local)
        puts "UNKNOWN - #{message}".blue
    else
        puts "UNKNOWN - #{message}"
    end
    exit 3
end

.use_colour(colour = true) ⇒ Object

Raises:

  • (ArgumentError) 


16
17
18
19
20
 
# File 'lib/nagios_output.rb', line 16

def self.use_colour(colour = true)
    raise ArgumentError.new('Invalid option: use true or false only') unless [true, false].include? colour

    $use_colour = colour
end

.warning(message = nil, use_colour_local = nil) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/nagios_output.rb', line 55

def self.warning(message = nil, use_colour_local = nil)
    message = clean_string(message)

    exit 1 if message.nil?

    if check_colour(use_colour_local)
        puts "WARNING - #{message}".yellow
    else
        puts "WARNING - #{message}"
    end
    exit 1
end