flumengtaildirectorysource 修改调试可用

由于flume-ng至1.5版本仍旧没有稳定可用的类似flume-og中的taildir的功能，所以从git中https://github.com/jinoos/flume-ng-extends找了一个别人针对flume-ng实现的的taildir这个按照github上他自己说明，是没法正常使用的。查看了源码后，做了一些相应修改

1. 默认的DirectoryTailParserModulable类修改

他实现了2种DirectoryTailParserModulable

　　第一种是SingleLineParserModule，适用日志里只有单条记录的。并且代码中默认就是使用的这个，显然很不靠谱。提供了配置项，但是说明里没有写出来，配置项为 ‘parser’.

　  第二种是MultiLineParserModule，适用多行的日志文件的。这里我们大部分情况肯定是要用这个的。

DirectoryTailSource类中如下行

  private static final String DEFAULT_PARSER_MODULE_CLASS = "com.jinoos.flume.SingleLineParserModule";

修改为。包名根据实际情况来更改

  private static final String DEFAULT_PARSER_MODULE_CLASS = "org.apache.flume.source.taildirectory.MultiLineParserModule";

2. first-line-pattern配置

这是MultiLineParserModule中的一个属性，用来验证读进来的行是否为第一行。这个说明中也没提到

如果没有配置这个配置，那么就无法正常执行，会报“wrong log format”。

主要代码如下：

        private void readMessage(FileSet fileSet) {
            try {
                String buffer;

                synchronized (fileSet) {

                    while ((buffer = fileSet.readLine()) != null) {
                        if (buffer.length() == 0) {
                            continue;
                        }

                        boolean isFirstLine = parserModule.isFirstLine(buffer);
                        if (isFirstLine) {
                            sendEvent(fileSet);
                            fileSet.appendLine(buffer);
                            parserModule.parse(buffer, fileSet);

                        } else {
                            if (fileSet.getLineSize() == 0) {
                                logger.debug("Wrong log format, " + buffer);
                                continue;
                            } else {
                                fileSet.appendLine(buffer);
                                parserModule.parse(buffer, fileSet);
                            }
                        }

                        if (parserModule.isLastLine(buffer)) {
                            sendEvent(fileSet);
                        }
                    }
                }
            } catch (IOException e) {
                logger.warn(e.getMessage(), e);
            }
        }

根据我们的实际需求，我们不需要判断是否第一行，只要有change事件，全部写入到channel中即可

修改为如下方式

        // 파일을 읽고 Event를 생성한다.
        private void readMessage(FileSet fileSet) {
            try {
                String buffer;

                synchronized (fileSet) {

                    while ((buffer = fileSet.readLine()) != null) {
                        if (buffer.length() == 0) {
                            continue;
                        }

                        fileSet.appendLine(buffer);
                        sendEvent(fileSet);
                    }
                }
            } catch (IOException e) {
                logger.warn(e.getMessage(), e);
            }
        }

改为这种方式后，只要来一行就会send到channel中。如果需要批量的，可以按自己要求更改。

现在就不再需要关注first-line-pattern这个配置了。

注意：但是配置在配置文件中还是配的，虽然它没有起到任何作用。如果想不配置，请修改MultiLineParserModule的configure（Context context）方法

3.监控文件中有中文，编码的配置添加

 目前这个版本是无法支持中文的文件的。

正式读取数据的方法：位置FileSet类中

  public String readLine() throws IOException {
    return rReader.readLine();
  }

这个rReader是个RandomAccessFile对象

  public FileSet(AbstractSource source, FileObject fileObject)
      throws IOException {
    this.source = source;
    this.fileObject = fileObject;

    this.bufferList = new ArrayList<String>();

    //File f = new File(fileObject.getName().getPath());
    File f = new File("d:/tmp/log_compare/test1.txt");

    rReader = new RandomAccessFile(f, "r");
    rReader.seek(f.length());

    bufferList = new ArrayList<String>();
    headers = new HashMap<String, String>();
    logger.debug("FileSet has been created " + fileObject.getName().getPath());
    this.seq = 0L;
  }

在FileSet类实例化时创建。

下面开始修改操作，源代码中是直接使用了RandomAccessFile的readline()方法，修改为按byte读取的方式

  /**
   * 
   * @Title: readLine
   * @Description: TODO(读取文件中的一行)
   * @param @throws IOException    设定文件
   * @return String    返回类型
   * @throws
   */
  public String readLine() throws IOException {
    if(rReader.getFilePointer() < rReader.length()) {
        byte b = rReader.readByte();//读取一个byte
        int i = 0;
        byte[] buf = new byte[10240];//创建大小为1M的数据，如果你的单行超过1M，那么会出错
        //如果读到换行符，或者读到文件最后就停止。表示已经读完一行
        while(b != '\n' && rReader.getFilePointer() < rReader.length()) {
            buf[i++] = b;
            b = rReader.readByte();
            
        }
        return new String(buf,0,i);
    }else{
        return "";
    }
  }

