writer

Documentation

Index

• Variables
• type DefaultOutputWriter
  • func (*DefaultOutputWriter) Close()
  • func (out *DefaultOutputWriter) SetSource(source string)
  • func (out *DefaultOutputWriter) SetSourceType(sourceType string)
  • func (out *DefaultOutputWriter) SetTag(tag string)
• type Event
  • func NewEvent(event string) *Event
  • func NewJsonEvent(event any) (*Event, error)
• type FileWriter
  • func NewFileWriter(file string) *FileWriter
  • func (w *FileWriter) Close()
  • func (w *FileWriter) WriteEvent(event string)
• type IManager
• type IOutputWriter
• type Manager
  • func NewManager() Manager
  • func (m *Manager) Close()
  • func (m *Manager) ConfigureOutputFolder(file string)
  • func (m *Manager) ConfigureSplunk(splunkAddress, splunkToken, index string)
  • func (m *Manager) GetErrors() []error
  • func (m *Manager) GetErrorsAsStrings() []string
  • func (m *Manager) HasErrors() bool
  • func (m *Manager) SetSource(source string)
  • func (m *Manager) SetSourceType(sourceType string)
  • func (m *Manager) SetTag(tag string)
  • func (m *Manager) WriteJsonEvent(event any) error
  • func (m *Manager) WriteStringEvent(event string)
• type Metadata
• type Response
• type SplunkWriter
  • func NewSplunkWriter(address string, token string) *SplunkWriter
  • func (hec *SplunkWriter) Close()
  • func (hec *SplunkWriter) FlushBuffer()
  • func (hec *SplunkWriter) SetSource(source string)
  • func (hec *SplunkWriter) SetSourceType(sourceType string)
  • func (hec *SplunkWriter) SetTag(tag string)
  • func (hec *SplunkWriter) WriteEvent(event string)

Variables

var Registry = make(map[string]IOutputWriter)

Types

type DefaultOutputWriter

type DefaultOutputWriter struct {
	Metadata Metadata

	Errors []error
}

func (*DefaultOutputWriter) Close

func (*DefaultOutputWriter) Close()

func (*DefaultOutputWriter) SetSource

func (out *DefaultOutputWriter) SetSource(source string)

func (*DefaultOutputWriter) SetSourceType

func (out *DefaultOutputWriter) SetSourceType(sourceType string)

func (*DefaultOutputWriter) SetTag

func (out *DefaultOutputWriter) SetTag(tag string)

type Event

type Event struct {
	Host string `json:"host,omitempty"`
	// Index      string `json:"index,omitempty"`
	Source     string `json:"source,omitempty"`
	SourceType string `json:"sourcetype,omitempty"`
	Time       string `json:"time,omitempty"`
	Event      string `json:"event"`
}

func NewEvent

func NewEvent(event string) *Event

func NewJsonEvent

func NewJsonEvent(event any) (*Event, error)

type FileWriter

type FileWriter struct {
	DefaultOutputWriter

	OutputFile string
	Fd         *os.File
	// contains filtered or unexported fields
}

func NewFileWriter

func NewFileWriter(file string) *FileWriter

func (*FileWriter) Close

func (w *FileWriter) Close()

func (*FileWriter) WriteEvent

func (w *FileWriter) WriteEvent(event string)

type IManager

type IManager interface {
	SetTag(string)
	SetSource(string)
	SetSourceType(string)
	SetHost(string)

	Close()
	GetErrors() []error
	GetErrorsAsStrings() []string
	WriteJsonEvent(any) error
	WriteStringEvent(string)
	HasErrors() bool
}

type IOutputWriter

type IOutputWriter interface {
	// New()
	Close()

	// GetTag() string
	WriteEvent(*Event)
}

type Manager

type Manager struct {
	IManager
	SplunkEnabled bool
	FileEnabled   bool

	SplunkWriter *SplunkWriter
	FileWriter   *FileWriter
}

func NewManager

func NewManager() Manager

func (*Manager) Close

func (m *Manager) Close()

func (*Manager) ConfigureOutputFolder

func (m *Manager) ConfigureOutputFolder(file string)

func (*Manager) ConfigureSplunk

func (m *Manager) ConfigureSplunk(splunkAddress, splunkToken, index string)

func (*Manager) GetErrors

func (m *Manager) GetErrors() []error

func (*Manager) GetErrorsAsStrings

func (m *Manager) GetErrorsAsStrings() []string

func (*Manager) HasErrors

func (m *Manager) HasErrors() bool

func (*Manager) SetSource

func (m *Manager) SetSource(source string)

func (*Manager) SetSourceType

func (m *Manager) SetSourceType(sourceType string)

func (*Manager) SetTag

func (m *Manager) SetTag(tag string)

func (*Manager) WriteJsonEvent

func (m *Manager) WriteJsonEvent(event any) error

func (*Manager) WriteStringEvent

func (m *Manager) WriteStringEvent(event string)

type Metadata

type Metadata struct {
	Tag        string
	Source     string
	SourceType string
}

type Response

type Response struct {
	Text  string          `json:"text"`
	Code  int             `json:"code"`
	AckID *int            `json:"ackId"`
	Acks  map[string]bool `json:"acks"`
}

type SplunkWriter

type SplunkWriter struct {
	DefaultOutputWriter
	DefaultIndex string
	// contains filtered or unexported fields
}

func NewSplunkWriter

func NewSplunkWriter(address string, token string) *SplunkWriter

func (*SplunkWriter) Close

func (hec *SplunkWriter) Close()

func (*SplunkWriter) FlushBuffer

func (hec *SplunkWriter) FlushBuffer()

func (*SplunkWriter) SetSource

func (hec *SplunkWriter) SetSource(source string)

func (*SplunkWriter) SetSourceType

func (hec *SplunkWriter) SetSourceType(sourceType string)

func (*SplunkWriter) SetTag

func (hec *SplunkWriter) SetTag(tag string)

func (*SplunkWriter) WriteEvent

func (hec *SplunkWriter) WriteEvent(event string)