使用go開發一個自己的exporter

github地址:https://github.com/strive-after/demo-exporter

此項目借鑑了社區提供的mysql exporter 以及zhangguanzhang的harbor_exporter

https://github.com/zhangguanzhang/harbor_exporter

https://github.com/prometheus/mysqld_exporter

一、Prometheus的基本指標類型

1、 Counter：只增不減的累加指標

Counter就是一個計數器，表示一種累積型指標，該指標只能單調遞增或在重新啓動時重置爲零，例如，您可以使用計數器來表示所服務的請求數，已完成的任務或錯誤。

2、 Gauge：可增可減的測量指標

Gauge是最簡單的度量類型，只有一個簡單的返回值，可增可減，也可以set爲指定的值。所以Gauge通常用於反映當前狀態，比如當前溫度或當前內存使用情況；當然也可以用於“可增加可減少”的計數指標。

3、Histogram：自帶buckets區間用於統計分佈的直方圖

Histogram主要用於在設定的分佈範圍內(Buckets)記錄大小或者次數。

例如http請求響應時間：0-100ms、100-200ms、200-300ms、>300ms 的分佈情況，Histogram會自動創建3個指標，分別爲：

事件發送的總次數：比如當前一共發生了2次http請求
所有事件產生值的大小的總和：比如發生的2次http請求總的響應時間爲150ms
事件產生的值分佈在bucket中的次數：比如響應時間0-100ms的請求1次，100-200ms的請求1次，其他的0次
4、Summary：數據分佈統計圖

Summary和Histogram類似，都可以統計事件發生的次數或者大小，以及其分佈情況。

Summary和Histogram都提供了對於事件的計數_count以及值的彙總_sum，因此使用_count,和_sum時間序列可以計算出相同的內容。

同時Summary和Histogram都可以計算和統計樣本的分佈情況，比如中位數，n分位數等等。不同在於Histogram可以通過histogram_quantile函數在服務器端計算分位數。而Sumamry的分位數則是直接在客戶端進行定義。因此對於分位數的計算。 Summary在通過PromQL進行查詢時有更好的性能表現，而Histogram則會消耗更多的資源。相對的對於客戶端而言Histogram消耗的資源更少。

二、開發exporter

1.exporter簡介

既然我們已經瞭解了prometheus的指標類型，那麼可以思考我們是不是隻需要把指標採集並且做成prometheus支持的格式，類似於圖中的格式

2.首先介紹一下基本的目錄結構

man函數作爲總入口提供web url /metrices以及訪問/的時候提供一些基本介紹

collector作爲控制器端

裏面會有exporter的基本屬性以及指標採集過程

3.代碼簡介

（1）mai n.go

package main

import (
   "flag"
   "github.com/prometheus/client_golang/prometheus"
   "github.com/prometheus/client_golang/prometheus/promhttp"
   log "github.com/sirupsen/logrus"
   "myexporter/collector"
   "net/http"
   "strings"
)

var (
   metricsPath string = "https://github.com/strive-after/demo-exporter"
   version string = "v1.0"
   listenAddress string
   help bool
   disable  string  //命令行傳入的需要關閉的指標
   disables  []string   //處理命令行傳入的根據,分割爲一個切片做處理
)

func init()  {
   flag.StringVar(&listenAddress,"addr",":8080","addr")
   flag.BoolVar(&help,"h",false,"help")
   flag.StringVar(&disable,"disable","","關閉的指標收集器")
}




func main() {
   flag.Parse()
   if help {
      flag.Usage()
      return
   }
   disables = strings.Split(disable,",")
   //手動開關
   //通過用戶輸入的我們做關閉
   for scraper ,_:= range collector.Scrapers {
      for _,v := range disables {
         if v == scraper.Name() {
            collector.Scrapers[scraper] = false
            break
         }
      }
   }

   //訪問/的時候返回一些基礎提示
   http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
      w.Write([]byte(`<html>
             <head><title>` + collector.Name() + `</title></head>
             <body>
             <h1><a style="text-decoration:none" href=''>` + collector.Name() + `</a></h1>
             <p><a href='` + metricsPath + `'>Metrics</a></p>
             <h2>Build</h2>
             <pre>` + version + `</pre>
             </body>
             </html>`))
   })
   //根據開關來判斷指標的是否需要收集  這裏只有代碼裏面的判斷  用戶手動開關還未做
   enabledScrapers := []collector.Scraper{}
   for scraper, enabled := range collector.Scrapers {
      if enabled {
         log.Info("Scraper enabled ", scraper.Name())
         enabledScrapers = append(enabledScrapers, scraper)
      }
   }

   //註冊自身採集器
   exporter := collector.New(collector.NewMetrics(),enabledScrapers)
   prometheus.MustRegister(exporter)

   http.Handle("/metrics", promhttp.Handler())
   //監聽端口
   if err := http.ListenAndServe(listenAddress, nil); err != nil {
      log.Printf("Error occur when start server %v", err)
   }
}

