backend

Documentation

Index

• Constants
• type DbusBackend
  • func (db DbusBackend) OpenMetrics(ctx context.Context) (io.ReadCloser, error)
• type FileBackend
  • func (fb FileBackend) OpenMetrics(ctx context.Context) (io.ReadCloser, error)
• type MetricsSource
• type UnixBackend
  • func (ub UnixBackend) OpenMetrics(ctx context.Context) (io.ReadCloser, error)

Constants

const DbusBackendKind = "dbus"

DbusBackendKind is the configuration kind for the dbus backend

const FileBackendKind = "file"

FileBackendKind is the configuration kind for the file backend

const UnixBackendKind = "uds"

UnixBackendKind is the configuration kind for the unix-socket backend

Types

type DbusBackend

type DbusBackend struct {
	Bus         string
	Destination string
	Method      string
	Path        string
}

DbusBackend is the dbus backend

func (DbusBackend) OpenMetrics

func (db DbusBackend) OpenMetrics(ctx context.Context) (io.ReadCloser, error)

OpenMetrics returns the endpoint for this backend

type FileBackend

type FileBackend struct {
	Path string
}

FileBackend is the file backend

func (FileBackend) OpenMetrics

func (fb FileBackend) OpenMetrics(ctx context.Context) (io.ReadCloser, error)

OpenMetrics returns the endpoint for this backend

type MetricsSource

type MetricsSource interface {
	OpenMetrics(context.Context) (io.ReadCloser, error)
}

MetricsSource is the general interface implemented by all backends

type UnixBackend

type UnixBackend struct {
	Path string
}

UnixBackend is the unix-socket backend

func (UnixBackend) OpenMetrics

func (ub UnixBackend) OpenMetrics(ctx context.Context) (io.ReadCloser, error)

OpenMetrics returns the endpoint for this backend