output

package
v0.8.16 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 31, 2023 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Batch added in v0.8.7 

type Batch struct {
	// Description: Specifies how many lines are flushed to a destination in one batch. The syslog-ng OSE application waits for this number of lines to accumulate and sends them off in a single batch. Increasing this number increases throughput as more messages are sent in a single batch, but also increases message latency.
	// For example, if you set batch-lines() to 100, syslog-ng OSE waits for 100 messages.
	BatchLines int `json:"batch-lines,omitempty"`
	// Description: Sets the maximum size of payload in a batch. If the size of the messages reaches this value, syslog-ng OSE sends the batch to the destination even if the number of messages is less than the value of the batch-lines() option.
	// Note that if the batch-timeout() option is enabled and the queue becomes empty, syslog-ng OSE flushes the messages only if batch-timeout() expires, or the batch reaches the limit set in batch-bytes().
	BatchBytes int `json:"batch-bytes,omitempty"`
	// Description: Specifies the time syslog-ng OSE waits for lines to accumulate in the output buffer. The syslog-ng OSE application sends batches to the destinations evenly. The timer starts when the first message arrives to the buffer, so if only few messages arrive, syslog-ng OSE sends messages to the destination at most once every batch-timeout() milliseconds.
	BatchTimeout int `json:"batch-timeout,omitempty"`
}

type DiskBuffer 

type DiskBuffer struct {
	// This is a required option. The maximum size of the disk-buffer in bytes. The minimum value is 1048576 bytes.
	DiskBufSize int64 `json:"disk_buf_size"`
	//  If set to yes, syslog-ng OSE cannot lose logs in case of reload/restart, unreachable destination or syslog-ng OSE crash. This solution provides a slower, but reliable disk-buffer option.
	Reliable bool `json:"reliable"`
	// Prunes the unused space in the LogMessage representation
	Compaction *bool `json:"compaction,omitempty"`
	// Description: Defines the folder where the disk-buffer files are stored.
	Dir string `json:"dir,omitempty"`
	// Use this option if the option reliable() is set to no. This option contains the number of messages stored in overflow queue.
	MemBufLength *int64 `json:"mem_buf_length,omitempty"`
	// Use this option if the option reliable() is set to yes. This option contains the size of the messages in bytes that is used in the memory part of the disk buffer.
	MemBufSize *int64 `json:"mem_buf_size,omitempty"`
	// The number of messages stored in the output buffer of the destination.
	QOutSize *int64 `json:"q_out_size,omitempty"`
}

+kubebuilder:object:generate=true Documentation: https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#TOPIC-1829124

func (*DiskBuffer) DeepCopy 

func (in *DiskBuffer) DeepCopy() *DiskBuffer

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DiskBuffer.

func (*DiskBuffer) DeepCopyInto 

func (in *DiskBuffer) DeepCopyInto(out *DiskBuffer)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type FileOutput 

type FileOutput struct {
	// Store file path
	Path string `json:"path" syslog-ng:"pos=0"`
	// Enable creating non-existing directories. (default: false)
	CreateDirs bool `json:"create_dirs,omitempty"`
	// The group of the directories created by syslog-ng. To preserve the original properties of an existing directory, use the option without specifying an attribute: dir-group(). (default: Use the global settings)
	DirGroup string `json:"dir_group,omitempty"`
	// The owner of the directories created by syslog-ng. To preserve the original properties of an existing directory, use the option without specifying an attribute: dir-owner(). (default: Use the global settings)
	DirOwner string `json:"dir_owner,omitempty"`
	// The permission mask of directories created by syslog-ng. Log directories are only created if a file after macro expansion refers to a non-existing directory, and directory creation is enabled (see also the create-dirs() option). For octal numbers prefix the number with 0, for example use 0755 for rwxr-xr-x.(default: Use the global settings)
	DirPerm int `json:"dir_perm,omitempty"`
	// This option enables putting outgoing messages into the disk buffer of the destination to avoid message loss in case of a system failure on the destination side. For details, see the [Syslog-ng DiskBuffer options](../disk_buffer/). (default: false)
	DiskBuffer  *DiskBuffer `json:"disk_buffer,omitempty"`
	Template    string      `json:"template,omitempty"`
	PersistName string      `json:"persist_name,omitempty"`
}

