metric

Documentation

Index

• Constants
• Variables
• func Add(name string, creator Creator)
• func GetMetricOptions() map[string]interface{}
• func GetMetricTags() map[string][]string
• func GetMetricTypeKey() map[string]interface{}
• func GetMetricUsages() []Option
• type Collector
• type Creator
• type ExtCollector

Constants

const (
	ConfigTypeBool   = "bool"
	ConfigTypeArray  = "array"
	ConsifTypeString = "string"

	OptionString     = "options"
	AttributesString = "attributes"
	Timestamp        = "timestamp"
)

Variables

var Collectors = map[string]Creator{}

Functions

func Add

func Add(name string, creator Creator)

func GetMetricOptions

func GetMetricOptions() map[string]interface{}

func GetMetricTags

func GetMetricTags() map[string][]string

func GetMetricTypeKey

func GetMetricTypeKey() map[string]interface{}

func GetMetricUsages

func GetMetricUsages() []Option

Types

type Collector

type Collector interface {
	// Name returns the name.
	Name() string
	// Tags returns available tags.
	Tags() []string
	// Usages returns usage information.
	Usages() string
	// Config returns config fields and options.
	Config() map[string]interface{}
	// Collect gathers metric infomration.
	Collect() ([]map[string]interface{}, error)
}

Collector 收集metric�s的接口

type Creator

type Creator func() Collector

type ExtCollector

type ExtCollector interface {
	Collector
	// SyncConfig updates config options specifically for external metrics.
	SyncConfig(map[string]interface{}) error
}

供外部插件实现 SyncConfig 与 Config 对应 获取配置项后同步配置给插件