common

Documentation

Index

• Constants
• func GetAgentBasicAuth(esConfig *elastic.ElasticsearchConfig) (basicAuth *model.BasicAuth, err error)
• func GetBasicAuth(esConfig *elastic.ElasticsearchConfig) (basicAuth *model.BasicAuth, err error)
• func GetClusterDocType(clusterID string) string
• func GetCredential(credentialID string) (*credential.Credential, error)
• func GetElasticClient(clusterID string) (elastic.API, error)
• func InitClientWithConfig(esConfig elastic.ElasticsearchConfig) (client elastic.API, err error)
• func InitElasticInstance(esConfig elastic.ElasticsearchConfig) (elastic.API, error)
• func InitElasticInstanceWithoutMetadata(esConfig elastic.ElasticsearchConfig) (elastic.API, error)
• type BucketItem
  • func NewBucketItem(bucketType string, parameter util.MapStr) *BucketItem
  • func (bucketItem *BucketItem) AddMetricItems(items ...*MetricItem) *BucketItem
  • func (bucketItem *BucketItem) AddNestBucket(item *BucketItem)
• type CheckConfig
• type GraphType
• type MetricAxis
• type MetricItem
  • func (metricItem *MetricItem) AddAxi(title, group, position, formatType, labelFormat, tickFormat string, ticks int, ...) *MetricItem
  • func (metricItem *MetricItem) AddLine(...) *MetricLine
• type MetricLine
• type MetricSummary
  • func (receiver *MetricSummary) GetDataKey() string
• type ModuleConfig
• type ORMConfig
• type StoreConfig
• type TimeRange

Constants

const DateHistogramBucket string = "date_histogram"

const DateRangeBucket string = "date_range"

const PositionBottom = "bottom"

const PositionLeft = "left"

const PositionRight = "right"

const PositionTop = "top"

const TermsBucket string = "terms"

Functions

func GetAgentBasicAuth

func GetAgentBasicAuth(esConfig *elastic.ElasticsearchConfig) (basicAuth *model.BasicAuth, err error)

func GetBasicAuth

func GetBasicAuth(esConfig *elastic.ElasticsearchConfig) (basicAuth *model.BasicAuth, err error)

func GetClusterDocType

func GetClusterDocType(clusterID string) string

func GetCredential

func GetCredential(credentialID string) (*credential.Credential, error)

func GetElasticClient

func GetElasticClient(clusterID string) (elastic.API, error)

func InitClientWithConfig

func InitClientWithConfig(esConfig elastic.ElasticsearchConfig) (client elastic.API, err error)

func InitElasticInstance

func InitElasticInstance(esConfig elastic.ElasticsearchConfig) (elastic.API, error)

func InitElasticInstanceWithoutMetadata

func InitElasticInstanceWithoutMetadata(esConfig elastic.ElasticsearchConfig) (elastic.API, error)

Types

type BucketItem

type BucketItem struct {
	Key        string        `json:"key"`
	Group      string        `json:"group"`
	Type       string        ` json:"type"`       //terms/date_histogram
	Parameters util.MapStr   ` json:"parameters"` //terms/date_histogram
	Order      int           `json:"order"`
	Buckets    []*BucketItem `json:"buckets"`
	Metrics    []*MetricItem `json:"metrics"`
}

func NewBucketItem

func NewBucketItem(bucketType string, parameter util.MapStr) *BucketItem

func (*BucketItem) AddMetricItems

func (bucketItem *BucketItem) AddMetricItems(items ...*MetricItem) *BucketItem

func (*BucketItem) AddNestBucket

func (bucketItem *BucketItem) AddNestBucket(item *BucketItem)

type CheckConfig

type CheckConfig struct {
	Enabled  bool   `config:"enabled"`
	Interval string `config:"interval,omitempty"`
}

type GraphType

type GraphType string

const (
	GraphTypeLine GraphType = "Line" //default
	GraphTypeBar  GraphType = "Bar"
)

type MetricAxis

