log

Documentation

Overview

Package log connects and observes telemetry from KubeArmor

Package log connects and observes telemetry from KubeArmor

Index

• Constants
• Variables
• func GetOSSigChannel() chan os.Signal
• func StartObserver(c *k8s.Client, o Options) error
• func StrToFile(str, destFile string)
• func WatchTelemetryHelper(arr []byte, t string, o Options)
• type EventInfo
• type Feeder
  • func NewClient(server string, o Options, c kubernetes.Interface) (*Feeder, error)
  • func (fd *Feeder) DestroyClient() error
  • func (fd *Feeder) DoHealthCheck() bool
  • func (fd *Feeder) WatchAlerts(o Options) error
  • func (fd *Feeder) WatchLogs(o Options) error
  • func (fd *Feeder) WatchMessages(msgPath string, jsonFormat bool) error
• type Options

Constants

const (
	SelfCertProvider   string = "self"
	ExternalCertLoader string = "external"
)

Variables

var (
	CNamespace     regexType
	CLogtype       regexType
	COperation     regexType
	CContainerName regexType
	CPodName       regexType
	CSource        regexType
	CResource      regexType
)

Regex Compiled Structs

var Limitchan chan bool

Limitchan handles telemetry event output limit

var StopChan chan struct{}

StopChan Channel

var UnblockSignal error

UnblockSignal is a flag to check whether the Watch* APIs have exited or signal has rcvd

Functions

func GetOSSigChannel

func GetOSSigChannel() chan os.Signal

GetOSSigChannel Function

func StartObserver

func StartObserver(c *k8s.Client, o Options) error

StartObserver Function

func StrToFile

func StrToFile(str, destFile string)

StrToFile Function

func WatchTelemetryHelper

func WatchTelemetryHelper(arr []byte, t string, o Options)

WatchTelemetryHelper handles Alerts and Logs

Types

type EventInfo

type EventInfo struct {
	Data []byte // json marshalled byte data for alert/log
	Type string // "Alert"/"Log"
}

EventInfo Event data signalled on EventChan

type Feeder

type Feeder struct {
	// flag
	Running bool

	// wait group
	WgClient sync.WaitGroup
	// contains filtered or unexported fields
}

Feeder Structure

func NewClient

func NewClient(server string, o Options, c kubernetes.Interface) (*Feeder, error)

NewClient Function

func (*Feeder) DestroyClient

func (fd *Feeder) DestroyClient() error

DestroyClient Function

func (*Feeder) DoHealthCheck

func (fd *Feeder) DoHealthCheck() bool

DoHealthCheck Function

func (*Feeder) WatchAlerts

func (fd *Feeder) WatchAlerts(o Options) error

WatchAlerts Function

func (*Feeder) WatchLogs

func (fd *Feeder) WatchLogs(o Options) error

WatchLogs Function

func (*Feeder) WatchMessages

func (fd *Feeder) WatchMessages(msgPath string, jsonFormat bool) error

WatchMessages Function

type Options

type Options struct {
	GRPC             string
	Secure           bool
	TlsCertPath      string
	TlsCertProvider  string
	ReadCAFromSecret bool
	MsgPath          string
	LogPath          string
	LogFilter        string
	JSON             bool
	Output           string
	Namespace        string
	LogType          string
	Operation        string
	ContainerName    string
	PodName          string
	Source           string
	Resource         string
	Limit            uint32
	Selector         []string
	EventChan        chan EventInfo // channel to send events on
}

Options Structure