Class: Diagtool::DiagUtils

Inherits:
Object
  • Object
show all
Includes:
Windows::PlatformSpecificDiagUtils
Defined in:
lib/fluent/diagtool/diagutils.rb

Instance Method Summary collapse

Constructor Details

#initialize(params) ⇒ DiagUtils

Returns a new instance of DiagUtils.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/fluent/diagtool/diagutils.rb', line 42

def initialize(params)
  time = Time.new
  @time_format = time.strftime("%Y%m%d%0k%M%0S")
  @conf = parse_diagconf(params)
  @cmd_list = [ 
    "ps -eo pid,ppid,stime,time,%mem,%cpu,cmd",
    "cat /proc/meminfo",
   "netstat -plan",
   "netstat -s",
  ]
  if @conf[:type] == "fluentd"
    if fluent_package?
      @conf[:package_name] = "fluent-package"
      @conf[:service_name] = "fluentd"
    else
      @conf[:package_name] = "td-agent"
      @conf[:service_name] = "td-agent"
    end
  else
    if fluentbit_package?
      @conf[:package_name] = "fluent-bit"
      @conf[:service_name] = "fluent-bit"
    else
      @conf[:package_name] = "td-agent-bit"
      @conf[:service_name] = "td-agent-bit"
    end
  end
end

Instance Method Details

#diaglogger_debug(str) ⇒ Object 



347
348
349
350
 
# File 'lib/fluent/diagtool/diagutils.rb', line 347

def diaglogger_debug(str)
  @logger.debug(str)
  @logger_file.debug(str)
end

#diaglogger_error(str) ⇒ Object 



362
363
364
365
 
# File 'lib/fluent/diagtool/diagutils.rb', line 362

def diaglogger_error(str)
  @logger.error(str)
  @logger_file.error(str)
end

#diaglogger_info(str) ⇒ Object 



352
353
354
355
 
# File 'lib/fluent/diagtool/diagutils.rb', line 352

def diaglogger_info(str)
  @logger.info(str)
  @logger_file.info(str)
end

#diaglogger_warn(str) ⇒ Object 



357
358
359
360
 
# File 'lib/fluent/diagtool/diagutils.rb', line 357

def diaglogger_warn(str)
  @logger.warn(str)
  @logger_file.warn(str)
end

#fluent_package? ⇒ Boolean

Returns:

  • (Boolean) 


367
368
369
 
# File 'lib/fluent/diagtool/diagutils.rb', line 367

def fluent_package?
  File.exist?("/etc/fluent/fluentd.conf") || File.exist?("/opt/fluent/bin/fluentd")
end

#fluentbit_package? ⇒ Boolean

Returns:

  • (Boolean) 


371
372
373
 
# File 'lib/fluent/diagtool/diagutils.rb', line 371

def fluentbit_package?
  File.exist?("/etc/fluent-bit/fluent-bit.conf") || File.exist?("/opt/fluent-bit/bin/fluent-bit")
end

#parse_diagconf(params) ⇒ Object 



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/fluent/diagtool/diagutils.rb', line 267

