pusher

Documentation

Index

• Constants
• func NewLogger() *logger
• func SaveAnyJSONLToElk(file string, indexName string, project string)
• func SaveAnyToElk(file string, indexName string, project string)
• func SaveInteractionToElk(file string, indexName string, project string, host string)
• type Config
• type Hook
  • func (hook *Hook) Fire(entry *logrus.Entry) error
  • func (hook *Hook) Levels() []logrus.Level
• type Interaction
• type LogEntry
• type Options
  • func ParseOptions() *Options
• type Pusher
  • func FromConfig(config elasticsearch.Config, index string, host string) (*Pusher, error)
  • func FromOptions(options *Options) (*Pusher, error)
  • func (p *Pusher) PushFile() error
  • func (p *Pusher) PushLog(json string, level string) error
• type Store
  • func NewStore(c StoreConfig) (*Store, error)
  • func (s *Store) CreateBulkFromData(payload []byte) error
  • func (s *Store) CreateFromData(payload []byte) error
  • func (s *Store) CreateFromObject(item any) error
  • func (s *Store) CreateIndex(mapping string) error
• type StoreConfig

Constants

const VERSION = "0.3.3"

Functions

func NewLogger

func NewLogger() *logger

func SaveAnyJSONLToElk

func SaveAnyJSONLToElk(file string, indexName string, project string)

func SaveAnyToElk

func SaveAnyToElk(file string, indexName string, project string)

func SaveInteractionToElk

func SaveInteractionToElk(file string, indexName string, project string, host string)

Types

type Config

type Config struct {
	ELKHost  string `yaml:"elk_host"`
	Username string `yaml:"username,omitempty"`
	Password string `yaml:"password,omitempty"`
	APIKey   string `yaml:"apikey,omitempty"`
}

type Hook

type Hook struct {
	Pusher    *Pusher
	Formatter logrus.Formatter
	LogLevel  logrus.Level
}

Hook is a hook that writes logs of specified LogLevels to specified Writer

func (*Hook) Fire

func (hook *Hook) Fire(entry *logrus.Entry) error

Fire will be called when some logging function is called with current hook It will format log entry to string and write it to appropriate writer

func (*Hook) Levels

func (hook *Hook) Levels() []logrus.Level

Levels define on which log levels this hook would trigger

type Interaction

type Interaction struct {
	Timestamp             time.Time `json:"timestamp"`
	ProjectName           string    `json:"project"`
	HostName              string    `json:"host"`
	URL                   string    `json:"url"`
	Raw                   string    `json:"raw,omitempty"`
	ResponseHTTPVersion   string    `json:"responseHTTPVersion,omitempty"`
	ResponseStatusCode    string    `json:"responseStatusCode,omitempty"`
	ResponseStatusMessage string    `json:"responseStatusMessage,omitempty"`
	RequestHeader         string    `json:"requestHeader"`
	RequestBody           string    `json:"requestBody,omitempty"`
	ResponseHeader        string    `json:"responseHeader"`
	ResponseBody          string    `json:"responseBody"`
}

type LogEntry

type LogEntry struct {
	Timestamp   time.Time `json:"timestamp"`
	ProjectName string    `json:"project"`
	HostName    string    `json:"host"`
	Entry       string    `json:"entry"`
	Level       string    `json:"level"`
}

type Options

type Options struct {
	ConfigFile string
	InputFile  string
	Project    string
	Index      string
	Host       string
	Type       string
	Silent     bool
	Version    bool
	NoColor    bool
	Verbose    bool
}

func ParseOptions

func ParseOptions() *Options

ParseOptions parses the command line flags provided by a user

type Pusher

type Pusher struct {
	InputFile string
	Project   string
	Index     string
	Host      string
	Type      string
}

func FromConfig

func FromConfig(config elasticsearch.Config, index string, host string) (*Pusher, error)

func FromOptions

func FromOptions(options *Options) (*Pusher, error)

func (*Pusher) PushFile

func (p *Pusher) PushFile() error

func (*Pusher) PushLog

func (p *Pusher) PushLog(json string, level string) error

type Store

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

Store allows to index and search documents.

func NewStore

func NewStore(c StoreConfig) (*Store, error)

NewStore returns a new instance of the store.

func (*Store) CreateBulkFromData

func (s *Store) CreateBulkFromData(payload []byte) error

CreateBulkFromData takes a byte array and creates a BulkRequest from it and stores it at the defined index.

func (*Store) CreateFromData

func (s *Store) CreateFromData(payload []byte) error

CreateFromData takes a byte array and creates an IndexRequest from it and stores it at the defined index.

func (*Store) CreateFromObject

func (s *Store) CreateFromObject(item any) error

Create indexes a new document into store.

func (*Store) CreateIndex

func (s *Store) CreateIndex(mapping string) error

CreateIndex creates a new index with mapping.

type StoreConfig

type StoreConfig struct {
	Client      *elasticsearch.Client
	IndexName   string
	ProjectName string
}

StoreConfig configures the store.