main主要提供了2個url 以及提供指標採集的開關用戶通過手動或者我們代碼中控制來做指標收集的開關比如某些指標不想要我們想捨棄就可以通過-disable來控制關閉也可以在代碼中修改，後續會介紹代碼中修改方式

（2）switch.go

package collector

var (
   Scrapers = map[Scraper]bool{
      CpuLoad{}: true,
   }
)

這裏就做了開關控制我們在代碼中實現就是通過修改這個bool值來做每當我們添加一個指標需要在map中添加一個指標的name 以及bool 添加指標後續會介紹

(3)exporter.go

package collector

import (
   "github.com/prometheus/client_golang/prometheus"
   log "github.com/sirupsen/logrus"
   "sync"
)

var (
   name string= "test_exporter"
   namespace string = "test"
   exporter string = "exporter"
)

func Name() string {
   return  name
}

type Exporter struct {
   metrics Metrics
   scrapers []Scraper
}

type Metrics struct {
   //收集指標的總次數
   TotalScrapes prometheus.Counter
   //收集指標中發生錯誤的次數
   ScrapeErrors *prometheus.CounterVec
   //最後一次是否發生了錯誤
   Error        prometheus.Gauge
}

//fqname會把namespace subsystem name拼接起來
//傳入動態以及靜態標籤 設置標籤
func NewDesc(subsystem, name, help string,movinglabel []string ,label prometheus.Labels) *prometheus.Desc {
   return prometheus.NewDesc(
      prometheus.BuildFQName(namespace, subsystem, name),
      help, movinglabel, label,
   )
}
//判斷*exporter是否實現了collector這個接口的所有方法
var  _ prometheus.Collector = (*Exporter)(nil)

func New(metrics Metrics, scrapers []Scraper) *Exporter{
   return &Exporter{
      metrics: metrics,
      scrapers: scrapers,
   }
}

func NewMetrics() Metrics {
   subsystem := exporter
   return Metrics{
      TotalScrapes: prometheus.NewCounter(prometheus.CounterOpts{
         Namespace: namespace,
         Subsystem: subsystem,
         Name:      "scrapes_total",
         Help:      "Total number of times  was scraped for metrics.",
      }),
      ScrapeErrors: prometheus.NewCounterVec(prometheus.CounterOpts{
         Namespace: namespace,
         Subsystem: subsystem,
         Name:      "scrape_errors_total",
         Help:      "Total number of times an error occurred scraping .",
      }, []string{"collector"}),
      Error: prometheus.NewGauge(prometheus.GaugeOpts{
         Namespace: namespace,
         Subsystem: subsystem,
         Name:      "last_scrape_error",
         Help:      "Whether the last scrape of metrics  resulted in an error (1 for error, 0 for success).",
      }),
   }
}


//添加描述符
func (e *Exporter) Describe(ch chan <-  *prometheus.Desc) {
   ch <- e.metrics.TotalScrapes.Desc()
   ch <- e.metrics.Error.Desc()
   e.metrics.ScrapeErrors.Describe(ch)
}

//收集指標
func (e *Exporter) Collect(ch chan <- prometheus.Metric) {
   e.scrape(ch)
   ch <- e.metrics.TotalScrapes
   ch <- e.metrics.Error
   e.metrics.ScrapeErrors.Collect(ch)
}
//通過例程併發的收集指標 需要加waitgroup
func (e *Exporter) scrape(ch chan <- prometheus.Metric) {
   var (
      wg sync.WaitGroup
      err error
   )

   defer wg.Wait()
   for _,scraper := range  e.scrapers {
      wg.Add(1)
      //使用匿名函數 並且併發的收集指標
      go func(scraper Scraper) {
         defer wg.Done()
         label := scraper.Name()
         err = scraper.Scrape(ch)
         if err != nil {
            log.WithField("scraper", scraper.Name()).Error(err)
            e.metrics.ScrapeErrors.WithLabelValues(label).Inc()
            e.metrics.Error.Set(1)
         }
      }(scraper)
   }
}

