prometheus

Documentation

Index

• Constants
• Variables
• func BuildQueryCondition(query *Common.Query) DAO.QueryCondition
• func ReadRawdata(config *Config, queries []*Common.Query) ([]*Common.ReadRawdata, error)
• func ResponseToReadRawdata(response *Response, query *Common.Query) (*Common.ReadRawdata, error)
• type Config
  • func NewDefaultConfig() Config
  • func (c *Config) Validate() error
• type Data
• type Entity
• type MatrixData
• type MatrixResponse
• type MatrixResult
• type Option
  • func AggregateOverTimeFunction(f dao.AggregateFunction) Option
  • func EndTime(t *time.Time) Option
  • func StartTime(t *time.Time) Option
  • func StepDuration(d *time.Duration) Option
  • func Timeout(t *time.Time) Option
• type Options
  • func BuildDefaultOptions() Options
• type Prometheus
  • func New(config Config) (*Prometheus, error)
  • func (p *Prometheus) Close()
  • func (p *Prometheus) Query(query string, startTime, timeout *time.Time) (Response, error)
  • func (p *Prometheus) QueryRange(query string, startTime, endTime *time.Time, stepTime *time.Duration) (Response, error)
• type Response
  • func (r Response) GetEntities() ([]Entity, error)
  • func (r Response) GetEntitiesMatrix() ([]Entity, error)
  • func (r Response) GetEntitiesVector() ([]Entity, error)
  • func (r Response) GetMatrixResponse() (MatrixResponse, error)
• type ResultType
• type ScalarResult
• type StringResult
• type TLSConfig
• type UnixTimeWithSampleValue
• type UnixTimeWithScalarValue
• type UnixTimeWithStringValue
• type Value
• type VectorData
• type VectorResponse
• type VectorResult

Constants

const (

	// StatusSuccess Status string literal of prometheus api request
	StatusSuccess = "success"
	// StatusError Status string literal of prometheus api request
	StatusError = "error"
)

Variables

var (
	DatahubAggregateFunction_DAOAggregateFunction = map[Common.TimeRange_AggregateFunction]DAO.AggregateFunction{
		Common.TimeRange_NONE: DAO.None,
		Common.TimeRange_MAX:  DAO.Max,
	}
)

Functions

func BuildQueryCondition

func BuildQueryCondition(query *Common.Query) DAO.QueryCondition

func ReadRawdata

func ReadRawdata(config *Config, queries []*Common.Query) ([]*Common.ReadRawdata, error)

func ResponseToReadRawdata

func ResponseToReadRawdata(response *Response, query *Common.Query) (*Common.ReadRawdata, error)

Types

type Config

type Config struct {
	URL             string     `mapstructure:"url"`
	BearerTokenFile string     `mapstructure:"bearer-token-file"`
	TLSConfig       *TLSConfig `mapstructure:"tls-config"`
	// contains filtered or unexported fields
}

Config Configuration of Prometheus datasource

func NewDefaultConfig

func NewDefaultConfig() Config

NewDefaultConfig Provide default configuration

func (*Config) Validate

func (c *Config) Validate() error

Validate Confirm the configuration is validate

type Data

type Data struct {
	ResultType ResultType    `json:"resultType"`
	Result     []interface{} `json:"result"`
}

Data Data represent the general value of prometheus http response field "data", the format of field "result" will depends on field "resultType"

type Entity

type Entity struct {
	Labels map[string]string
	Values []UnixTimeWithSampleValue
}

Entity Structure to store metrics data from Prometheus response

type MatrixData

type MatrixData struct {
	ResultType ResultType
	Result     []struct {
		Metric map[string]string
		Values []UnixTimeWithSampleValue
	}
}

MatrixData MatrixData

type MatrixResponse

type MatrixResponse struct {
	Status string
	Data   MatrixData
}

MatrixResponse MatrixResponse

type MatrixResult

type MatrixResult struct {
	Metric map[string]string `json:"metric"`
	Values []Value           `json:"values"`
}

type Option

type Option func(*Options)

func AggregateOverTimeFunction

func AggregateOverTimeFunction(f dao.AggregateFunction) Option

func EndTime

func EndTime(t *time.Time) Option

func StartTime

func StartTime(t *time.Time) Option

func StepDuration

func StepDuration(d *time.Duration) Option

func Timeout

func Timeout(t *time.Time) Option

type Options

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

func BuildDefaultOptions

func BuildDefaultOptions() Options

type Prometheus

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

Prometheus Prometheus api client

func New

func New(config Config) (*Prometheus, error)

New New Prometheus api client with configuration

func (*Prometheus) Close

func (p *Prometheus) Close()

Close Free resoure used by Prometehus

func (*Prometheus) Query

func (p *Prometheus) Query(query string, startTime, timeout *time.Time) (Response, error)

Query Query data over a range of time from prometheus

func (*Prometheus) QueryRange

func (p *Prometheus) QueryRange(query string, startTime, endTime *time.Time, stepTime *time.Duration) (Response, error)

QueryRange Query data over a range of time from prometheus

type Response

type Response struct {
	Status    string `json:"status"`
	Data      Data   `json:"data"`
	ErrorType string `json:"errorType"`
	Error     string `json:"error"`
}

Response Response structure of prometheus http response

func (Response) GetEntities

func (r Response) GetEntities() ([]Entity, error)

func (Response) GetEntitiesMatrix

func (r Response) GetEntitiesMatrix() ([]Entity, error)

func (Response) GetEntitiesVector

func (r Response) GetEntitiesVector() ([]Entity, error)

func (Response) GetMatrixResponse

func (r Response) GetMatrixResponse() (MatrixResponse, error)

type ResultType

type ResultType string

ResultType Prometheus http resultType

var MatrixResultType ResultType = "matrix"

MatrixResultType Prometheus http matrix resultType

var ScalarResultType ResultType = "scalar"

ScalarResultType Prometheus http scalar resultType

var StringResultType ResultType = "string"

StringResultType Prometheus http string resultType

var VectorResultType ResultType = "vector"

VectorResultType Prometheus http vector resultType

type ScalarResult

type ScalarResult UnixTimeWithScalarValue

type StringResult

type StringResult UnixTimeWithStringValue

type TLSConfig

type TLSConfig struct {
	InsecureSkipVerify bool `mapstructure:"insecure-skip-verify"`
}

TLSConfig Configuration of tls connection

type UnixTimeWithSampleValue

type UnixTimeWithSampleValue struct {
	UnixTime    time.Time
	SampleValue string
}

type UnixTimeWithScalarValue

type UnixTimeWithScalarValue struct {
	UnixTime    time.Time
	ScalarValue string
}

type UnixTimeWithStringValue

type UnixTimeWithStringValue struct {
	UnixTime    time.Time
	StringValue string
}

type Value

type Value []interface{}

type VectorData

type VectorData struct {
	ResultType ResultType
	Result     []struct {
		Metric map[string]string
		Value  UnixTimeWithSampleValue
	}
}

VectorData VectorData

type VectorResponse

type VectorResponse struct {
	Status string
	Data   VectorData
}

VectorResponse VectorResponse

type VectorResult

type VectorResult struct {
	Metric map[string]string `json:"metric"`
	Value  Value             `json:"value"`
}