telemetry

Documentation

Index

• func AfterShardingStart() error
• func Close() error
• func Init(c *Config) error
• func Register(name string, server Server, isDefault bool)
• type Config
• type Counter
  • func NewCounter(name, help string, labels ...string) Counter
• type DynamicGauge
  • func NewDynamicGauge(name, help string, labels ...string) DynamicGauge
• type Gauge
  • func NewGauge(name, help string, getter func() float64, labels ...string) Gauge
• type Metric
• type MetricsServiceConfig
• type PrometheusConfig
• type Server
• type TimeRecorder
• type Timer
  • func NewTimer(name, help string, labels ...string) Timer

Functions

func AfterShardingStart

func AfterShardingStart() error

func Close

func Close() error

func Init

func Init(c *Config) error

Init create the global telemetry center according to the config.

func Register

func Register(name string, server Server, isDefault bool)

Types

type Config

type Config struct {
	Cluster  string `mapstructure:"cluster"`  // The cluster name.
	Service  string `mapstructure:"service"`  // The service name.
	Instance string `mapstructure:"instance"` // The instance name.

	// Telemetry export type, support "prometheus", "metrics_service" or "none"
	ExportType string `mapstructure:"export_type"`
	// Export telemetry data through Prometheus server, only works on "export_type=prometheus".
	Prometheus PrometheusConfig `mapstructure:"prometheus"`
	// Export telemetry data through native meter format to OAP backend, only works on "export_type=metrics_service".
	MetricsService MetricsServiceConfig `mapstructure:"metrics_service"`
}

Config defines the common telemetry labels.

type Counter

type Counter interface {
	Metric
	Inc(labelValues ...string)
	Add(val float64, labelValues ...string)
}

func NewCounter

func NewCounter(name, help string, labels ...string) Counter

type DynamicGauge

type DynamicGauge interface {
	Metric
	Inc(labelValues ...string)
	Dec(labelValues ...string)
}

func NewDynamicGauge

func NewDynamicGauge(name, help string, labels ...string) DynamicGauge

type Gauge

type Gauge interface {
	Metric
}

func NewGauge

func NewGauge(name, help string, getter func() float64, labels ...string) Gauge

type Metric

type Metric interface {
}

type MetricsServiceConfig

type MetricsServiceConfig struct {
	ClientName   string `mapstructure:"client_name"`   // The grpc-client plugin name, using the SkyWalking native batch meter protocol
	Interval     int    `mapstructure:"interval"`      // The interval second for sending metrics
	MetricPrefix string `mapstructure:"metric_prefix"` // The prefix of telemetry metric name
}

type PrometheusConfig

type PrometheusConfig struct {
	Address  string `mapstructure:"address"`  // The prometheus server address.
	Endpoint string `mapstructure:"endpoint"` // The prometheus server metrics endpoint.
}

type Server

type Server interface {
	Start(config *Config) error
	AfterSharingStart() error
	Close() error

	NewCounter(name, help string, labels ...string) Counter
	NewGauge(name, help string, getter func() float64, labels ...string) Gauge
	NewDynamicGauge(name, help string, labels ...string) DynamicGauge
	NewTimer(name, help string, labels ...string) Timer
}

type TimeRecorder

type TimeRecorder interface {
	Stop()
}

type Timer

type Timer interface {
	Metric
	Start(labelValues ...string) TimeRecorder
	AddTime(t time.Duration, labelValues ...string)
}

func NewTimer

func NewTimer(name, help string, labels ...string) Timer