fluent-diagtool 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 614c1b026136b0743f9c6439b6dd2349adbe9edf3cdb2d77e1ab78698a9d9e49
-  data.tar.gz: a2228adc3509363ba6bf8f4ddee4d6b1f3feaef2088452a5c69e72057eac2336
+  metadata.gz: 459fd1aefd11e12f79ef9f12cd99e289412fc99c3711191508aa3b17af985a6d
+  data.tar.gz: 8ed32d7c995ec7a6afb9a618421eb49590f44db96ed10f4babb8440cb3fde271
 SHA512:
-  metadata.gz: af815f59c3ed5492175d5fe988eb6eb33fae556b4a2fcd6a20cf89e7e71aa1db92438f7ec1002c08e7f00d59099f91b2d8764f91b18cfb52593c81c5ae89f8e4
-  data.tar.gz: c7adc36937ba9e1b74a2914a6c2fdf41a6f44dfbd155aa3eb99cf59126022280461a38972eb45f0f486e639b701db6ea7d1c3ec2de73893dd6c982ea9dde8f0c
+  metadata.gz: 97adbb75557f1c7c2cf0624e2c9f4aa8ac1631a91d1b30f269fa137223ee20855ceb5764d47cf32f3b01ec0b1e80d541b0ecb069c27d136e456809b935f91efe
+  data.tar.gz: e6bc2057366a4f864d7d081235f29bcc0ddbc118412695f52fc6516a642421e9d9770a5a1fd6c7fc2deb7f4cd90a1d3e8d90cb0bcec07e99fd8ef4dc41a90f8a

data/README.md

@@ -81,6 +81,14 @@ The following example shows the precheck results when the diagtool is not able t
 2020-05-28 05:45:14 +0000: [Diagtool] [WARN] [Precheck]    can not find td-agent conf path: please run diagtool command with -c /path/to/<td-agent conf file>
 2020-05-28 05:45:14 +0000: [Diagtool] [WARN] [Precheck]    can not find td-agent log path: please run diagtool command with -l /path/to/<td-agent log file>
 ```
+
+### Run diagtool
+
+#### The "@include" directive in td-agent configuration file
+The "@include" directive is a function to reuse configuration defined in another configuration files. The diagtool read the td-agent configuration and collect the files described in "@include" directive as well. The details of "@include" directive are described in followed url:  
+https://docs.fluentd.org/configuration/config-file#6-re-use-your-config-the-include-directive
+
+#### User defined words to be masked 
 The user-defined words can be specified both -e option and -f option and the words are merged when both options are selected.
 The format of user-defined words list file specified in -f option should be followed format.
 ```
@@ -90,7 +98,6 @@ centos8102
 ```
 NOTE: When user specified the keywork, only the exact match words will be masked. For instance, when users like to mask words like "nginx1" and "nginx2", users need to specify "nginx1" and "nginx2" respectively and "nginx*" should not work in the tool.
 
-### Run diagtool
 #### Command sample:
 ```
 # diagtool -o /tmp/work1 -w passwd1,passwd2 -f word_list_sample -m yes
