prometheus如何实现配置文件动态管理

因为prometheus并不提供配置文件动态更新的API,所以使用文件作为prometheus服务发现的情况下,只能通过修改文件的方式达到更新配置的目的,
常规步骤如下:

  1. 修改配置文件
  2. 重启prometheus服务(调用/-/reload使得配置变更生效,前提是开启了--web.enable-lifecycle支持)

一般修改配置如告警规则等属于低频事件,修改保持了就需要重启使之生效,那其实期望这两步能够合二为一,即:
修改完配置立刻应用更新。

promethesu本身也提供这一功能,配置关键字为file_sd_configs,实现这一功能的引入的项目为fsnotify

Go的文件系统通知

要实现以上两步合二为一的功能,很容易想到以下做法:

  1. 监听文件变化
  2. 处理文件变化

可以先来看看fsnotify的示例代码

package main

import (
    "log"

    "github.com/fsnotify/fsnotify"
)

func main() {
    watcher, err := fsnotify.NewWatcher()
    if err != nil {
        log.Fatal(err)
    }
    defer watcher.Close()

    done := make(chan bool)
    go func() {
        for {
            select {
            case event, ok := <-watcher.Events:
                if !ok {
                    return
                }
                log.Println("event:", event)
                if event.Op&fsnotify.Write == fsnotify.Write {
                    log.Println("modified file:", event.Name)
                }
            case err, ok := <-watcher.Errors:
                if !ok {
                    return
                }
                log.Println("error:", err)
            }
        }
    }()

    err = watcher.Add("/tmp/foo")
    if err != nil {
        log.Fatal(err)
    }
    <-done
}

可以看到监听文件是由watcher.Add("/tmp/foo")完成的,对文件变化事件的处理是由其中的起的Goroutine完成的。看到这里其实可以知道关键在于监听这一步是如何实现的,那就来debug一下吧,笔者环境为go1.14.4 darwin/amd64,使用VSCode进行代码调试,代码目录为下(为方便调试,建议将项目依赖使用go mod vendor打入vendor目录中):

.
├── go.mod
├── go.sum
├── main.go
├── notes.md
└── vendor
    ├── github.com
    ├── golang.org
    └── modules.txt

调试配置如下

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "fsnotify",
            "type": "go",
            "request": "launch",
            "mode": "auto",
            "program": "${workspaceRoot}/main.go",
            "env": {},
            "args": []
        }
    ]
}

单步调试的过程其实并不是特别直观,这里使用使用一个工具叫做go-callvis来全局看一下文件监听的整个调用链,可以注意到有一个register的函数调用如下:

image.png

关键代码如下

// register events with the queue
func register(kq int, fds []int, flags int, fflags uint32) error {
    changes := make([]unix.Kevent_t, len(fds))

    for i, fd := range fds {
        // SetKevent converts int to the platform-specific types:
        unix.SetKevent(&changes[i], fd, unix.EVFILT_VNODE, flags)
        changes[i].Fflags = fflags
    }

    // register the events
    success, err := unix.Kevent(kq, changes, nil, nil)
    if success == -1 {
        return err
    }
    return nil
}

此处能够注意到Kevent函数,到此处可以打住了(后绪的内容内容涉及cgo、动态链接细节,那是一块内容,跟此文关系不大),这是unix下基于kqueue的内核事件的系统调用。
至此,我们有了大致的脉络:

  1. 监听kevent事件(在NewWatcher起一个goroutine专门读取kevent, 100ms一次)
  2. 注册文件监控
  3. main中的goroutine即为对监听事件做出响应

其实看到这里,关键点就在于kevent了,跟操作系统内核打交道,比较有意思的一点是kevent的注册跟监底层调用是同一个函数,即:

func Kevent(kq int, changes, events []Kevent_t, timeout *Timespec) (n int, err error) {
    var change, event unsafe.Pointer
    if len(changes) > 0 {
        change = unsafe.Pointer(&changes[0])
    }
    if len(events) > 0 {
        event = unsafe.Pointer(&events[0])
    }
    return kevent(kq, change, len(changes), event, len(events), timeout)
}

只不过在注册监听的时候参数eventstimeout都为nil。用vim打开/tmp/foo并增加一行,程序运行结果为下:

2020/12/06 16:25:45 event: "/tmp/foo": CHMOD
2020/12/06 16:25:45 event: "/tmp/foo": WRITE
2020/12/06 16:25:45 modified file: /tmp/foo
2020/12/06 16:25:45 event: "/tmp/foo": CHMOD

总结,两个goroutine,一个读,一个写,这是典型的顾客-消费者模型,关键在于对操作系统kevent的运用。

参考:

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

推荐阅读更多精彩内容