input

Documentation

Index

• type Forward
• type Http
• type Input
  • func (in *Input) DeepCopyInto(out *Input)
  • func (i *Input) Name() string
  • func (i *Input) Params(loader plugins.SecretLoader) (*params.PluginStore, error)
• type InputCommon

Types

type Forward

type Forward struct {
	// The transport section of forward plugin
	Transport *common.Transport `json:"transport,omitempty"`
	// The security section of forward plugin
	Security *common.Security `json:"security,omitempty"`
	// The security section of client plugin
	Client *common.Client `json:"client,omitempty"`
	// The security section of user plugin
	User *common.User `json:"user,omitempty"`
	// The port to listen to, default is 24224.
	// +kubebuilder:validation:Minimum:=1
	// +kubebuilder:validation:Maximum:=65535
	Port *int32 `json:"port,omitempty"`
	// The port to listen to, default is "0.0.0.0"
	Bind *string `json:"bind,omitempty"`
	// in_forward uses incoming event's tag by default (See Protocol Section).
	// If the tag parameter is set, its value is used instead.
	Tag *string `json:"tag,omitempty"`
	// Adds the prefix to the incoming event's tag.
	AddTagPrefix *string `json:"addTagPrefix,omitempty"`
	// The timeout used to set the linger option.
	LingerTimeout *uint16 `json:"lingerTimeout,omitempty"`
	// Tries to resolve hostname from IP addresses or not.
	ResolveHostname *bool `json:"resolveHostname,omitempty"`
	// The connections will be disconnected right after receiving a message, if true.
	DenyKeepalive *bool `json:"denyKeepalive,omitempty"`
	// Enables the TCP keepalive for sockets.
	SendKeepalivePacket *bool `json:"sendKeepalivePacket,omitempty"`
	// The size limit of the received chunk. If the chunk size is larger than this value, the received chunk is dropped.
	// +kubebuilder:validation:Pattern:="^\\d+(KB|MB|GB|TB)$"
	ChunkSizeLimit *string `json:"chunkSizeLimit,omitempty"`
	// The warning size limit of the received chunk. If the chunk size is larger than this value, a warning message will be sent.
	// +kubebuilder:validation:Pattern:="^\\d+(KB|MB|GB|TB)$"
	ChunkSizeWarnLimit *string `json:"chunkSizeWarnLimit,omitempty"`
	// Skips the invalid incoming event.
	SkipInvalidEvent *bool `json:"skipInvalidEvent,omitempty"`
	// The field name of the client's source address. If set, the client's address will be set to its key.
	SourceAddressKey *string `json:"sourceAddressKey,omitempty"`
	// The field name of the client's hostname. If set, the client's hostname will be set to its key.
	SourceHostnameKey *string `json:"sourceHostnameKey,omitempty"`
}

Forward defines the in_forward Input plugin that listens to a TCP socket to receive the event stream.

type Http

type Http struct {
	// The transport section of http plugin
	Transport *common.Transport `json:"transport,omitempty"`
	// The parse section of http plugin
	Parse *common.Parse `json:"parse,omitempty"`
	// The port to listen to, default is 9880.
	// +kubebuilder:validation:Minimum:=1
	// +kubebuilder:validation:Maximum:=65535
	Port *int32 `json:"port,omitempty"`
	// The port to listen to, default is "0.0.0.0"
	Bind *string `json:"bind,omitempty"`
	// The size limit of the POSTed element.
	// +kubebuilder:validation:Pattern:="^\\d+(KB|MB|GB|TB)$"
	BodySizeLimit *string `json:"bodySizeLimit,omitempty"`
	// The timeout limit for keeping the connection alive.
	// +kubebuilder:validation:Pattern:="^\\d+(\\.[0-9]{0,2})?(s|m|h|d)?$"
	KeepLiveTimeout *string `json:"keepaliveTimeout,omitempty"`
	// Adds HTTP_ prefix headers to the record.
	AddHttpHeaders *bool `json:"addHttpHeaders,omitempty"`
	// Adds REMOTE_ADDR field to the record. The value of REMOTE_ADDR is the client's address.
	// i.e: X-Forwarded-For: host1, host2
	AddRemoteAddr *string `json:"addRemoteAddr,omitempty"`
	// Whitelist domains for CORS.
	CorsAllowOrigins *string `json:"corsAllOrigins,omitempty"`
	// Add Access-Control-Allow-Credentials header. It's needed when a request's credentials mode is include
	CorsAllowCredentials *string `json:"corsAllowCredentials,omitempty"`
	// Responds with an empty GIF image of 1x1 pixel (rather than an empty string).
	RespondsWithEmptyImg *bool `json:"respondsWithEmptyImg,omitempty"`
}

Http defines the in_http Input plugin that listens to a TCP socket to receive the event stream.

type Input

type Input struct {
	InputCommon `json:",inline"`
	// in_forward plugin
	Forward *Forward `json:"forward,omitempty"`
	// in_http plugin
	Http *Http `json:"http,omitempty"`
}

Input defines all available input plugins and their parameters

func (*Input) DeepCopyInto

func (in *Input) DeepCopyInto(out *Input)

DeepCopyInto implements the DeepCopyInto interface.

func (*Input) Name

func (i *Input) Name() string

func (*Input) Params

func (i *Input) Params(loader plugins.SecretLoader) (*params.PluginStore, error)

type InputCommon

type InputCommon struct {
	// The @id parameter specifies a unique name for the configuration.
	Id *string `json:"id,omitempty"`
	// The @log_level parameter specifies the plugin-specific logging level
	LogLevel *string `json:"logLevel,omitempty"`
	// The @label parameter is to route the input events to <label> sections.
	Label *string `json:"label,omitempty"`
}

InputCommon defines the common parameters for input plugins