params

Documentation

Index

• Constants
• Variables
• type FilterType
• type InputType
• type OutputType
• type PluginName
• type PluginStore
  • func NewPluginStore(name string) *PluginStore
  • func (ps *PluginStore) GetId() string
  • func (ps *PluginStore) GetTag() string
  • func (ps *PluginStore) Hash() string
  • func (ps *PluginStore) InsertChilds(childs ...*PluginStore)
  • func (ps *PluginStore) InsertPairs(key, value string)
  • func (ps *PluginStore) InsertType(value string)
  • func (ps *PluginStore) RouteLabel() string
  • func (ps *PluginStore) SetIgnorePath()
  • func (ps *PluginStore) String() string
• type PluginStoreByName
  • func (a PluginStoreByName) Len() int
  • func (a PluginStoreByName) Less(i, j int) bool
  • func (a PluginStoreByName) Swap(i, j int)
• type PluginStoreByNameById
  • func (a PluginStoreByNameById) Len() int
  • func (a PluginStoreByNameById) Less(i, j int) bool
  • func (a PluginStoreByNameById) Swap(i, j int)

Constants

const (
	InputPlugin     PluginName = "input"
	ForwardPlugin   PluginName = "forward"
	HttpPlugin      PluginName = "http"
	TransportPlugin PluginName = "transport"
	InjectPlugin    PluginName = "inject"
	FormatPlugin    PluginName = "format"
	TimePlugin      PluginName = "time"
	SecurityPlugin  PluginName = "security"
	AuthPlugin      PluginName = "auth"
	UserPlugin      PluginName = "user"
	ClientPlugin    PluginName = "client"
	ServerPlugin    PluginName = "server"

	FilterPlugin            PluginName = "filter"
	GrepPlugin              PluginName = "grep"
	RecordTransformerPlugin PluginName = "record_transformer"
	ParserPlugin            PluginName = "parser"
	StdoutPlugin            PluginName = "stdout"

	ReLabelPlugin                 PluginName = "relabel"
	LabelPlugin                   PluginName = "label"
	LabelRouterPlugin             PluginName = "label_router"
	S3Plugin                      PluginName = "s3"
	KafkaPlugin                   PluginName = "kafka2"
	ElasticsearchPlugin           PluginName = "elasticsearch"
	ElasticsearchDataStreamPlugin PluginName = "elasticsearch_data_stream"
	OpensearchPlugin              PluginName = "opensearch"
	MatchPlugin                   PluginName = "match"
	BufferPlugin                  PluginName = "buffer"
	CloudWatchPlugin              PluginName = "cloudwatch_logs"
	DatadogPlugin                 PluginName = "datadog"

	BufferTag    string = "tag"
	LabelTag     string = "tag"
	MatchTag     string = "tag"
	FilterTag    string = "tag"
	ProtocolName string = "protocol"
	// Default interval whitespaces between parent and child
	IntervalWhitespaces string = "  "
	DefaultFmtExpr      string = "  %s"

	// Enums the supported input types
	HttpInputType    InputType = "http"
	ForwardInputType InputType = "forward"
	TailInputType    InputType = "tail"
	SampleInputType  InputType = "sample"
	MonitorAgentType InputType = "monitor_agent"

	// Enums the supported filter types
	RecordTransformerFilterType FilterType = "record_transformer"
	GrepFilterType              FilterType = "grep"
	ParserFilterType            FilterType = "parser"
	StdoutFilterType            FilterType = "stdout"

	// Enums the supported output types
	ForwardOutputType                 OutputType = "forward"
	HttpOutputType                    OutputType = "http"
	StdOutputType                     OutputType = "stdout"
	KafkaOutputType                   OutputType = "kafka2"
	ElasticsearchOutputType           OutputType = "elasticsearch"
	ElasticsearchDataStreamOutputType OutputType = "elasticsearch_data_stream"
	OpensearchOutputType              OutputType = "opensearch"
	S3OutputType                      OutputType = "s3"
	LokiOutputType                    OutputType = "loki"
	CloudWatchOutputType              OutputType = "cloudwatch_logs"
	DatadogOutputType                 OutputType = "datadog"
	CopyOutputType                    OutputType = "copy"
)

Variables

var (
	DefaultTag        = "**"
	DefaultFormatType = "json"
	// Buffer path for single process
	DefaultBufferPath = "/buffers/fluentd/log"
)

Types

type FilterType

type FilterType string

type InputType

type InputType string

type OutputType

type OutputType string

type PluginName

type PluginName string

type PluginStore

type PluginStore struct {
	// The plugin name
	Name string
	// The key-value pairs
	Store map[string]string
	// The child plugins mounted here
	Childs []*PluginStore
	// The prefix whitespaces before this plugin mounted the parent plugin
	PrefixWhitespaces string
	// The flag whether to ignore the path field in buffer
	IgnorePath bool
	Content    string
}

func NewPluginStore

func NewPluginStore(name string) *PluginStore

func (*PluginStore) GetId

func (ps *PluginStore) GetId() string

Returns @id value

func (*PluginStore) GetTag

func (ps *PluginStore) GetTag() string

Returns tag value

func (*PluginStore) Hash

func (ps *PluginStore) Hash() string

The total hash string for this plugin store

func (*PluginStore) InsertChilds

func (ps *PluginStore) InsertChilds(childs ...*PluginStore)

If one label section contains a match section, we consider that the match section is the child of label section

func (*PluginStore) InsertPairs

func (ps *PluginStore) InsertPairs(key, value string)

func (*PluginStore) InsertType

func (ps *PluginStore) InsertType(value string)

The @type parameter specifies the type of the plugin

func (*PluginStore) RouteLabel

func (ps *PluginStore) RouteLabel() string

Returns the @label value string of this plugin store

func (*PluginStore) SetIgnorePath

func (ps *PluginStore) SetIgnorePath()

SetIgnorePath will ignore the buffer path

func (*PluginStore) String

func (ps *PluginStore) String() string

type PluginStoreByName

type PluginStoreByName []*PluginStore

+kubebuilder:object:generate=false

func (PluginStoreByName) Len

func (a PluginStoreByName) Len() int

func (PluginStoreByName) Less

func (a PluginStoreByName) Less(i, j int) bool

func (PluginStoreByName) Swap

func (a PluginStoreByName) Swap(i, j int)

type PluginStoreByNameById

type PluginStoreByNameById []*PluginStore

+kubebuilder:object:generate=false

func (PluginStoreByNameById) Len

func (a PluginStoreByNameById) Len() int

func (PluginStoreByNameById) Less

func (a PluginStoreByNameById) Less(i, j int) bool

func (PluginStoreByNameById) Swap

func (a PluginStoreByNameById) Swap(i, j int)