prometheus

Documentation

Index

• Constants
• type Collect
• type FuncCollectMetrics
• type FuncGetPrometheus
• type GinRoute
• type MetricsCollection
• type Prometheus
  • func New(ctx libctx.FuncContext) Prometheus

Constants

const (
	DefaultSlowTime = int32(5)
)

Types

type Collect

type Collect interface {
	libmet.Collect
	CollectMetrics(ctx context.Context, name ...string)
}

type FuncCollectMetrics

type FuncCollectMetrics func(ctx context.Context, name ...string)

type FuncGetPrometheus

type FuncGetPrometheus func() Prometheus

type GinRoute

type GinRoute interface {
	Expose(ctx context.Context)
	ExposeGin(c *ginsdk.Context)

	MiddleWare(ctx context.Context)
	MiddleWareGin(c *ginsdk.Context)

	ExcludePath(startWith ...string)
}

type MetricsCollection

type MetricsCollection interface {
	// GetMetric is used to retrieve the metric instance from prometheus instance.
	GetMetric(name string) libmet.Metric

	// AddMetric is used to register the metric instance into prometheus instance.
	AddMetric(isAPI bool, metric libmet.Metric) error

	// DelMetric is used to unregister the metric instance into prometheus instance.
	DelMetric(name string)

	// ListMetric retrieve a slice of ginMet' name registered for all type API or not.
	ListMetric() []string
}

type Prometheus

type Prometheus interface {
	GinRoute
	MetricsCollection
	Collect

	SetSlowTime(slowTime int32)
	GetSlowTime() int32

	SetDuration(duration []float64)
	GetDuration() []float64
}

func New

func New(ctx libctx.FuncContext) Prometheus

New will return a new object that implement interface GinPrometheus.