remote

Documentation

Index

• type Tagger
  • func NewTagger() *Tagger
  • func (t *Tagger) AccumulateTagsFor(entityID string, cardinality collectors.TagCardinality, ...) error
  • func (t *Tagger) GetEntity(entityID string) (*types.Entity, error)
  • func (t *Tagger) Init() error
  • func (t *Tagger) List(cardinality collectors.TagCardinality) response.TaggerListResponse
  • func (t *Tagger) Standard(entityID string) ([]string, error)
  • func (t *Tagger) Stop() error
  • func (t *Tagger) Subscribe(cardinality collectors.TagCardinality) chan []types.EntityEvent
  • func (t *Tagger) Tag(entityID string, cardinality collectors.TagCardinality) ([]string, error)
  • func (t *Tagger) Unsubscribe(ch chan []types.EntityEvent)

Types

type Tagger

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

Tagger holds a connection to a remote tagger, processes incoming events from it, and manages the storage of entities to allow querying.

func NewTagger

func NewTagger() *Tagger

NewTagger returns an allocated tagger. You still have to run Init() once the config package is ready.

func (*Tagger) AccumulateTagsFor

func (t *Tagger) AccumulateTagsFor(entityID string, cardinality collectors.TagCardinality, tb tagset.TagAccumulator) error

AccumulateTagsFor returns tags for a given entity at the desired cardinality.

func (*Tagger) GetEntity

func (t *Tagger) GetEntity(entityID string) (*types.Entity, error)

GetEntity returns the entity corresponding to the specified id and an error

func (*Tagger) Init

func (t *Tagger) Init() error

Init initializes the connection to the remote tagger and starts watching for events.

func (*Tagger) List

func (t *Tagger) List(cardinality collectors.TagCardinality) response.TaggerListResponse

List returns all the entities currently stored by the tagger.

func (*Tagger) Standard

func (t *Tagger) Standard(entityID string) ([]string, error)

Standard returns the standard tags for a given entity.

func (*Tagger) Stop

func (t *Tagger) Stop() error

Stop closes the connection to the remote tagger and stops event collection.

func (*Tagger) Subscribe

func (t *Tagger) Subscribe(cardinality collectors.TagCardinality) chan []types.EntityEvent

Subscribe returns a channel that receives a slice of events whenever an entity is added, modified or deleted. It can send an initial burst of events only to the new subscriber, without notifying all of the others.

func (*Tagger) Tag

func (t *Tagger) Tag(entityID string, cardinality collectors.TagCardinality) ([]string, error)

Tag returns tags for a given entity at the desired cardinality.

func (*Tagger) Unsubscribe

func (t *Tagger) Unsubscribe(ch chan []types.EntityEvent)

Unsubscribe ends a subscription to entity events and closes its channel.