exporter

package

v0.0.0-...-c59b76b Latest Latest Go to latest Published: Jan 19, 2021 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func FormatTag(text string) string

FormatTag replaces special characters with underscores for prometheus metric naming convention: https://prometheus.io/docs/instrumenting/writing_exporters/#naming

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

Exporter is a struct that contains an instance of AWS clients and job configuration

func New(log *logrus.Logger, j *config.Job, m *metrics.Set) *Exporter

New returns a new instance of Exporter for a job config

func (ex *Exporter) AddClient(client MetricsCollector)

AddClient adds a MetricsCollector client to the Exporter.

func (ex *Exporter) Clients() []MetricsCollector

Clients returns the Exporter's clients.

func (ex *Exporter) Job() *config.Job

Job returns the Exporter's job.

func (ex *Exporter) Logger() *logrus.Logger

Logger returns the exporter's logging instance.

func (ex *Exporter) Session() *session.Session

Session returns the Exporter's AWS Session.

type MetricsCollector interface {
	Collect() error
}

MetricsCollector is an interface for a set of methods to interact with AWS