cmd

Documentation

Overview

Copyright © 2022 NAME HERE <EMAIL ADDRESS>

Copyright © 2022 NAME HERE <EMAIL ADDRESS>

Index

• func Execute()
• func WaitSignals(i *inspServer, sgs ...os.Signal)
• type DynamicProbeServer
  • func NewDynamicProbeServer[T probe.Probe](probeManager ProbeManager[T]) *DynamicProbeServer[T]
  • func (s *DynamicProbeServer[T]) Reload(ctx context.Context, config []ProbeConfig) error
  • func (s *DynamicProbeServer[T]) Start(ctx context.Context, config []ProbeConfig) error
  • func (s *DynamicProbeServer[T]) Stop(ctx context.Context) error
• type EventConfig
• type EventProbeManager
  • func (m *EventProbeManager) CreateProbe(config ProbeConfig) (probe.EventProbe, error)
  • func (m *EventProbeManager) StartProbe(ctx context.Context, probe probe.EventProbe) error
  • func (m *EventProbeManager) StopProbe(ctx context.Context, probe probe.EventProbe) error
• type EventServer
  • func NewEventServer(sinks []sink.Sink) (*EventServer, error)
  • func (s *EventServer) Start(ctx context.Context, probeConfig []ProbeConfig) error
  • func (s *EventServer) Stop(ctx context.Context) error
• type EventSinkConfig
• type InspServerConfig
• type MetricsConfig
• type MetricsProbeManager
  • func (m *MetricsProbeManager) CreateProbe(config ProbeConfig) (probe.MetricsProbe, error)
  • func (m *MetricsProbeManager) StartProbe(ctx context.Context, probe probe.MetricsProbe) error
  • func (m *MetricsProbeManager) StopProbe(ctx context.Context, probe probe.MetricsProbe) error
• type MetricsServer
  • func NewMetricsServer() (*MetricsServer, error)
  • func (s *MetricsServer) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type ProbeConfig
• type ProbeManager

Functions

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

func WaitSignals

func WaitSignals(i *inspServer, sgs ...os.Signal)

Types

type DynamicProbeServer

type DynamicProbeServer[T probe.Probe] struct {
	// contains filtered or unexported fields
}

func NewDynamicProbeServer

func NewDynamicProbeServer[T probe.Probe](probeManager ProbeManager[T]) *DynamicProbeServer[T]

func (*DynamicProbeServer[T]) Reload

func (s *DynamicProbeServer[T]) Reload(ctx context.Context, config []ProbeConfig) error

func (*DynamicProbeServer[T]) Start

func (s *DynamicProbeServer[T]) Start(ctx context.Context, config []ProbeConfig) error

func (*DynamicProbeServer[T]) Stop

func (s *DynamicProbeServer[T]) Stop(ctx context.Context) error

type EventConfig

type EventConfig struct {
	EventSinks []EventSinkConfig `yaml:"sinks" mapstructure:"sinks" json:"sinks"`
	Probes     []ProbeConfig     `yaml:"probes" mapstructure:"probes" json:"probes"`
}

type EventProbeManager

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

func (*EventProbeManager) CreateProbe

func (m *EventProbeManager) CreateProbe(config ProbeConfig) (probe.EventProbe, error)

func (*EventProbeManager) StartProbe

func (m *EventProbeManager) StartProbe(ctx context.Context, probe probe.EventProbe) error

func (*EventProbeManager) StopProbe

func (m *EventProbeManager) StopProbe(ctx context.Context, probe probe.EventProbe) error

type EventServer

type EventServer struct {
	*DynamicProbeServer[probe.EventProbe]
}

func NewEventServer

func NewEventServer(sinks []sink.Sink) (*EventServer, error)

func (*EventServer) Start

func (s *EventServer) Start(ctx context.Context, probeConfig []ProbeConfig) error

func (*EventServer) Stop

func (s *EventServer) Stop(ctx context.Context) error

type EventSinkConfig

type EventSinkConfig struct {
	Name string      `yaml:"name" mapstructure:"name" json:"name"`
	Args interface{} `yaml:"args" mapstructure:"args" json:"args"`
}

type InspServerConfig

type InspServerConfig struct {
	DebugMode        bool          `yaml:"debugmode" mapstructure:"debugmode" json:"debugmode"`
	Port             uint16        `yaml:"port" mapstructure:"port" json:"port"`
	EnableController bool          `yaml:"enable_controller" mapstructure:"enable_controller" json:"enable_controller"`
	MetricsConfig    MetricsConfig `yaml:"metrics" mapstructure:"metrics" json:"metrics"`
	EventConfig      EventConfig   `yaml:"event" mapstructure:"event" json:"event"`
}

type MetricsConfig

type MetricsConfig struct {
	Probes []ProbeConfig `yaml:"probes" mapstructure:"probes" json:"probes"`
}

type MetricsProbeManager

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

func (*MetricsProbeManager) CreateProbe

func (m *MetricsProbeManager) CreateProbe(config ProbeConfig) (probe.MetricsProbe, error)

func (*MetricsProbeManager) StartProbe

func (m *MetricsProbeManager) StartProbe(ctx context.Context, probe probe.MetricsProbe) error

func (*MetricsProbeManager) StopProbe

func (m *MetricsProbeManager) StopProbe(ctx context.Context, probe probe.MetricsProbe) error

type MetricsServer

type MetricsServer struct {
	*DynamicProbeServer[probe.MetricsProbe]
	// contains filtered or unexported fields
}

func NewMetricsServer

func NewMetricsServer() (*MetricsServer, error)

func (*MetricsServer) ServeHTTP

func (s *MetricsServer) ServeHTTP(w http.ResponseWriter, r *http.Request)

type ProbeConfig

type ProbeConfig struct {
	Name string                 `yaml:"name" mapstructure:"name" json:"name"`
	Args map[string]interface{} `yaml:"args" mapstructure:"args" json:"args"`
}

type ProbeManager

type ProbeManager[T probe.Probe] interface {
	CreateProbe(config ProbeConfig) (T, error)
	StartProbe(ctx context.Context, probe T) error
	StopProbe(ctx context.Context, probe T) error
}