exporter

Documentation

Index

• Constants
• Variables
• func DoConsulRegisterProc(addr, app, role, cluster, meta, host string, port int64)
• func GetConsulId(app string, role string, host string, port int64) string
• func GetLocalIpAddr(filter string) (ipaddr string, err error)
• func Init(role string, cfg *config.Config)
• func InitWithRouter(role string, cfg *config.Config, router *mux.Router, exPort string)
• func RegistConsul(cluster string, role string, cfg *config.Config)
• func SetBuckets(bks []float64)
• type Alarm
  • func Warning(detail string) (a *Alarm)
• type ConsulRegisterInfo
• type Counter
  • func NewCounter(name string) (c *Counter)
  • func (c *Counter) Add(val int64)
  • func (c *Counter) AddWithLabels(val int64, labels map[string]string)
  • func (c *Counter) Metric() prometheus.Counter
• type Gauge
  • func NewGauge(name string) (g *Gauge)
  • func (c *Gauge) Key() (key string)
  • func (c *Gauge) Metric() prometheus.Gauge
  • func (g *Gauge) Name() string
  • func (g *Gauge) Set(val float64)
  • func (g *Gauge) SetWithLabels(val float64, labels map[string]string)
  • func (g *Gauge) String() string
• type GaugeVec
  • func NewGaugeVec(name, help string, labels []string) *GaugeVec
  • func (v *GaugeVec) SetBoolWithLabelValues(val bool, lvs ...string)
  • func (v *GaugeVec) SetWithLabelValues(val float64, lvs ...string)
• type Histogram
  • func (c *Histogram) Key() (key string)
  • func (c *Histogram) Metric() prometheus.Histogram
  • func (g *Histogram) Name() string
  • func (g *Histogram) String() string
• type TimePoint
  • func NewTP(name string) (tp *TimePoint)
  • func (tp *TimePoint) GetStartTime() time.Time
  • func (tp *TimePoint) Set()
  • func (tp *TimePoint) SetWithLabels(labels map[string]string)
• type TimePointCount
  • func NewTPCnt(name string) (tpc *TimePointCount)
  • func (tpc *TimePointCount) GetStartTime() time.Time
  • func (tpc *TimePointCount) Set(err error)
  • func (tpc *TimePointCount) SetWithLabels(err error, labels map[string]string)
• type VersionMetrics
  • func NewVersionMetrics(module string) *VersionMetrics
  • func (m *VersionMetrics) SetStatPeriod(period time.Duration)
  • func (m *VersionMetrics) Start()
  • func (m *VersionMetrics) Stop()

Constants

const (
	RegisterPeriod = time.Duration(10) * time.Minute
	RegisterPath   = "/v1/agent/service/register"
)

const (
	PromHandlerPattern      = "/metrics"       // prometheus handler
	AppName                 = "cfs"            // app name
	ConfigKeyExporterEnable = "exporterEnable" // exporter enable
	ConfigKeyExporterPort   = "exporterPort"   // exporter port
	ConfigKeyConsulAddr     = "consulAddr"     // consul addr
	ConfigKeyConsulMeta     = "consulMeta"     // consul meta
	ConfigKeyIpFilter       = "ipFilter"       // add ip filter
	ConfigKeyEnablePid      = "enablePid"      // enable report partition id
	ConfigKeyPushAddr       = "pushAddr"       // enable push data to gateway
	ChSize                  = 1024 * 10        // collect chan size

	// monitor label name
	Vol     = "vol"
	Disk    = "disk"
	PartId  = "partid"
	Op      = "op"
	Type    = "type"
	Err     = "err"
	Version = "version"
)

const StatPeriod = time.Minute * time.Duration(1)

Variables

var (
	AlarmPool = &sync.Pool{New: func() interface{} {
		return new(Alarm)
	}}
	// AlarmGroup  sync.Map
	AlarmCh chan *Alarm
)

var (
	CounterGroup sync.Map
	CounterPool  = &sync.Pool{New: func() interface{} {
		return new(Counter)
	}}
	CounterCh chan *Counter
)

var (
	GaugeGroup sync.Map
	GaugeCh    chan *Gauge
)

var (
	HistogramGroup sync.Map
	HistogramCh    chan *Histogram
)

var (
	EnablePid = false
)

Functions

func DoConsulRegisterProc

func DoConsulRegisterProc(addr, app, role, cluster, meta, host string, port int64)