def parse_diagconf(params)
  options = {
    :precheck => '', :basedir => '', :type =>'', :mask => '', :words => [], :wfile => '', :seed => '', :tdconf =>'', :tdlog => ''
  }
  ### Parse precheck flag
  if params[:precheck]
    options[:precheck] = params[:precheck]
  else
    options[:precheck] = false
  end
  if options[:precheck] == false
    if params[:output] != nil
      if Dir.exist?(params[:output])
        options[:basedir] = params[:output]
      else
        raise "output directory '#{params[:output]}' does not exist"
      end
    else
      raise "output directory '-o' must be specified"
    end
  end
  ### Parse fluent type
  if params[:type] == 'fluentd' || params[:type] == 'fluentbit'
    options[:type] = params[:type]
  else
    raise "fluentd type '-t' must be specified (fluentd or fluentbit)"
  end
  ### Parse mask flag
  if params[:mask] == nil
    options[:mask] = 'no'
  else
    if params[:mask] == 'yes' || params[:mask] == 'no'
      options[:mask] = params[:mask]
    else
      raise "invalid arguments '#{params[:mask]}' : input of '-m|--mask' should be 'yes' or 'no'"
    end
  end
 
  ### Parse uder-defined keyword list which will be used in the mask function 
  options[:words] = params[:"word-list"] if params[:"word-list"] != nil

  ### Parse uder-defined keyword file which will be used in the mask function 
  if params[:"word-file"] != nil
    f = params[:"word-file"]
    if File.exist?(f)
      File.readlines(f).each do  |l|
        options[:words].append(l.gsub(/\n/,''))
      end
    else
      raise "#{params[:"word-file"]} : No such file or directory"
    end
  end
  options[:words] = options[:words].uniq 

  ### Parse hash seed which will be used in the mask function 
  options[:seed] = params[:"hash-seed"] if params[:"hash-seed"] != nil

  ### Parse the path of fluentd config file
  if params[:conf] != nil
    f = params[:conf]
    if File.exist?(f)
	  options[:tdconf] = params[:conf]
    else
      raise "#{params[:conf]} : No such file or directory"
    end
  end

  ### Parse the path of fluentd log file
  if params[:log] != nil
    f = params[:log]
    if File.exist?(f)
      options[:tdlog] = params[:log]
    else
      raise "#{params[:log]} : No such file or directory"
    end
  end

  return options	
end

#run_diagtool ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/fluent/diagtool/diagutils.rb', line 98