+kubebuilder:object:generate=true Documentation: https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/36#TOPIC-1829044

func (*FileOutput) DeepCopy 

func (in *FileOutput) DeepCopy() *FileOutput

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FileOutput.

func (*FileOutput) DeepCopyInto 

func (in *FileOutput) DeepCopyInto(out *FileOutput)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type HTTPOutput added in v0.8.7 

type HTTPOutput struct {
	// Specifies the hostname or IP address and optionally the port number of the web service that can receive log data via HTTP. Use a colon (:) after the address to specify the port number of the server. For example: http://127.0.0.1:8000
	URL string `json:"url,omitempty"`
	// Custom HTTP headers to include in the request, for example, headers("HEADER1: header1", "HEADER2: header2").  (default: empty)
	Headers []string `json:"headers,omitempty"`
	// The time to wait in seconds before a dead connection is reestablished. (default: 60)
	TimeReopen int `json:"time_reopen,omitempty"`
	// This option sets various options related to TLS encryption, for example, key/certificate files and trusted CA locations. TLS can be used only with tcp-based transport protocols. For details, see [TLS for syslog-ng outputs](../tls/) and the [syslog-ng documentation](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/73#TOPIC-1829193).
	TLS *TLS `json:"tls,omitempty"`
	// This option enables putting outgoing messages into the disk buffer of the destination to avoid message loss in case of a system failure on the destination side. For details, see the [Syslog-ng DiskBuffer options](../disk_buffer/). (default: false)
	DiskBuffer *DiskBuffer `json:"disk_buffer,omitempty"`
	// Batching parameters
	Batch `json:",inline"`
	// The body of the HTTP request, for example, body("${ISODATE} ${MESSAGE}"). You can use strings, macros, and template functions in the body. If not set, it will contain the message received from the source by default.
	Body string `json:"body,omitempty"`
	// The string syslog-ng OSE puts at the beginning of the body of the HTTP request, before the log message.
	BodyPrefix string `json:"body-prefix,omitempty"`
	// The string syslog-ng OSE puts to the end of the body of the HTTP request, after the log message.
	BodySuffix string `json:"body-suffix,omitempty"`
	// By default, syslog-ng OSE separates the log messages of the batch with a newline character.
	Delimiter string `json:"delimiter,omitempty"`
	// Specifies the HTTP method to use when sending the message to the server. POST | PUT
	Method string `json:"method,omitempty"`
	// The number of times syslog-ng OSE attempts to send a message to this destination. If syslog-ng OSE could not send a message, it will try again until the number of attempts reaches retries, then drops the message.
	Retries int `json:"retries,omitempty"`
	// The username that syslog-ng OSE uses to authenticate on the server where it sends the messages.
	User string `json:"user,omitempty"`
	// The password that syslog-ng OSE uses to authenticate on the server where it sends the messages.
	Password secret.Secret `json:"password,omitempty"`
	// The value of the USER-AGENT header in the messages sent to the server.
	UserAgent string `json:"user-agent,omitempty"`
	// Description: Specifies the number of worker threads (at least 1) that syslog-ng OSE uses to send messages to the server. Increasing the number of worker threads can drastically improve the performance of the destination.
	Workers     int    `json:"workers,omitempty"`
	PersistName string `json:"persist_name,omitempty"`
}

+kubebuilder:object:generate=true

func (*HTTPOutput) DeepCopy added in v0.8.7 

func (in *HTTPOutput) DeepCopy() *HTTPOutput

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPOutput.

func (*HTTPOutput) DeepCopyInto added in v0.8.7 

func (in *HTTPOutput) DeepCopyInto(out *HTTPOutput)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Loggly added in v0.8.5 

type Loggly struct {
	// Address of the destination host
	Host string `json:"host,omitempty"`
	// Event tag [more information](https://documentation.solarwinds.com/en/success_center/loggly/content/admin/tags.htm)
	Tag string `json:"tag,omitempty"`
	// Your Customer Token that you received from Loggly [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/43#loggly-option-token)
	Token *secret.Secret `json:"token"`
	// syslog output configuration
	SyslogOutput `json:",inline"`
}

func (*Loggly) DeepCopy added in v0.8.5 

func (in *Loggly) DeepCopy() *Loggly

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Loggly.

func (*Loggly) DeepCopyInto added in v0.8.5 

