status

Documentation

Index

• func AddGlobalError(key string, errorMessage string)
• func AddGlobalWarning(key string, warning string)
• func Clear()
• func Init(isRunning *int32, endpoints *types.Endpoints, sources *config.LogSources, ...)
• func InitStatus(sources *config.LogSources)
• func RemoveGlobalWarning(key string)
• type Builder
  • func NewBuilder(isRunning *int32, endpoints *types.Endpoints, sources *config.LogSources, ...) *Builder
  • func (b *Builder) BuildStatus() Status
• type Integration
• type Source
• type Status
  • func Get() Status
• type Transport

Functions

func AddGlobalError

func AddGlobalError(key string, errorMessage string)

AddGlobalError an error message for the status display (errors will stop the agent)

func AddGlobalWarning

func AddGlobalWarning(key string, warning string)

AddGlobalWarning keeps track of a warning message to display on the status.

func Clear

func Clear()

Clear clears the status which means it needs to be initialized again to be used.

func Init

func Init(isRunning *int32, endpoints *types.Endpoints, sources *config.LogSources, logExpVars *expvar.Map)

Init instantiates the builder that builds the status on the fly.

func InitStatus

func InitStatus(sources *config.LogSources)

InitStatus initialize a status builder

func RemoveGlobalWarning

func RemoveGlobalWarning(key string)

RemoveGlobalWarning loses track of a warning message that does not need to be displayed on the status anymore.

Types

type Builder

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

Builder is used to build the status.

func NewBuilder

func NewBuilder(isRunning *int32, endpoints *types.Endpoints, sources *config.LogSources, warnings *config.Messages, errors *config.Messages, logExpVars *expvar.Map) *Builder

NewBuilder returns a new builder.

func (*Builder) BuildStatus

func (b *Builder) BuildStatus() Status

BuildStatus returns the status of the logs-agent.

type Integration

type Integration struct {
	Name    string   `json:"name"`
	Sources []Source `json:"sources"`
}

Integration provides some information about a logs integration.

type Source

type Source struct {
	BytesRead          int64                  `json:"bytesRead"`
	AllTimeAvgLatency  int64                  `json:"allTimeAvgLatency"`
	AllTimePeakLatency int64                  `json:"allTimePeakLatency"`
	RecentAvgLatency   int64                  `json:"recentAvgLatency"`
	RecentPeakLatency  int64                  `json:"recentPeakLatency"`
	Type               string                 `json:"type"`
	Configuration      map[string]interface{} `json:"configuration"`
	Status             string                 `json:"status"`
	Inputs             []string               `json:"inputs"`
	Messages           []string               `json:"messages"`
	Info               map[string][]string    `json:"info"`
}

Source provides some information about a logs source.

type Status

type Status struct {
	IsRunning     bool             `json:"isRunning"`
	Endpoints     []string         `json:"endpoints"`
	StatusMetrics map[string]int64 `json:"metrics"`
	Integrations  []Integration    `json:"integrations"`
	Errors        []string         `json:"errors"`
	Warnings      []string         `json:"warnings"`
	UseHTTP       bool             `json:"useHttp"`
}

Status provides some information about logs-agent.

func Get

func Get() Status

Get returns the status of the logs-agent computed on the fly.

type Transport

type Transport string

Transport is the transport used by logs-agent, i.e TCP or HTTP

const (
	// TransportHTTP indicates logs-agent is using HTTP transport
	TransportHTTP Transport = "HTTP"
	// TransportTCP indicates logs-agent is using TCP transport
	TransportTCP Transport = "TCP"
)

var (

	// CurrentTransport is the current transport used by logs-agent, i.e TCP or HTTP
	CurrentTransport Transport
)