exporters

Documentation

Index

• type BaseExporter
  • func (exporter *BaseExporter) Start() error
• type BaseRequestExporter
  • func (exporter *BaseRequestExporter) HandleRequest(resp http.ResponseWriter, req *http.Request, conf *config.Configuration, ...)
• type CS3APIExporter
  • func (exporter *CS3APIExporter) Activate(conf *config.Configuration, log *zerolog.Logger) error
  • func (exporter *CS3APIExporter) GetID() string
  • func (exporter *CS3APIExporter) GetName() string
• type Collection
  • func AvailableExporters(conf *config.Configuration) (*Collection, error)
  • func (collection *Collection) ActivateAll(conf *config.Configuration, log *zerolog.Logger) error
  • func (collection *Collection) Entities() []entity.Entity
  • func (collection *Collection) Exchangers() []exchangers.Exchanger
  • func (collection *Collection) GetRequestExporters() []exchangers.RequestExchanger
  • func (collection *Collection) StartAll() error
  • func (collection *Collection) StopAll()
• type Exporter
• type MetricsExporter
  • func (exporter *MetricsExporter) Activate(conf *config.Configuration, log *zerolog.Logger) error
  • func (exporter *MetricsExporter) GetID() string
  • func (exporter *MetricsExporter) GetName() string
  • func (exporter *MetricsExporter) Update(meshDataSet meshdata.Map) error
• type PrometheusSDExporter
  • func (exporter *PrometheusSDExporter) Activate(conf *config.Configuration, log *zerolog.Logger) error
  • func (exporter *PrometheusSDExporter) GetID() string
  • func (exporter *PrometheusSDExporter) GetName() string
  • func (exporter *PrometheusSDExporter) Update(meshDataSet meshdata.Map) error
• type SiteLocationsExporter
  • func (exporter *SiteLocationsExporter) Activate(conf *config.Configuration, log *zerolog.Logger) error
  • func (exporter *SiteLocationsExporter) GetID() string
  • func (exporter *SiteLocationsExporter) GetName() string
• type WebAPIExporter
  • func (exporter *WebAPIExporter) Activate(conf *config.Configuration, log *zerolog.Logger) error
  • func (exporter *WebAPIExporter) GetID() string
  • func (exporter *WebAPIExporter) GetName() string

Types

type BaseExporter

type BaseExporter struct {
	exchangers.BaseExchanger
}

BaseExporter implements basic exporter functionality common to all exporters.

func (*BaseExporter) Start

func (exporter *BaseExporter) Start() error

Start starts the exporter.

type BaseRequestExporter

type BaseRequestExporter struct {
	BaseExporter
	exchangers.BaseRequestExchanger
}

BaseRequestExporter implements basic exporter functionality common to all request exporters.

func (*BaseRequestExporter) HandleRequest

func (exporter *BaseRequestExporter) HandleRequest(resp http.ResponseWriter, req *http.Request, conf *config.Configuration, log *zerolog.Logger)

HandleRequest handles the actual HTTP request.

type CS3APIExporter

type CS3APIExporter struct {
	BaseRequestExporter
}

CS3APIExporter implements the CS3API exporter.

func (*CS3APIExporter) Activate

func (exporter *CS3APIExporter) Activate(conf *config.Configuration, log *zerolog.Logger) error

Activate activates the exporter.

func (*CS3APIExporter) GetID

func (exporter *CS3APIExporter) GetID() string

GetID returns the ID of the exporter.

func (*CS3APIExporter) GetName

func (exporter *CS3APIExporter) GetName() string

GetName returns the display name of the exporter.

type Collection

type Collection struct {
	Exporters []Exporter
}

Collection represents a collection of exporters.

func AvailableExporters

func AvailableExporters(conf *config.Configuration) (*Collection, error)

AvailableExporters returns a list of all exporters that are enabled in the configuration.

func (*Collection) ActivateAll

func (collection *Collection) ActivateAll(conf *config.Configuration, log *zerolog.Logger) error

ActivateAll activates all exporters.

func (*Collection) Entities

func (collection *Collection) Entities() []entity.Entity

Entities returns a vector of entities within the collection.

func (*Collection) Exchangers

func (collection *Collection) Exchangers() []exchangers.Exchanger

Exchangers returns a vector of exchangers within the collection.

func (*Collection) GetRequestExporters

func (collection *Collection) GetRequestExporters() []exchangers.RequestExchanger

GetRequestExporters returns all exporters that implement the RequestExchanger interface.

func (*Collection) StartAll

func (collection *Collection) StartAll() error

StartAll starts all exporters.

func (*Collection) StopAll

func (collection *Collection) StopAll()

StopAll stops all exporters.

type Exporter

type Exporter interface {
	exchangers.Exchanger
}

Exporter is the interface that all exporters must implement.

type MetricsExporter

type MetricsExporter struct {
	BaseExporter
	// contains filtered or unexported fields
}

MetricsExporter exposes various Prometheus metrics.

func (*MetricsExporter) Activate

func (exporter *MetricsExporter) Activate(conf *config.Configuration, log *zerolog.Logger) error

Activate activates the exporter.

func (*MetricsExporter) GetID

func (exporter *MetricsExporter) GetID() string

GetID returns the ID of the exporter.

func (*MetricsExporter) GetName

func (exporter *MetricsExporter) GetName() string

GetName returns the display name of the exporter.

func (*MetricsExporter) Update

func (exporter *MetricsExporter) Update(meshDataSet meshdata.Map) error

Update is called whenever the mesh data set has changed to reflect these changes.

type PrometheusSDExporter

type PrometheusSDExporter struct {
	BaseExporter
	// contains filtered or unexported fields
}

PrometheusSDExporter implements various Prometheus Service Discovery scrape config exporters.

func (*PrometheusSDExporter) Activate

func (exporter *PrometheusSDExporter) Activate(conf *config.Configuration, log *zerolog.Logger) error

Activate activates the exporter.

func (*PrometheusSDExporter) GetID

func (exporter *PrometheusSDExporter) GetID() string

GetID returns the ID of the exporter.

func (*PrometheusSDExporter) GetName

func (exporter *PrometheusSDExporter) GetName() string

GetName returns the display name of the exporter.

func (*PrometheusSDExporter) Update

func (exporter *PrometheusSDExporter) Update(meshDataSet meshdata.Map) error

Update is called whenever the mesh data set has changed to reflect these changes.

type SiteLocationsExporter

type SiteLocationsExporter struct {
	BaseRequestExporter
}

SiteLocationsExporter implements the Site Locations exporter to use with Grafana.

func (*SiteLocationsExporter) Activate

func (exporter *SiteLocationsExporter) Activate(conf *config.Configuration, log *zerolog.Logger) error

Activate activates the exporter.

func (*SiteLocationsExporter) GetID

func (exporter *SiteLocationsExporter) GetID() string

GetID returns the ID of the exporter.

func (*SiteLocationsExporter) GetName

func (exporter *SiteLocationsExporter) GetName() string

GetName returns the display name of the exporter.

type WebAPIExporter

type WebAPIExporter struct {
	BaseRequestExporter
}

WebAPIExporter implements the generic Web API exporter.

func (*WebAPIExporter) Activate

func (exporter *WebAPIExporter) Activate(conf *config.Configuration, log *zerolog.Logger) error

Activate activates the exporter.

func (*WebAPIExporter) GetID

func (exporter *WebAPIExporter) GetID() string

GetID returns the ID of the exporter.

func (*WebAPIExporter) GetName

func (exporter *WebAPIExporter) GetName() string

GetName returns the display name of the exporter.