func (in *Loggly) DeepCopyInto(out *Loggly)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SumologicHTTPOutput 

type SumologicHTTPOutput struct {
	// The Cloud Syslog Cloud Token that you received from the Sumo Logic service while configuring your cloud syslog source. (default: empty)
	Collector *secret.Secret `json:"collector,omitempty"`
	// This option specifies your Sumo Logic deployment.https://help.sumologic.com/APIs/General-API-Information/Sumo-Logic-Endpoints-by-Deployment-and-Firewall-Security  (default: empty)
	Deployment string `json:"deployment,omitempty"`
	// Custom HTTP headers to include in the request, for example, headers("HEADER1: header1", "HEADER2: header2").  (default: empty)
	Headers []string `json:"headers,omitempty"`
	// The time to wait in seconds before a dead connection is reestablished. (default: 60)
	TimeReopen int `json:"time_reopen,omitempty"`
	// This option sets various options related to TLS encryption, for example, key/certificate files and trusted CA locations. TLS can be used only with tcp-based transport protocols. For details, see [TLS for syslog-ng outputs](../tls/) and the [syslog-ng documentation](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/73#TOPIC-1829193).
	TLS *TLS `json:"tls,omitempty"`
	// This option enables putting outgoing messages into the disk buffer of the destination to avoid message loss in case of a system failure on the destination side. For details, see the [Syslog-ng DiskBuffer options](../disk_buffer/). (default: false)
	DiskBuffer   *DiskBuffer    `json:"disk_buffer,omitempty"`
	Body         string         `json:"body,omitempty"`
	URL          *secret.Secret `json:"url,omitempty"`
	BatchLines   int            `json:"batch-lines,omitempty"`
	BatchBytes   int            `json:"batch-bytes,omitempty"`
	BatchTimeout int            `json:"batch-timeout,omitempty"`
	PersistName  string         `json:"persist_name,omitempty"`
}

+kubebuilder:object:generate=true

func (*SumologicHTTPOutput) DeepCopy 

func (in *SumologicHTTPOutput) DeepCopy() *SumologicHTTPOutput

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SumologicHTTPOutput.

func (*SumologicHTTPOutput) DeepCopyInto 

func (in *SumologicHTTPOutput) DeepCopyInto(out *SumologicHTTPOutput)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SumologicSyslogOutput 

type SumologicSyslogOutput struct {
	// This option sets the port number of the Sumo Logic server to connect to. (default: 6514)
	Port int `json:"port,omitempty"`
	// This option specifies your Sumo Logic deployment.https://help.sumologic.com/APIs/General-API-Information/Sumo-Logic-Endpoints-by-Deployment-and-Firewall-Security  (default: empty)
	Deployment string `json:"deployment,omitempty"`
	//  This option specifies the list of tags to add as the tags fields of Sumo Logic messages. If not specified, syslog-ng OSE automatically adds the tags already assigned to the message. If you set the tag() option, only the tags you specify will be added to the messages. (default: tag)
	Tag string `json:"tag,omitempty"`
	// The Cloud Syslog Cloud Token that you received from the Sumo Logic service while configuring your cloud syslog source. https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/Cloud-Syslog-Source#configure-a-cloud%C2%A0syslog%C2%A0source
	Token int `json:"token,omitempty"`
	// This option sets various options related to TLS encryption, for example, key/certificate files and trusted CA locations. TLS can be used only with tcp-based transport protocols. For details, see [TLS for syslog-ng outputs](../tls/) and the [syslog-ng documentation](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/73#TOPIC-1829193).
	TLS *TLS `json:"tls,omitempty"`
	// This option enables putting outgoing messages into the disk buffer of the destination to avoid message loss in case of a system failure on the destination side. For details, see the [Syslog-ng DiskBuffer options](../disk_buffer/). (default: false)
	DiskBuffer  *DiskBuffer `json:"disk_buffer,omitempty"`
	PersistName string      `json:"persist_name,omitempty"`
}

+kubebuilder:object:generate=true

func (*SumologicSyslogOutput) DeepCopy 

func (in *SumologicSyslogOutput) DeepCopy() *SumologicSyslogOutput

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SumologicSyslogOutput.

func (*SumologicSyslogOutput) DeepCopyInto 