def run_diagtool()
  @conf[:time] = @time_format
  @conf[:workdir] = @conf[:basedir] + '/' + @time_format
  @conf[:outdir] = @conf[:workdir] + '/output'
  FileUtils.mkdir_p(@conf[:workdir])
  FileUtils.mkdir_p(@conf[:outdir])
  diaglog = @conf[:workdir] + '/diagtool.output'

  @masklog = './mask_' + @time_format + '.json'
  @logger = Logger.new(STDOUT, formatter: proc {|severity, datetime, progname, msg|
    "#{datetime}: [Diagtool] [#{severity}] #{msg}\n"
  })
  @logger_file = Logger.new(diaglog, formatter: proc {|severity, datetime, progname, msg|
    "#{datetime}: [Diagtool] [#{severity}] #{msg}\n"
  })
  diaglogger_info("Parsing command options...")
  diaglogger_info("   Option : Output directory = #{@conf[:basedir]}")
  diaglogger_info("   Option : Mask = #{@conf[:mask]}")
  diaglogger_info("   Option : Word list = #{@conf[:words]}")
  diaglogger_info("   Option : Hash Seed = #{@conf[:seed]}")

  loglevel = 'WARN'
  diaglogger_info("Initializing parameters...")
  c = CollectUtils.new(@conf, loglevel)
  c_env = c.export_env()
  diaglogger_info("[Collect] Loading the environment parameters...")
  diaglogger_info("[Collect]    operating system = #{c_env[:os]}")
  diaglogger_info("[Collect]    kernel version = #{c_env[:kernel]}")
  diaglogger_info("[Collect]    #{@conf[:package_name]} conf path = #{c_env[:tdconf_path]}")
  diaglogger_info("[Collect]    #{@conf[:package_name]} conf file = #{c_env[:tdconf]}")
  diaglogger_info("[Collect]    #{@conf[:package_name]} log path = #{c_env[:tdlog_path]}")
  diaglogger_info("[Collect]    #{@conf[:package_name]} log = #{c_env[:tdlog]}")
  m = MaskUtils.new(@conf, loglevel)
  v = ValidUtils.new(loglevel)
			
  diaglogger_info("[Collect] Collecting log files of #{@conf[:package_name]}...")
  case @type
  when 'fluentd'
    tdlog = c.collect_tdlog()
    diaglogger_info("[Collect] log files of #{@conf[:package_name]} are stored in #{tdlog}")
  when 'fleuntbit'
    if tdlog.empty?
      diaglogger_info("FluentBit logs are redirected to the standard output interface ")
      tdlog = ''
    else
      tdlog = c.collect_tdlog()
      diaglogger_info("[Collect] log files of #{@conf[:package_name]} are stored in #{tdlog}")
    end
  end

  diaglogger_info("[Collect] Collecting config file of #{@conf[:package_name]}...")
  tdconf = c.collect_tdconf()
  diaglogger_info("[Collect] config file is stored in #{tdconf}")

  case @conf[:type]
  when 'fluentd'
    diaglogger_info("[Collect] Collecting #{@conf[:package_name]} gem information...")
    tdgem = c.collect_tdgems()
    diaglogger_info("[Collect] #{@conf[:package_name]} gem information is stored in #{tdgem}")
    gem_info = c.collect_manually_installed_gems(tdgem)
    diaglogger_info("[Collect] #{@conf[:package_name]} gem information (bundled by default) is stored in #{gem_info[:bundled]}")
    diaglogger_info("[Collect] #{@conf[:package_name]} manually installed gem information is stored in #{gem_info[:local]}")
    local_gems = File.read(gem_info[:local]).lines(chomp: true)
    unless local_gems == [""]
      diaglogger_info("[Collect] #{@conf[:package_name]} manually installed gems:")
      local_gems.each do |gem|
        diaglogger_info("[Collect]   * #{gem}")
      end
    end
  when 'fluentbit'
    # nothing to do!
  end

  diaglogger_info("[Collect] Collecting config file of OS log...")
  oslog = c.collect_oslog()
  if @conf[:mask] == 'yes'
    diaglogger_info("[Mask] Masking OS log file : #{oslog}...")
    oslog = m.mask_tdlog(oslog, clean = true)
  end
  diaglogger_info("[Collect] config file is stored in #{oslog}")

  diaglogger_info("[Collect] Collecting date/time information...")
  if system('which chronyc > /dev/null 2>&1')
    ntp = c.collect_cmd_output(command="chronyc sources")
    diaglogger_info("[Collect] date/time information is stored in #{ntp}")
  elsif system('which ntpq > /dev/null 2>&1')
    ntp = c.collect_cmd_output(command="ntpq -p")
    diaglogger_info("[Collect] date/time information is stored in #{ntp}")
  else
    diaglogger_warn("[Collect] chrony/ntp does not exist. skip collectig date/time information")
  end
  
  ###
  #  Correct OS information
  ###
  @cmd_list.each { |cmd|
    diaglogger_info("[Collect] Collecting command output : command = #{cmd}")
    if system(cmd + '> /dev/null 2>&1')
      out = c.collect_cmd_output(cmd)
      if @conf[:mask] == 'yes'
        diaglogger_info("[Mask] Masking command output file : #{out}...")
        out = m.mask_tdlog(out, clean = true)
      end
      diaglogger_info("[Collect] Collecting command output #{cmd.split[0]} stored in #{out}")
    end
  }
			
  ###
  #  Correct information to be validated
  ###
  diaglogger_info("[Collect] Collecting sysctl information...")
  sysctl = c.collect_cmd_output("sysctl -a")
  if sysctl
    diaglogger_info("[Collect] sysctl information is stored in #{sysctl}")

    diaglogger_info("[Valid] Validating sysctl information...")
    ret, sysctl = v.valid_sysctl(sysctl)
    list =  sysctl.keys
    list.each do |k|
      if sysctl[k]['result'] == 'correct'
        diaglogger_info("[Valid]    Sysctl: #{k} => #{sysctl[k]['value']} is correct (recommendation is #{sysctl[k]['recommend']})")
      elsif sysctl[k]['result'] == 'incorrect'
        diaglogger_warn("[Valid]    Sysctl: #{k} => #{sysctl[k]['value']} is incorrect (recommendation is #{sysctl[k]['recommend']})")
      end
    end
  end

  diaglogger_info("[Collect] Collecting ulimit information...")
  ulimit = c.collect_cmd_output(cmd="sh -c 'ulimit -n'")
  diaglogger_info("[Collect] ulimit information is stored in #{ulimit}")

  diaglogger_info("[Valid] Validating ulimit information...")
  ret, rec, val = v.valid_ulimit(ulimit)
  if ret == true
    diaglogger_info("[Valid]    ulimit => #{val} is correct (recommendation is >#{rec})")
  else
    diaglogger_warn("[Valid]    ulimit => #{val} is incorrect (recommendation is >#{rec})")
  end

  if @conf[:mask] == 'yes'
    tdconf.each { | file |
      diaglogger_info("[Mask] Masking #{@conf[:package_name]} config file : #{file}...")
      m.mask_tdlog(file, clean = true)
    }
  end

  if @conf[:mask] == 'yes'
    if tdlog != nil
      tdlog.each { | file |
        diaglogger_info("[Mask] Masking #{@conf[:package_name]} log file : #{file}...")
        filename = file.split("/")[-1]
        if filename.include?(".gz")
          m.mask_tdlog_gz(file, clean = true)
        elsif
          m.mask_tdlog(file, clean = true)
        end
      }
    end
  end
  
  if @conf[:mask] == 'yes'
    diaglogger_info("[Mask] Export mask log file : #{@masklog}")
    m.export_masklog(@masklog)
  end

  tar_file = c.compress_output()
  diaglogger_info("[Collect] Generate tar file #{tar_file}")
