RotateLogs golang

这个包主要的结构就是这个,RotateLogs日志的分割主要是实现了io.Writer ,配合一些其它包使用

type RotateLogs struct {
    clock         Clock  // 时区
    curFn         string // 当前文件路径
    curBaseFn     string
    globPattern   string // 用来匹配文件的
    generation    int  // 用来做日志分割,比如按文件大小,那么就生成test.1 test.2这种
    linkName      string  //  生成软链,指向最新日志文件
    maxAge        time.Duration  // 文件最大保存时间
    mutex         sync.RWMutex
    eventHandler  Handler
    outFh         *os.File  // 操作文件对象,最终执行write的对象
    pattern       *strftime.Strftime
    rotationTime  time.Duration //  日志切割时间间隔
    rotationSize  int64    // 日志分割大小
    rotationCount uint   // 切割数量
    forceNewFile  bool // 是否强制新建日志文件
}

日志分割主要是实现了io的write接口,如果这个不明白,可以看golang接口相关的知识

// Write satisfies the io.Writer interface. It writes to the
// appropriate file handle that is currently being used.
// If we have reached rotation time, the target file gets
// automatically rotated, and also purged if necessary.
func (rl *RotateLogs) Write(p []byte) (n int, err error) {
    // Guard against concurrent writes
    rl.mutex.Lock()
    defer rl.mutex.Unlock()

    out, err := rl.getWriter_nolock(false, false)
    if err != nil {
        return 0, errors.Wrap(err, `failed to acquite target io.Writer`)
    }

    return out.Write(p)
}

write方法主要是下面这个方法

// must be locked during this operation
func (rl *RotateLogs) getWriter_nolock(bailOnRotateFail, useGenerationalNames bool) (io.Writer, error) {
    generation := rl.generation
    previousFn := rl.curFn
    // This filename contains the name of the "NEW" filename
    // to log to, which may be newer than rl.currentFilename
  // 会根据输入的path的规则去生成当前的文件的名称,用于比较是不是需要新建,还是用老的文件
    baseFn := rl.genFilename()
    filename := baseFn
    var forceNewFile bool
        // 获取文件的操作对象
    fi, err := os.Stat(rl.curFn)
    sizeRotation := false
      // 判断是否需要按文件大小来分割
    if err == nil && rl.rotationSize > 0 && rl.rotationSize <= fi.Size() {
        forceNewFile = true
        sizeRotation = true
    }
      // 比较新生成的文件和当前操作的是不是相同,相等用当前对象的outFh就行,不相等的话,
    if baseFn != rl.curBaseFn {
        generation = 0
        // even though this is the first write after calling New(),
        // check if a new file needs to be created
        if rl.forceNewFile {
            forceNewFile = true
        }
    } else {
        if !useGenerationalNames && !sizeRotation {
            // nothing to do
            return rl.outFh, nil
        }
        forceNewFile = true
        generation++
    }
    if forceNewFile {
        // A new file has been requested. Instead of just using the
        // regular strftime pattern, we create a new file name using
        // generational names such as "foo.1", "foo.2", "foo.3", etc
        var name string
        for {
            if generation == 0 {
                name = filename
            } else {
                name = fmt.Sprintf("%s.%d", filename, generation)
            }
            if _, err := os.Stat(name); err != nil {
                filename = name
                break
            }
            generation++
        }
    }
    // make sure the dir is existed, eg:
    // ./foo/bar/baz/hello.log must make sure ./foo/bar/baz is existed
    dirname := filepath.Dir(filename)
    if err := os.MkdirAll(dirname, 0755); err != nil {
        return nil, errors.Wrapf(err, "failed to create directory %s", dirname)
    }
    // if we got here, then we need to create a file
    fh, err := os.OpenFile(filename, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644)
    if err != nil {
        return nil, errors.Errorf("failed to open file %s: %s", rl.pattern, err)
    }

    if err := rl.rotate_nolock(filename); err != nil {
        err = errors.Wrap(err, "failed to rotate")
        if bailOnRotateFail {
            // Failure to rotate is a problem, but it's really not a great
            // idea to stop your application just because you couldn't rename
            // your log.
            //
            // We only return this error when explicitly needed (as specified by bailOnRotateFail)
            //
            // However, we *NEED* to close `fh` here
            if fh != nil { // probably can't happen, but being paranoid
                fh.Close()
            }
            return nil, err
        }
        fmt.Fprintf(os.Stderr, "%s\n", err.Error())
    }

    rl.outFh.Close()
    rl.outFh = fh
    rl.curBaseFn = baseFn
    rl.curFn = filename
    rl.generation = generation

    if h := rl.eventHandler; h != nil {
        go h.Handle(&FileRotatedEvent{
            prev:    previousFn,
            current: filename,
        })
    }
    return fh, nil
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,588评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,456评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,146评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,387评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,481评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,510评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,522评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,296评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,745评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,039评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,202评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,901评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,538评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,165评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,415评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,081评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,085评论 2 352

推荐阅读更多精彩内容