func (in *SumologicSyslogOutput) DeepCopyInto(out *SumologicSyslogOutput)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SyslogOutput 

type SyslogOutput struct {
	// Address of the destination host
	Host string `json:"host,omitempty" syslog-ng:"pos=0"`
	// The port number to connect to. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor895)
	Port int `json:"port,omitempty"`
	// Specifies the protocol used to send messages to the destination server. [more information]() [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor911)
	Transport string `json:"transport,omitempty"`
	// By default, syslog-ng OSE closes destination sockets if it receives any input from the socket (for example, a reply). If this option is set to no, syslog-ng OSE just ignores the input, but does not close the socket. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor859)
	CloseOnInput *bool `json:"close_on_input,omitempty"`
	// Flags influence the behavior of the destination driver. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor877)
	Flags []string `json:"flags,omitempty"`
	// Specifies how many lines are flushed to a destination at a time. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor880)
	FlushLines int `json:"flush_lines,omitempty"`
	// Enables keep-alive messages, keeping the socket open. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor897)
	SoKeepalive *bool `json:"so_keepalive,omitempty"`
	// Specifies the number of seconds syslog-ng waits for identical messages. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor901)
	Suppress int `json:"suppress,omitempty"`
	// Specifies a template defining the logformat to be used in the destination. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor905) (default: 0)
	Template string `json:"template,omitempty"`
	// Turns on escaping for the ', ", and backspace characters in templated output files. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor906)
	TemplateEscape *bool `json:"template_escape,omitempty"`
	// Sets various options related to TLS encryption, for example, key/certificate files and trusted CA locations. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor910)
	TLS *TLS `json:"tls,omitempty"`
	// Override the global timestamp format (set in the global ts-format() parameter) for the specific destination. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor912)
	TSFormat string `json:"ts_format,omitempty"`
	// Enables putting outgoing messages into the disk buffer of the destination to avoid message loss in case of a system failure on the destination side. For details, see the [Syslog-ng DiskBuffer options](../disk_buffer/).
	DiskBuffer *DiskBuffer `json:"disk_buffer,omitempty"`
	// Unique name for the syslog-ng driver [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.16/administration-guide/persist-name)
	PersistName string `json:"persist_name,omitempty"`
}

+kubebuilder:object:generate=true Documentation: https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#TOPIC-1829124

func (*SyslogOutput) DeepCopy 

func (in *SyslogOutput) DeepCopy() *SyslogOutput

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SyslogOutput.

func (*SyslogOutput) DeepCopyInto 

func (in *SyslogOutput) DeepCopyInto(out *SyslogOutput)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TLS 

type TLS struct {
	// The name of a directory that contains a set of trusted CA certificates in PEM format. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/73#kanchor3142)
	CaDir *secret.Secret `json:"ca_dir,omitempty"`
	// The name of a file that contains a set of trusted CA certificates in PEM format. (Optional) [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/73#kanchor3144)
	CaFile *secret.Secret `json:"ca_file,omitempty"`
	// The name of a file that contains an unencrypted private key in PEM format, suitable as a TLS key. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/73#kanchor3163)
	KeyFile *secret.Secret `json:"key_file,omitempty"`
	// Name of a file, that contains an X.509 certificate (or a certificate chain) in PEM format, suitable as a TLS certificate, matching the private key set in the key-file() option. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/73#kanchor3146)
	CertFile *secret.Secret `json:"cert_file,omitempty"`
	// Verification method of the peer. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/73#tls-options-peer-verify)
	PeerVerify string `json:"peer_verify,omitempty"`
	// Use the certificate store of the system for verifying HTTPS certificates. [more information](https://curl.se/docs/sslcerts.html)
	UseSystemCertStore *bool `json:"use-system-cert-store,omitempty"`
	// Description: Specifies the cipher, hash, and key-exchange algorithms used for the encryption, for example, ECDHE-ECDSA-AES256-SHA384. The list of available algorithms depends on the version of OpenSSL used to compile syslog-ng OSE
	CipherSuite string `json:"cipher-suite,omitempty"`
}

+kubebuilder:object:generate=true

func (*TLS) DeepCopy 

func (in *TLS) DeepCopy() *TLS

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TLS.

func (*TLS) DeepCopyInto 

func (in *TLS) DeepCopyInto(out *TLS)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.