type MetricAxis struct {
	ID    string `json:"id"`
	Group string `json:"group"`
	Title string `json:"title"`

	FormatType    string `json:"formatType"`
	Position      string `json:"position"`
	TickFormat    string `json:"tickFormat"`
	Ticks         int    `json:"ticks"`
	LabelFormat   string `json:"labelFormat"`
	ShowGridLines bool   `json:"showGridLines"`
}

type MetricItem

type MetricItem struct {
	Key         string        `json:"key"`
	Axis        []*MetricAxis `json:"axis"`
	Lines       []*MetricLine `json:"lines"`
	Group       string        `json:"group"`
	Order       int           `json:"order"`
	OnlyPrimary bool          `json:"only_primary"`
	//current query statement that passed to search engine
	Request string `json:"request"`
}

func (*MetricItem) AddAxi

func (metricItem *MetricItem) AddAxi(title, group, position, formatType, labelFormat, tickFormat string, ticks int, showGridLines bool) *MetricItem

func (*MetricItem) AddLine

func (metricItem *MetricItem) AddLine(title, label, desc, group, field, aggsType, bucketSize, units, formatTye, format, tickFormat string, hasCalculation, isDerivative bool) *MetricLine

type MetricLine

type MetricLine struct {
	TimeRange  TimeRange     `json:"timeRange"`
	Data       interface{}   `json:"data"`
	BucketSize string        `json:"bucket_size"`
	Metric     MetricSummary `json:"metric"`
	Color      string        `json:"color"`
	Type       GraphType     `json:"type"`
}

type MetricSummary

type MetricSummary struct {
	Group       string `json:"group"`
	Title       string `json:"title"`
	Label       string `json:"label"`
	Description string `json:"description"`

	ID        string `json:"-"`
	MetricAgg string `json:"metricAgg"`
	Field     string `json:"field"`

	FormatType string `json:"formatType"`
	Format     string `json:"format"`
	TickFormat string `json:"tickFormat"`
	Units      string `json:"units"`

	HasCalculation bool                                `json:"hasCalculation"`
	IsDerivative   bool                                `json:"isDerivative"`
	Field2         string                              `json:"-"`
	Calc           func(value, value2 float64) float64 `json:"-"`
	OnlyPrimary    bool                                `json:"only_primary"`
}

func (*MetricSummary) GetDataKey

func (receiver *MetricSummary) GetDataKey() string

type ModuleConfig

type ModuleConfig struct {
	Elasticsearch               string      `config:"elasticsearch"`
	RemoteConfigEnabled         bool        `config:"remote_configs"`
	ORMConfig                   ORMConfig   `config:"orm"`
	StoreConfig                 StoreConfig `config:"store"`
	HealthCheckConfig           CheckConfig `config:"health_check"`
	NodeAvailabilityCheckConfig CheckConfig `config:"availability_check"`
	MetadataRefresh             CheckConfig `config:"metadata_refresh"`
	ClusterSettingsCheckConfig  CheckConfig `config:"cluster_settings_check"`
	ClientTimeout               string      `config:"client_timeout"`
	SkipInitMetadataOnStart     bool        `config:"skip_init_metadata_on_start"`
}

type ORMConfig

type ORMConfig struct {
	Enabled bool `config:"enabled"`

	InitTemplate            bool   `config:"init_template"`
	SkipInitDefaultTemplate bool   `config:"skip_init_default_template"`
	OverrideExistsTemplate  bool   `config:"override_exists_template"`
	TemplateName            string `config:"template_name"` //default template name

	InitSchema  bool   `config:"init_schema"`
	IndexPrefix string `config:"index_prefix"`

	IndexTemplates  map[string]string `config:"index_templates"`  //template_name -> template_content
	SearchTemplates map[string]string `config:"search_templates"` //template_name -> template_content
}

type StoreConfig

type StoreConfig struct {
	Enabled   bool   `config:"enabled"`
	IndexName string `config:"index_name"`
}

type TimeRange

type TimeRange struct {
	Min int64 `json:"min"`
	Max int64 `json:"max"`
}