octopus

Documentation

Index

• type Octopus
  • func NewOctopus(grpcPort uint16) *Octopus
  • func (o *Octopus) GetTopology() *model.Topology
  • func (o *Octopus) Healthy() bool
  • func (o *Octopus) Init(connectors []connector.Connector) error
  • func (o *Octopus) Start()
  • func (o *Octopus) UpdateTopology() error
• type PromAdapter
  • func NewPromAdapter(octopus *Octopus) *PromAdapter
  • func (p *PromAdapter) Collect(ch chan<- prometheus.Metric)
  • func (p *PromAdapter) Describe(ch chan<- *prometheus.Desc)

Types

type Octopus

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

func NewOctopus

func NewOctopus(grpcPort uint16) *Octopus

NewOctopus creates a new Octopus

func (*Octopus) GetTopology

func (o *Octopus) GetTopology() *model.Topology

GetTopology returns a pointer to the current topology

func (*Octopus) Healthy

func (o *Octopus) Healthy() bool

func (*Octopus) Init

func (o *Octopus) Init(connectors []connector.Connector) error

Init initializes the Ocotopus with the given list of connectors and triggers and initial load of data into the connectors

func (*Octopus) Start

func (o *Octopus) Start()

Start starst the Octopus and connectors update routines as well as http + gRPC server

func (*Octopus) UpdateTopology

func (o *Octopus) UpdateTopology() error

UpdateTopology triggers and instant update of the topology data from all configured connectors

type PromAdapter

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

func NewPromAdapter

func NewPromAdapter(octopus *Octopus) *PromAdapter

func (*PromAdapter) Collect

func (p *PromAdapter) Collect(ch chan<- prometheus.Metric)

func (*PromAdapter) Describe

func (p *PromAdapter) Describe(ch chan<- *prometheus.Desc)