Exporter.go中主要是通過New 以及NewMetrics 初始化exporter結構體以及Metrics 結構體 exporter結構體需要滿足Describe 和Collect 方法

（4）scraper.go

package collector

import "github.com/prometheus/client_golang/prometheus"

type Scraper interface {
   // Name of the Scraper. Should be unique.
   Name() string

   // Help describes the role of the Scraper.
   // Example: "Collect from SHOW ENGINE INNODB STATUS"
   //Help() string

   // Scrape collects data from client and sends it over channel as prometheus metric.
   Scrape(ch chan<- prometheus.Metric) error
}

所有指標收集需要滿足2個方法 name返回指標名字來用於用戶開關指標的可以理解爲所有指標都必須滿足這個約定

等同於我們一個接口切片，將結構體賦值給接口但是結構體需要滿足接口的方法，然後range 並調用接口的Scrape 來採集指標

go的接口繼承類似於鴨子接口定義了鴨子長什麼樣子也就是需要實現的方法，那麼我們實現了這些方法的結構體就是一隻鴨子然後map中的k是一個接口我們賦予的是一個結構體結構體實現了接口的方法，那麼我們就可以吧結構體賦值給接口

（5）cpu.go

package collector

import (
   "github.com/prometheus/client_golang/prometheus"
   "github.com/shirou/gopsutil/load"
   "log"
)

type CpuLoad struct {}

// cpu info

func (CpuLoad) Name() string {
   return namespace + "_cpu_load"
}

func (CpuLoad) Scrape(ch chan <- prometheus.Metric) error  {
   hostinfo := GetHost()
   cpuload,err  := load.Avg()
   if err != nil {
      log.Printf("cpu load is not ,%v\n",err)
      return err
   }

   ch <- prometheus.MustNewConstMetric(
      //這裏的label是固定標籤 我們可以通過
      NewDesc("cpu_load","one","cpu load",[]string{"type"},prometheus.Labels{"host":hostinfo.HostName,"ip":hostinfo.IP}),
      prometheus.GaugeValue,
      cpuload.Load1,
      //動態標籤的值 可以有多個動態標籤
      "metrics",
   )
   ch <- prometheus.MustNewConstMetric(
      NewDesc("cpu_load","five","cpu load",nil,nil),
      prometheus.GaugeValue,
      cpuload.Load5,
   )
   ch <- prometheus.MustNewConstMetric(
      NewDesc("cpu_load","fifteen","cpu load",nil,nil),
      prometheus.GaugeValue,
      cpuload.Load15,
   )
   return nil
}

這個就相對簡單。我們只需使用之前定義的函數方法。滿足name以及Scrape 接口即可然後通過chan <- prometheus.Metric只寫管道來寫入我們需要的指標，這裏需要注意的是我們之前提到的4中prometheus指標類型有一些在這裏需要float64的值傳入但是我們收集到的並不一定都是float64類型的那麼我們在做類型轉換的過程中需要考慮大轉小溢出的問題

三、運行exporter

到這裏我們的exporter就開發完成了讓我們編譯跑起來看一看我這裏是mac環境如果編譯linux 可以百度一下mac編譯linux

CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build  .

這個是mac環境編譯linux可執行程序

如果你在linux系統那麼你可以直接build

如何安裝go以及配置go proxy 可以百度一下這裏使用的是1.14的go

nohup ./myexporter &> 1.txt &

prometheus添加我們的exporter地址

當然如果需要docker image 也可以自己製作一個dockerfile

Go開發屬於自己的exporter

使用go開發一個自己的exporter

一、Prometheus的基本指標類型

二、開發exporter

三、運行exporter

AI模型 Llama 3體驗筆記

【面試準備】又一次失敗的面試經歷，題目離譜～資深軟件測試工程師

dotnet 8 版本與銀河麒麟V10和UOS系統的 glibc 兼容性

Go開發屬於自己的exporter

Prometheus operator部署kube-metrics連接kublet401

kubernetes源碼剖析讀後感（二）

Gorm(簡介)

Gorm(表的操作以及索引的操作)

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結