Module: Pacemaker::Debug

Included in:
Puppet::Provider::PacemakerXML, Serverspec::Type::PacemakerXML
Defined in:
lib/pacemaker/xml/debug.rb

Overview

debug related functions “cluster_debug_report” the main debug text generation function “safe_methods” are used to debug providers without making any actual changes to the system

Instance Method Summary collapse

Instance Method Details

#cibadmin_safe(*args) ⇒ String, NilClass

safe cibadmin command

Parameters:

  • args (Array) —

    command arguments

Returns:

  • (String, NilClass) 


42
43
44
 
# File 'lib/pacemaker/xml/debug.rb', line 42

def cibadmin_safe(*args)
  safe_method :cibadmin, *args
end

#cluster_debug_report(tag = nil) ⇒ String

form a cluster status report for debugging “(L)” - location constraint for this primitive is present on this node “(F)” - the primitive is not running and have failed on this node “(M)” - this primitive is not managed

Parameters:

  • tag (String) (defaults to: nil) —

    log comment tag to to trace calls

Returns:

  • (String) 


82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/pacemaker/xml/debug.rb', line 82

def cluster_debug_report(tag = nil)
  return unless cib?
  report = "\n"
  report += 'Pacemaker debug block start'
  report += " at '#{tag}'" if tag
  report += "\n"
  primitives_status_by_node.each do |primitive, data|
    primitive_name = primitive
    next unless primitives.key? primitive
    primitive_name = primitives[primitive]['name'] if primitives[primitive]['name']
    primitive_type = 'Simple'
    primitive_type = 'Clone' if primitive_is_clone? primitive
    primitive_type = 'Master' if primitive_is_master? primitive

    report += "-> #{primitive_type} primitive: '#{primitive_name}'"
    report += ' (M)' unless primitive_is_managed? primitive
    report += "\n"
    nodes = []
    data.keys.sort.each do |node_name|
      node_status_string = data.fetch node_name
      node_status_string = '?' unless node_status_string.is_a? String
      node_status_string = node_status_string.upcase
      node_block = "#{node_name}: #{node_status_string}"
      node_block += ' (F)' if primitive_has_failures? primitive, node_name
      node_block += ' (L)' if service_location_exists? primitive_full_name(primitive), node_name
      nodes << node_block
    end
    report += '   ' + nodes.join(' | ') + "\n"
  end
  pacemaker_options[:debug_show_properties].each do |p|
    report += "* #{p}: #{cluster_property_value p}\n" if cluster_property_defined? p
  end
  report += 'Pacemaker debug block end'
  report += " at '#{tag}'" if tag
  report + "\n"
end

#cmapctl_safe(*args) ⇒ String, NilClass

safe cmapctl command

Parameters:

  • args (Array) —

    command arguments

Returns:

  • (String, NilClass) 


56
57
58
 
# File 'lib/pacemaker/xml/debug.rb', line 56

def cmapctl_safe(*args)
  safe_method :cmapctl, *args
end

#crm_attribute_safe(*args) ⇒ String, NilClass

safe crm_attribute command

Parameters:

  • args (Array) —

    command arguments

Returns:

  • (String, NilClass) 


70
71
72
 
# File 'lib/pacemaker/xml/debug.rb', line 70

def crm_attribute_safe(*args)
  safe_method :crm_attribute, *args
end

#crm_node_safe(*args) ⇒ String, NilClass

safe crm_node command

Parameters:

  • args (Array) —

    command arguments

Returns:

  • (String, NilClass) 


49
50
51
 
# File 'lib/pacemaker/xml/debug.rb', line 49

def crm_node_safe(*args)
  safe_method :crm_node, *args
end

#crm_resource_safe(*args) ⇒ String, NilClass

safe crm_resource command

Parameters:

  • args (Array) —

    command arguments

Returns:

  • (String, NilClass) 


63
64
65
 
# File 'lib/pacemaker/xml/debug.rb', line 63

def crm_resource_safe(*args)
  safe_method :crm_resource, *args
end

#debug_mode_enabled? ⇒ TrueClass, FalseClass

check if debug is enabled either in the pacemaker options or the resource has the ‘debug’ parameter and it’s enabled

Returns:

  • (TrueClass, FalseClass) 


9
10
11
12
13
 
# File 'lib/pacemaker/xml/debug.rb', line 9

def debug_mode_enabled?
  return true if pacemaker_options[:debug_enabled]
  return true if @resource && @resource.parameters.keys.include?(:debug) && @resource[:debug]
  false
end

#resource_operations_report(operations, resource, node_name) ⇒ String

Generate the report message for the operation status calculation

Parameters:

  • operations (Array<Hash>)
  • resource (Hash<String => String>)
  • node_name (String)

Returns:

  • (String) 


124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/pacemaker/xml/debug.rb', line 124

def resource_operations_report(operations, resource, node_name)
  report = "Operations status debug start for the node: '#{node_name}'\n"
  report += "Resource: '#{resource['id']}'\n"
  operations.each do |operation|
    type = operation.fetch('operation', '?').capitalize
    rc_code = operation.fetch('rc-code', '?')
    op_code = operation.fetch('op-status', '?')
    report += "* #{type.ljust 7}: rc:#{rc_code} op:#{op_code}\n"
  end
  report += "Status: #{resource['status']} Failed: #{resource['failed']}\n"
  report + "Operations status debug end for the node: '#{node_name}'\n"
end

#safe_method(cmd, *args) ⇒ String, NilClass

Call a Puppet shell command method with wrappers If debug is enabled, show what would be executed and don’t actually run the command. Used to debug commands that should modify the system and don’t return any data. Should never be use with commands that retrieve data. If a command have failed, show command and the arguments and the raise the exception. The actual commands methods should be created by the provider’s “commands” helper.

Parameters:

  • cmd (Symbol, String) —

    command name

  • args (Array) —

    command arguments

Returns:

  • (String, NilClass) 


24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/pacemaker/xml/debug.rb', line 24

def safe_method(cmd, *args)
  cmd = cmd.to_sym unless cmd.is_a? Symbol
  command_line = ([cmd.to_s] + args).join ' '
  if debug_mode_enabled?
    debug "Exec: #{command_line}"
    return
  end
  begin
    send cmd, *args
  rescue StandardError => exception
    debug "Command execution have failed: #{command_line}"
    raise exception
  end
end