log

Documentation

Overview

Package log connects and observes telemetry from KubeArmor

Index

• Variables
• func GetOSSigChannel() chan os.Signal
• func StartObserver(o Options) error
• func StopObserver()
• func StrToFile(str, destFile string)
• func WatchTelemetryHelper(arr []byte, t string, o Options)
• type EventInfo
• type Feeder
  • func NewClient(server, msgPath, logPath, logFilter string, limit uint32) *Feeder
  • 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

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

Functions

func GetOSSigChannel

func GetOSSigChannel() chan os.Signal

GetOSSigChannel Function

func StartObserver

func StartObserver(o Options) error

StartObserver Function

func StopObserver

func StopObserver()

StopObserver unblocks signal

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, msgPath, logPath, logFilter string, limit uint32) *Feeder

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
	MsgPath       string
	LogPath       string
	LogFilter     string
	JSON          bool
	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