business

Documentation

Overview

+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

This package implements the Dump logger.

+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

This package implements the shell's wrapper.

+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

Index

• type LogEvent
• type Sentinel
  • func New(opts ...SentinelOption) *Sentinel
  • func (w *Sentinel) Start()
  • func (w *Sentinel) Write(p []byte) (n int, err error)
• type SentinelOption
  • func WithDumpLogger(enabled bool, filename string) SentinelOption
  • func WithJsonLogger(enabled bool, filename string) SentinelOption

Types

type LogEvent

type LogEvent struct {
	Timestamp string `json:"@timestamp"`
	Command   string `json:"command"`
	Output    string `json:"output,omitempty"`
}

LogEvent: this struct represent a single entry into the JSON log file.

type Sentinel

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

func New

func New(opts ...SentinelOption) *Sentinel

func (*Sentinel) Start

func (w *Sentinel) Start()

Start: it starts a shell, getting the stdin from that,

then it write every byte from the stdin to a multiwriter,
the latter includes the os.Stdout (to make the shell functioning for the user)
and the Sentinel itself, for auditing purpose.

func (*Sentinel) Write

func (w *Sentinel) Write(p []byte) (n int, err error)

Write: this func splits the given array of bytes into line of text,

then it writes every line of text to every defined logger.

type SentinelOption

type SentinelOption func(*Sentinel)

func WithDumpLogger

func WithDumpLogger(enabled bool, filename string) SentinelOption

func WithJsonLogger

func WithJsonLogger(enabled bool, filename string) SentinelOption