end

#run_precheck ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/fluent/diagtool/diagutils.rb', line 71

def run_precheck()
  prechecklog = Logger.new(STDOUT, formatter: proc {|severity, datetime, progname, msg|
    "#{datetime}: [Diagtool] [#{severity}] #{msg}\n"
  })
  loglevel = 'WARN'
  c = CollectUtils.new(@conf, loglevel)
  c_env = c.export_env()
  prechecklog.info("[Precheck] Fluentd Type = #{@conf[:type]}")
  prechecklog.info("[Precheck] Check OS parameters...")
  prechecklog.info("[Precheck]    operating system = #{c_env[:os]}")
  prechecklog.info("[Precheck]    kernel version = #{c_env[:kernel]}")
  prechecklog.info("[Precheck] Check #{@conf[:package_name]} parameters...")
  prechecklog.info("[Precheck]    #{@conf[:package_name]} conf path = #{c_env[:tdconf_path]}")
  prechecklog.info("[Precheck]    #{@conf[:package_name]} conf file = #{c_env[:tdconf]}")
  prechecklog.info("[Precheck]    #{@conf[:package_name]} log path = #{c_env[:tdlog_path]}")
  prechecklog.info("[Precheck]    #{@conf[:package_name]} log = #{c_env[:tdlog]}")
  if c_env[:tdconf_path] == nil || c_env[:tdconf] == nil
    prechecklog.warn("[Precheck]    can not find #{@conf[:package_name]} conf path: please run diagtool command with -c /path/to/<#{@conf[:package_name]} conf file>")
  end
  if c_env[:tdlog_path] == nil || c_env[:tdlog] == nil
    prechecklog.warn("[Precheck]    can not find #{@conf[:package_name]} log path: please run diagtool command with -l /path/to/<#{@conf[:package_name]} log file>")
  end
  if c_env[:tdconf_path] != nil && c_env[:tdconf] != nil && c_env[:tdlog_path] != nil && c_env[:tdlog] != nil
    prechecklog.info("[Precheck] Precheck completed. You can run diagtool command without -c and -l options")
  end
end