改完后重新打包再次测试，发现已经可以支持中文了。

4.每次新文件刚被创建时会丢失第一条数据

代码如下

        public void run() {
            while (true) {
                try {
                    // DirectoryTailEvent event = eventQueue.poll(
                    // eventQueueWorkerTimeoutMiliSecond,
                    // TimeUnit.MILLISECONDS);
                    DirectoryTailEvent event = eventQueue.take();

                    if (event == null) {
                        continue;
                    }

                    if (event.type == FileEventType.FILE_CHANGED) {
                        fileChanged(event.event);
                    } else if (event.type == FileEventType.FILE_CREATED) {
                        fileCreated(event.event);
                    } else if (event.type == FileEventType.FILE_DELETED) {
                        fileDeleted(event.event);
                    } else if (event.type == FileEventType.FLUSH) {
                        if (event.fileSet != null)
                            sendEvent(event.fileSet);
                    }
                } catch (InterruptedException e) {
                    logger.debug(e.getMessage(), e);
                } catch (FileSystemException e) {
                    logger.info(e.getMessage(), e);
                }
            }
        }

上面这段代码为监测的文件夹有新的事件时的处理。这里我们要看的是FILE_CREATE事件，他调用了fileCreated(event.event);

    private void fileCreated(FileChangeEvent event)
                throws FileSystemException {
            String path = event.getFile().getName().getPath();
            String dirPath = event.getFile().getParent().getName().getPath();

            logger.debug(path + " has been created.");

            DirPattern dirPattern = null;
            dirPattern = pathMap.get(dirPath);

            if (dirPattern == null) {
                logger.warn("Occurred create event from un-indexed directory. "
                        + dirPath);
                return;
            }

            // 파일명이 대상인지 검사한다.
            if (!isInFilePattern(event.getFile(), dirPattern.getFilePattern())) {
                logger.debug(path + " is not in file pattern.");
                return;
            }

            FileSet fileSet;

            fileSet = fileSetMap.get(event.getFile().getName().getPath());
            //fileSet = fileSetMap.get(path);
            if (fileSet == null) {
                try {
                    logger.info(path
                            + " is not in monitoring list. It's going to be listed.");
                    
                    fileSet = new FileSet(source, event.getFile());
                    // a little synchronized bug here.fixed by tqli,2014-08-07
                    // ,E-mail:tiangang1126@126.com
                    synchronized (fileSetMap) {
                        fileSetMap.put(path, fileSet);
                    }
                } catch (IOException e) {
                    logger.error(e.getMessage(), e);
                    return;
                }
            }
        }

看第27行，当新的文件进来，需要创建一个fileSet对象。将这个fileSet对象存入fileSetMap中

看fileSet实例化的方法，上面已经贴过了

  public FileSet(AbstractSource source, FileObject fileObject)
      throws IOException {
    this.source = source;
    this.fileObject = fileObject;

    this.bufferList = new ArrayList<String>();

    File f = new File(fileObject.getName().getPath());
    //File f = new File("d:/tmp/log_compare/test1.txt");
    rReader = new RandomAccessFile(f, "r");
    rReader.seek(f.length());
    bufferList = new ArrayList<String>();
    headers = new HashMap<String, String>();
    logger.debug("FileSet has been created " + fileObject.getName().getPath());
    logger.debug("file length now is : " + f.length());
    this.seq = 0L;
  }

注意看第11行，将游标移到到f.length的位置，这样的问题就是跟着文件新建时写入的内容，全部被忽略了。这样就造成了数据丢失

那怎么解决这个问题呢，简单的改为

rReader.seek(0);

肯定是不行的，具体的原因，大家自己思考下吧。

我们目的的就是在有监控新的事件时，创建的fileSet，游标位置能在文件原来的的位置。
需求明确了，下面就知道该做哪些事了。
1 首先在DirectoryTailSource中start方法执行时，将配置监控文件下符合正则条件文件的length都保存在一个Map里
2 在监听到新事件新建fileSet时，判断这个文件是新建的还是之前就存在的，如果是之前就存在的，那么就可以直接取之前记下的这个文件的大小。如果不存在，说明这个文件是个新文件，则从0位置开始读
注意：这个不支持文件更改的情况，只能适应只对文件做增加的场景
下面是代码修改的部分

DirectoryTailSource类

添加 fileInitLengthMap 属性

    private Map<String, DirPattern> dirMap;
    private Map<String, DirPattern> pathMap;
    private Map<String,Long> fileInitLengthMap;//文件初始大小记录，用来定位新建fileSet时的游标初始位置

