Skip to content

Commit

Permalink
chore(syslog-ng-outputs): add diskbuffer for all output types
Browse files Browse the repository at this point in the history
Signed-off-by: Kristof Gyuracz <[email protected]>
  • Loading branch information
kristofgyuracz committed May 13, 2024
1 parent d7475d1 commit 5323030
Show file tree
Hide file tree
Showing 13 changed files with 150 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1698,6 +1698,30 @@ spec:
type: boolean
compresslevel:
type: integer
disk_buffer:
properties:
compaction:
type: boolean
dir:
type: string
disk_buf_size:
format: int64
type: integer
mem_buf_length:
format: int64
type: integer
mem_buf_size:
format: int64
type: integer
q_out_size:
format: int64
type: integer
reliable:
type: boolean
required:
- disk_buf_size
- reliable
type: object
flush_grace_period:
type: integer
log-fifo-size:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1694,6 +1694,30 @@ spec:
type: boolean
compresslevel:
type: integer
disk_buffer:
properties:
compaction:
type: boolean
dir:
type: string
disk_buf_size:
format: int64
type: integer
mem_buf_length:
format: int64
type: integer
mem_buf_size:
format: int64
type: integer
q_out_size:
format: int64
type: integer
reliable:
type: boolean
required:
- disk_buf_size
- reliable
type: object
flush_grace_period:
type: integer
log-fifo-size:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1698,6 +1698,30 @@ spec:
type: boolean
compresslevel:
type: integer
disk_buffer:
properties:
compaction:
type: boolean
dir:
type: string
disk_buf_size:
format: int64
type: integer
mem_buf_length:
format: int64
type: integer
mem_buf_size:
format: int64
type: integer
q_out_size:
format: int64
type: integer
reliable:
type: boolean
required:
- disk_buf_size
- reliable
type: object
flush_grace_period:
type: integer
log-fifo-size:
Expand Down
24 changes: 24 additions & 0 deletions config/crd/bases/logging.banzaicloud.io_syslogngoutputs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1694,6 +1694,30 @@ spec:
type: boolean
compresslevel:
type: integer
disk_buffer:
properties:
compaction:
type: boolean
dir:
type: string
disk_buf_size:
format: int64
type: integer
mem_buf_length:
format: int64
type: integer
mem_buf_size:
format: int64
type: integer
q_out_size:
format: int64
type: integer
reliable:
type: boolean
required:
- disk_buf_size
- reliable
type: object
flush_grace_period:
type: integer
log-fifo-size:
Expand Down
6 changes: 6 additions & 0 deletions docs/configuration/plugins/syslogng-outputs/elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ spec:
The document ID. If no ID is specified, a document ID is automatically generated.


### disk_buffer (*DiskBuffer, optional) {#elasticsearchoutput-disk_buffer}

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

### index (string, optional) {#elasticsearchoutput-index}

Name of the data stream, index, or index alias to perform the action on.
Expand Down
6 changes: 6 additions & 0 deletions docs/configuration/plugins/syslogng-outputs/openobserve.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ For details on the available options of the output, see the [documentation of th
### (HTTPOutput, required) {#openobserveoutput-}


### disk_buffer (*DiskBuffer, optional) {#openobserveoutput-disk_buffer}

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

### organization (string, optional) {#openobserveoutput-organization}

Name of the organization in OpenObserve.
Expand Down
10 changes: 8 additions & 2 deletions docs/configuration/plugins/syslogng-outputs/s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,12 @@ Enable or disable compression.

Default: false

### disk_buffer (*DiskBuffer, optional) {#s3output-disk_buffer}

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

### flush_grace_period (int, optional) {#s3output-flush_grace_period}

Set the number of seconds for flush period.
Expand Down Expand Up @@ -101,7 +107,7 @@ Default: 32
The object_key for the S3 server.


### object_key_timestamp (RawString, optional) {#s3output-object_key_timestamp}
### object_key_timestamp (string, optional) {#s3output-object_key_timestamp}

Set object_key_timestamp

Expand Down Expand Up @@ -131,7 +137,7 @@ The secret_key for the S3 server.
Set the storage_class option.


### template (RawString, optional) {#s3output-template}
### template (string, optional) {#s3output-template}

Template

Expand Down
6 changes: 6 additions & 0 deletions docs/configuration/plugins/syslogng-outputs/splunk_hec.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,12 @@ Fallback option for source field.
Fallback option for sourcetype field.


### disk_buffer (*DiskBuffer, optional) {#splunkhecoutput-disk_buffer}

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

### event (string, optional) {#splunkhecoutput-event}

event() accepts a template, which declares the content of the log message sent to Splunk. Default value: `${MSG}`
Expand Down
2 changes: 2 additions & 0 deletions pkg/sdk/logging/model/syslogng/output/elasticsearch.go
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ type ElasticsearchOutput struct {
LogstashPrefixSeparator string `json:"logstash_prefix_separator,omitempty" syslog-ng:"ignore"`
// Set the suffix for logs in logstash format. Default: `"${YEAR}.${MONTH}.${DAY}"`
LogStashSuffix string `json:"logstash_suffix,omitempty" syslog-ng:"ignore"`
// 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"`
}

func (o *ElasticsearchOutput) BeforeRender() {
Expand Down
2 changes: 2 additions & 0 deletions pkg/sdk/logging/model/syslogng/output/openobserve.go
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ type OpenobserveOutput struct {
// Arguments to the `$format-json()` template function.
// Default: `"--scope rfc5424 --exclude DATE --key ISODATE @timestamp=${ISODATE}"`
Record string `json:"record,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"`
}

func (o *OpenobserveOutput) BeforeRender() {
Expand Down
2 changes: 2 additions & 0 deletions pkg/sdk/logging/model/syslogng/output/s3.go
Original file line number Diff line number Diff line change
Expand Up @@ -105,4 +105,6 @@ type S3Output struct {
Retries int `json:"retries,omitempty"`
// Sets the maximum number of messages sent to the destination per second. Use this output-rate-limiting functionality only when using disk-buffer as well to avoid the risk of losing messages. Specifying 0 or a lower value sets the output limit to unlimited. (default: 0)
Throttle int `json:"throttle,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"`
}
2 changes: 2 additions & 0 deletions pkg/sdk/logging/model/syslogng/output/splunk_hec.go
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,6 @@ type SplunkHECOutput struct {
ExtraQueries []string `json:"extra_queries,omitempty"`
// Additional HTTP request content-type option.
ContentType string `json:"content_type,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"`
}
20 changes: 20 additions & 0 deletions pkg/sdk/logging/model/syslogng/output/zz_generated.deepcopy.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 5323030

Please sign in to comment.