telemetry

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", multiple split by ","
	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"`
	// Export pprof service for detect performance issue
	PProfService PProfServiceConfig `mapstructure:"pprof"`
}

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

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

type Gauge interface {
	Metric
}

type Metric interface {
}

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 MultipleCounter struct {
	Counters []Counter
}

type MultipleDynamicGauge struct {
	Gauges []DynamicGauge
}

type MultipleGauge struct {
	Gauges []Gauge
}

type MultipleServer struct {
	Servers []Server
}

type MultipleTimeRecorder struct {
	Recorders []TimeRecorder
}

type MultipleTimer struct {
	Timers []Timer
}

type PProfServiceConfig struct {
	Address string `mapstructure:"address"` // The pprof server address.
}

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

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 interface {
	Stop()
}

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