在configure方法中实例化fileInitLengthMap

    public void configure(Context context) {
        logger.info("Source Configuring..");

        dirMap = new HashMap<String, DirPattern>();
        pathMap = new HashMap<String, DirPattern>();
        fileInitLengthMap = new HashMap<String,Long>();

在start方法中初始化fileInitLengthMap。保存全部符合正则条件的文件大小。红色部分为添加的代码

    public void start() {
        logger.info("Source Starting..");

        if (sourceCounter == null) {
            sourceCounter = new SourceCounter(getName());
        }

        fileSetMap = new Hashtable<String, FileSet>();

        try {
            fsManager = VFS.getManager();
        } catch (FileSystemException e) {
            logger.error(e.getMessage(), e);
            return;
        }

        monitorRunnable = new MonitorRunnable();

        fileMonitor = new DefaultFileMonitor(monitorRunnable);
        fileMonitor.setRecursive(false);

        FileObject fileObject;

        logger.debug("Dirlist count " + dirMap.size());
        for (Entry<String, DirPattern> entry : dirMap.entrySet()) {
            logger.debug("Scan dir " + entry.getKey());

            DirPattern dirPattern = entry.getValue();

            try {
                fileObject = fsManager.resolveFile(dirPattern.getPath());
            } catch (FileSystemException e) {
                logger.error(e.getMessage(), e);
                continue;
            }

            try {
                if (!fileObject.isReadable()) {
                    logger.warn("No have readable permission, "
                            + fileObject.getURL());
                    continue;
                }

                if (FileType.FOLDER != fileObject.getType()) {
                    logger.warn("Not a directory, " + fileObject.getURL());
                    continue;
                }

                // 폴더를 Monitoring 대상에 추가한다.
                fileMonitor.addFile(fileObject);
                logger.debug(fileObject.getName().getPath()
                        + " directory has been add in monitoring list");
                pathMap.put(fileObject.getName().getPath(), entry.getValue());
                //pathMap.put("d:/tmp/log_compare", entry.getValue());
                //新增部分，文件初始化大小保存
56                 FileObject[] allChiledfile = fileObject.getChildren();
57                 for(FileObject chiledFileobject : allChiledfile) {
58                     if(dirPattern.getFilePattern().matcher(chiledFileobject.getName().getBaseName()).find()) {
59                         String chiledFildPath = chiledFileobject.getName().getPath();
60                         //String chiledFildPath = "d:/tmp/log_compare/test1.txt";
61                         File chiledfile = new File(chiledFildPath);
62                         fileInitLengthMap.put(chiledFildPath, 
63                                 chiledfile.length());
64                         logger.debug(chiledFildPath + " init length is :" + chiledfile.length());
65                     }
66                 }
            } catch (FileSystemException e) {
                logger.warn(e.getMessage(), e);
                continue;
            } catch (Exception e) {
                logger.debug(e.getMessage(), e);
            }

        }

        executorService = Executors
                .newFixedThreadPool(eventQueueWorkerSize + 1);
        monitorFuture = executorService.submit(monitorRunnable);

        for (int i = 0; i < eventQueueWorkerSize; i++) {
            workerFuture[i] = executorService.submit(new WorkerRunnable(this));
        }

        sourceCounter.start();
        super.start();
    }

FileSet类

  public FileSet(AbstractSource source, FileObject fileObject,Map<String,Long> fileInitLengthMap)
      throws IOException {
    this.source = source;
    this.fileObject = fileObject;

    this.bufferList = new ArrayList<String>();

    File f = new File(fileObject.getName().getPath());
    rReader = new RandomAccessFile(f, "r");
    /*
     *判断在初始化taildirSource时，这个文件是否存在，如果存在则游标定位当时记录下的文件长度开始
     *如果不存在，则说明这是一个新建的文件，游标从0开始
     */
    if(fileInitLengthMap.containsKey(fileObject.getName().getPath())) {
15         rReader.seek(fileInitLengthMap.get(fileObject.getName().getPath()));
16     }else{
17         rReader.seek(0);
18     }
    
    bufferList = new ArrayList<String>();
    headers = new HashMap<String, String>();
    logger.debug("FileSet has been created " + fileObject.getName().getPath());
    logger.debug("file length now is : " + f.length());
    this.seq = 0L;
  }

修改类实例化的方法。并修改DirectoryTailSource类中调用FileSet实例化方法的地方。

至此修改全部全部完成。

没找到能上传附件的地方，改完的jar包就不提供了。

此为一个使用这个jar的例子

a.sources = sources
a.sinks = sinks
a.channels = c

#configure sources
a.sources.sources.type = org.apache.flume.source.taildirectory.DirectoryTailSource
a.sources.sources.dirs = s0
#a.sources.sources.dirs.s0.path = /usr/local/nginx/logs/
a.sources.sources.dirs.s0.path = /home/flume/testTailDir
a.sources.sources.dirs.s0.file-pattern = ^access_.*log$
a.sources.sources.first-line-pattern = ^(.*)$
#congfigure sinks
a.sinks.sinks.type = file_roll
a.sinks.sinks.sink.directory = /home/flume/testTailDir2
a.sinks.sinks.sink.rollInterval = 30
a.sinks.sinks.channel = c
#configure channals
a.channels.c.type = memory
#bind channel
a.sources.sources.channels = c