do consul register process

func GetConsulId

func GetConsulId(app string, role string, host string, port int64) string

get consul id

func GetLocalIpAddr

func GetLocalIpAddr(filter string) (ipaddr string, err error)

GetLocalIpAddr returns the local IP address.

func Init

func Init(role string, cfg *config.Config)

Init initializes the exporter.

func InitWithRouter

func InitWithRouter(role string, cfg *config.Config, router *mux.Router, exPort string)

Init initializes the exporter.

func RegistConsul

func RegistConsul(cluster string, role string, cfg *config.Config)

func SetBuckets

func SetBuckets(bks []float64)

Types

type Alarm

type Alarm struct {
	Counter
}

func Warning

func Warning(detail string) (a *Alarm)

type ConsulRegisterInfo

type ConsulRegisterInfo struct {
	Name    string            `json:"Name"`
	ID      string            `json:"ID"`
	Address string            `json:"Address"`
	Port    int64             `json:"Port"`
	Tags    []string          `json:"Tags"`
	Meta    map[string]string `json:",omitempty"`
}

*

• consul register info for prometheus
• optional for user when set prometheus exporter

type Counter

type Counter struct {
	Gauge
}

func NewCounter

func NewCounter(name string) (c *Counter)

func (*Counter) Add

func (c *Counter) Add(val int64)

func (*Counter) AddWithLabels

func (c *Counter) AddWithLabels(val int64, labels map[string]string)

func (*Counter) Metric

func (c *Counter) Metric() prometheus.Counter

type Gauge

type Gauge struct {
	// contains filtered or unexported fields
}

func NewGauge

func NewGauge(name string) (g *Gauge)

func (*Gauge) Key

func (c *Gauge) Key() (key string)

func (*Gauge) Metric

func (c *Gauge) Metric() prometheus.Gauge

func (*Gauge) Name

func (g *Gauge) Name() string

func (*Gauge) Set

func (g *Gauge) Set(val float64)

func (*Gauge) SetWithLabels

func (g *Gauge) SetWithLabels(val float64, labels map[string]string)

func (*Gauge) String

func (g *Gauge) String() string

type GaugeVec

type GaugeVec struct {
	*prometheus.GaugeVec
}

func NewGaugeVec

func NewGaugeVec(name, help string, labels []string) *GaugeVec

func (*GaugeVec) SetBoolWithLabelValues

func (v *GaugeVec) SetBoolWithLabelValues(val bool, lvs ...string)

func (*GaugeVec) SetWithLabelValues

func (v *GaugeVec) SetWithLabelValues(val float64, lvs ...string)

type Histogram

type Histogram struct {
	// contains filtered or unexported fields
}

func (*Histogram) Key

func (c *Histogram) Key() (key string)

func (*Histogram) Metric

func (c *Histogram) Metric() prometheus.Histogram

func (*Histogram) Name

func (g *Histogram) Name() string

func (*Histogram) String

func (g *Histogram) String() string

type TimePoint

type TimePoint struct {
	Histogram
	// contains filtered or unexported fields
}

func NewTP

func NewTP(name string) (tp *TimePoint)

func (*TimePoint) GetStartTime

func (tp *TimePoint) GetStartTime() time.Time

func (*TimePoint) Set

func (tp *TimePoint) Set()

func (*TimePoint) SetWithLabels

func (tp *TimePoint) SetWithLabels(labels map[string]string)

type TimePointCount

type TimePointCount struct {
	// contains filtered or unexported fields
}

func NewTPCnt

func NewTPCnt(name string) (tpc *TimePointCount)

func (*TimePointCount) GetStartTime

func (tpc *TimePointCount) GetStartTime() time.Time

func (*TimePointCount) Set

func (tpc *TimePointCount) Set(err error)

it should be invoked by defer func{set(err)}

func (*TimePointCount) SetWithLabels

func (tpc *TimePointCount) SetWithLabels(err error, labels map[string]string)

type VersionMetrics

type VersionMetrics struct {
	Metric *Counter
	// contains filtered or unexported fields
}

func NewVersionMetrics

func NewVersionMetrics(module string) *VersionMetrics

func (*VersionMetrics) SetStatPeriod

func (m *VersionMetrics) SetStatPeriod(period time.Duration)

func (*VersionMetrics) Start

func (m *VersionMetrics) Start()

func (*VersionMetrics) Stop

func (m *VersionMetrics) Stop()