@@ -149,7 +156,7 @@ NOTE: When user specified the keywork, only the exact match words will be masked
 2020-05-12 18:21:22 -0400: [Diagtool] [INFO] [Mask] Export mask log file : ./mask_20200512182119.json
 2020-05-12 18:21:22 -0400: [Diagtool] [INFO] [Collect] Generate tar file /tmp/work1/diagout-20200512182119.tar.gz
 ```
-## Mask Function
+#### Mask Function
 When run diagtool with mask option, the log of mask is also created in 'mask_{timestamp}.json' file. Users are able to confirm how the mask was generated on each files.  
 The diagtool provides hash-seed option with '-s'. When hash-seed is specified, the mask will be generated with original word and hash-seed so that users could use unique mask value.
 #### Mask sample - IP address: IPv4_{md5hash}

data/lib/fluent/diagtool/collectutils.rb

@@ -30,7 +30,7 @@ module Diagtool
       @workdir = conf[:workdir]
       @outdir = conf[:outdir]			
        
-      @tdenv = get_tdenv()
+      @tdenv = gen_tdenv()
       if not conf[:tdconf].empty?
 	@tdconf = conf[:tdconf].split('/')[-1]
         @tdconf_path = conf[:tdconf].gsub(@tdconf,'')
@@ -53,7 +53,7 @@ module Diagtool
           raise "The path of td-agent log file need to be specified." if conf[:precheck] == false
 	end
       end 
-      @osenv = get_osenv()
+      @osenv = gen_osenv()
       @oslog_path = '/var/log/'
       @oslog = 'messages'
       @sysctl_path = '/etc/'
@@ -68,7 +68,7 @@ module Diagtool
       @logger.info("    td-agent log = #{@tdlog}")
     end
     
-    def get_osenv()
+    def gen_osenv()
       stdout, stderr, status = Open3.capture3('hostnamectl')
       os_dict = {}
       stdout.each_line { |l|
@@ -83,7 +83,7 @@ module Diagtool
       return os_dict
     end
     
-    def get_tdenv()
+    def gen_tdenv()
       stdout, stderr, status = Open3.capture3('systemctl cat td-agent')
       env_dict = {}
       if status.success?
@@ -143,12 +143,45 @@ module Diagtool
       target_dir = @workdir+@tdconf_path
       FileUtils.mkdir_p(target_dir)
       FileUtils.cp(@tdconf_path+@tdconf, target_dir)
-      return target_dir+@tdconf
+      conf = @workdir+@tdconf_path+@tdconf
+      conf_list = []
+      conf_list.push target_dir + @tdconf
+      File.readlines(conf).each { |line|
+      if line.include? '@include'
+        f = line.split()[1]
+        if f.start_with?(/\//)  # /tmp/work1/b.conf
+          if f.include?('*')
+            Dir.glob(f).each { |ff|
+              conf_inc = target_dir + ff.gsub(/\//,'__')
+              FileUtils.cp(ff, conf_inc)
+              conf_list.push conf_inc
+             }
+	  else 
+	    conf_inc = target_dir+f.gsub(/\//,'__')
+            FileUtils.cp(f, conf_inc)
+            conf_list.push  conf_inc
+	  end
+        else
+	  f = f.gsub('./','') if f.include?('./')
+          if f.include?('*')
+            Dir.glob(@tdconf_path+f).each{ |ff|
+              conf_inc = target_dir + ff.gsub(@tdconf_path,'').gsub(/\//,'__')
+              FileUtils.cp(ff, conf_inc)
+              conf_list.push conf_inc
+            }
+	  else
+            conf_inc = target_dir+f.gsub(/\//,'__')
+            FileUtils.cp(@tdconf_path+f, conf_inc)
+            conf_list.push  conf_inc
+	  end
+        end
+      end
+     }
+     return conf_list
     end
-    
+
     def collect_tdlog()
       target_dir = @workdir+@tdlog_path
-      p target_dir
       FileUtils.mkdir_p(target_dir)
       Dir.glob(@tdlog_path+@tdlog+'*').each{ |f| 
         FileUtils.cp(f, target_dir)

data/lib/fluent/diagtool/diagutils.rb

@@ -189,9 +189,11 @@ module Diagtool
       end
 
       if @conf[:mask] == 'yes'
-        diaglogger_info("[Mask] Masking td-agent config file : #{tdconf}...")
-        m.mask_tdlog(tdconf, clean = true)
-        tdlog.each do | file |
+	tdconf.each { | file |
+	  diaglogger_info("[Mask] Masking td-agent config file : #{file}...")
+	  m.mask_tdlog(file, clean = true)
+	}
+        tdlog.each { | file |
           diaglogger_info("[Mask] Masking td-agent log file : #{file}...")
           filename = file.split("/")[-1]
           if filename.include?(".gz")
@@ -199,7 +201,7 @@ module Diagtool
           elsif
             m.mask_tdlog(file, clean = true)
           end
-        end
+	}
       end
       
       if @conf[:mask] == 'yes'

data/lib/fluent/diagtool/version.rb

@@ -1,5 +1,5 @@
 module Fluent
   module Diagtool
-    VERSION = "0.1.5"
+    VERSION = "0.1.6"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-diagtool
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - kubotat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-28 00:00:00.000000000 Z
+date: 2020-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fileutils