elasticsearch

Documentation

Overview

Package elasticsearch ports Elasticsearch metrics into snap metrics

Index

• Constants
• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func Meta() *plugin.PluginMeta
• func MustAsset(name string) []byte
• func NewStack(n uint) *stack
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type ESMetric
  • func NewESClusterMetric(url string, timeout time.Duration) ESMetric
  • func NewESNodeMetric(url string, timeout time.Duration) ESMetric
  • func (esm *ESMetric) GetClusterData() (map[string]plugin.MetricType, error)
  • func (esm *ESMetric) GetNodeData() (map[string]map[string]plugin.MetricType, error)
• type Elasticsearch
  • func NewElasticsearchCollector() *Elasticsearch
  • func (p *Elasticsearch) CollectMetrics(mts []plugin.MetricType) ([]plugin.MetricType, error)
  • func (p *Elasticsearch) GetConfigPolicy() (*cpolicy.ConfigPolicy, error)
  • func (p *Elasticsearch) GetMetricTypes(pct plugin.ConfigType) ([]plugin.MetricType, error)
• type HTTPClient
  • func NewClient(url, endpoint string, timeout time.Duration) *HTTPClient
  • func (hc *HTTPClient) GetUrl() string

Constants

const (
	HOST = "host"
	FROM = "from"
)

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func Meta

func Meta() *plugin.PluginMeta

Meta returns the snap plug.PluginMeta type

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func NewStack

func NewStack(n uint) *stack

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

Types

type ESMetric

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

ESMetric defines the metric needed data

func NewESClusterMetric

func NewESClusterMetric(url string, timeout time.Duration) ESMetric

NewESClusterMetric returns a new instance of ESMetric

func NewESNodeMetric

func NewESNodeMetric(url string, timeout time.Duration) ESMetric

NewESNodeMetric returns a new instance of ESMetric

func (*ESMetric) GetClusterData

func (esm *ESMetric) GetClusterData() (map[string]plugin.MetricType, error)

GetClusterData collects the ES cluster metrics. Otherwise, an error is returned.

func (*ESMetric) GetNodeData

func (esm *ESMetric) GetNodeData() (map[string]map[string]plugin.MetricType, error)

GetNodeData returns an array of elasticsearch node metrics. All metrics of all nodes within the same cluster will be returned.

type Elasticsearch

type Elasticsearch struct {
}

Elasticsearch struct type

func NewElasticsearchCollector

func NewElasticsearchCollector() *Elasticsearch

NewElasticsearchCollector returns a new instance of Elasticsearch struct

func (*Elasticsearch) CollectMetrics

func (p *Elasticsearch) CollectMetrics(mts []plugin.MetricType) ([]plugin.MetricType, error)

CollectMetrics returns metrics from Elasticsearch

func (*Elasticsearch) GetConfigPolicy

func (p *Elasticsearch) GetConfigPolicy() (*cpolicy.ConfigPolicy, error)

GetConfigPolicy returns a ConfigPolicy

func (*Elasticsearch) GetMetricTypes

func (p *Elasticsearch) GetMetricTypes(pct plugin.ConfigType) ([]plugin.MetricType, error)

GetMetricTypes returns the metric types exposed by Elasticsearch

type HTTPClient

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

HTTPClient defines the client for HTTP communication

func NewClient

func NewClient(url, endpoint string, timeout time.Duration) *HTTPClient

NewClient returns a new instance of HTTPClient

func (*HTTPClient) GetUrl

func (hc *HTTPClient) GetUrl() string

GetUrl returns the URL of a HTTPClient