手把手教你為開源項(xiàng)目貢獻(xiàn)代碼-魔扣目錄

背景

前段時(shí)間無意間看到一篇公眾號(hào) 招賢令：一起來搞一個(gè)新開源項(xiàng)目，作者介紹他想要做一個(gè)開源項(xiàng)目：cprobe 用于整合目前市面上散落在各地的 Exporter，統(tǒng)一進(jìn)行管理。

比如我們常用的 blackbox_exporter/MySQLd_exporter 等。

以往的每一個(gè) Exporter 都需要單獨(dú)部署運(yùn)維。

同時(shí)又完全兼容 Prometheus 生態(tài)，也可以復(fù)用現(xiàn)有的監(jiān)控面板。

恰好這段時(shí)間我也在公司從事可觀測性相關(guān)的業(yè)務(wù)，發(fā)現(xiàn)這確實(shí)是一個(gè)痛點(diǎn)。

于是便一直在關(guān)注這個(gè)項(xiàng)目，同時(shí)也做了些貢獻(xiàn)；因?yàn)樵擁?xiàng)目的核心是用于整合 exporter，所以為其編寫插件也是非常重要的貢獻(xiàn)了。

編寫插件

整個(gè)項(xiàng)目執(zhí)行流程圖如下：

可以看到編寫插件最核心的便是自定義插件解析自定義的配置文件、抓取指標(biāo)的邏輯。

比如我們需要在配置中指定抓取目標(biāo)的域名、抓取規(guī)則等。

這里 cprobe 已經(jīng)抽象出了兩個(gè)接口，我們只需要做對(duì)應(yīng)的實(shí)現(xiàn)即可。

type Plugin interface {  
    // ParseConfig is used to parse config  
    ParseConfig(baseDir string, bs []byte) (any, error)  
    // Scrape is used to scrape metrics, cfg need to be cast specific cfg  
    Scrape(ctx context.Context, target string, cfg any, ss *types.Samples) error  
}

下面就以我之前編寫的 Consul 為例。

# Allows any Consul server (non-leader) to service a read.  
allow_stale = true  
  
# === CA  
# File path to a PEM-encoded certificate authority used to validate the authenticity of a server certificate.  
ca_file = "/etc/consul.d/consul-agent-ca.pem"  
  
# File path to a PEM-encoded certificate used with the private key to verify the exporter's authenticity.  
cert_file = "/etc/consul.d/consul-agent.pem"  
  
# Generate a health summary for each service instance. Needs n+1 queries to collect all information.  
health_summary = true  
  
# File path to a PEM-encoded private key used with the certificate to verify the exporter's authenticity  
key_file = "/etc/consul.d/consul-agent-key.pem"  
  
# Disable TLS host verification.  
insecure = false

這里每個(gè)插件的配置都不相同，所以我們需要將配置解析到具體的結(jié)構(gòu)體中。

func (*Consul) ParseConfig(baseDir string, bs []byte) (any, error) {  
    var c Config  
    err := toml.Unmarshal(bs, &c)  
    if err != nil {  
       return nil, err  
    }  
  
    if c.Timeout == 0 {  
       c.Timeout = time.Millisecond * 500  
    }  
    return &c, nil  
}

解析配置文件沒啥好說的，根據(jù)自己的邏輯實(shí)現(xiàn)即可，可能會(huì)配置一些默認(rèn)值而已。

下面是核心的抓取邏輯，本質(zhì)上就是使用對(duì)應(yīng)插件的 Client 獲取一些核心指標(biāo)封裝為 Prometheus 的 Metric，然后由 cprobe 寫入到遠(yuǎn)端的 Prometheus 中(或者是兼容 Prometheus 的數(shù)據(jù)庫中)。

// Create client
config.HttpClient.Timeout = opts.Timeout  
config.HttpClient.Transport = transport  
  
client, err := consul_api.NewClient(config)  
if err != nil {  
    return nil, err  
}  
  
var requestLimitChan chan struct{}  
if opts.RequestLimit > 0 {  
    requestLimitChan = make(chan struct{}, opts.RequestLimit)  
}