使用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

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以太網驅動總結