S3

Sends messages from a local network to a S3 (compatible) server. For more information, see the documentation of the AxoSyslog syslog-ng distribution.

Example

apiVersion: logging.banzaicloud.io/v1beta1
kind: SyslogNGOutput
metadata:
  name: s3
spec:
  s3:
    url: "https://some-s3-compatible-endpoint:8088"
    bucket: "s3bucket-name"
    access_key:
      valueFrom:
        secretKeyRef:
          name: s3
          key: access-key
    secret_key:
      valueFrom:
        secretKeyRef:
          name: s3
          key: secret-key
    object_key: "${HOST}/my-logs"

For available macros like $PROGRAM and $HOST see https://axoflow.com/docs/axosyslog-core/chapter-manipulating-messages/customizing-message-format/reference-macros/

S3Output

url (string, optional)

The hostname or IP address of the S3 server.

Default: -

bucket (string, optional)

The bucket name of the S3 server.

Default: -

access_key (*secret.Secret, optional)

The access_key for the S3 server.

Default: -

secret_key (*secret.Secret, optional)

The secret_key for the S3 server.

Default: -

object_key (string, optional)

The object_key for the S3 server.

Default: -

object_key_timestamp (RawString, optional)

Set object_key_timestamp

Default: -

template (RawString, optional)

Template

Default: -

compression (*bool, optional)

Enable or disable compression.

Default: false

compresslevel (int, optional)

Set the compression level (1-9).

Default: 9

chunk_size (int, optional)

Set the chunk size.

Default: 5MiB

max_object_size (int, optional)

Set the maximum object size size.

Default: 5120GiB

upload_threads (int, optional)

Set the number of upload threads.

Default: 8

max_pending_uploads (int, optional)

Set the maximum number of pending uploads.

Default: 32

flush_grace_period (int, optional)

Set the number of seconds for flush period.

Default: 60

region (string, optional)

Set the region option.

Default: -

storage_class (string, optional)

Set the storage_class option.

Default: -

canned_acl (string, optional)

Set the canned_acl option.

Default: -

log-fifo-size (int, optional)

The number of messages that the output queue can store.

Default: -

persist_name (string, optional)

Persistname

Default: -

retries (int, optional)

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.

Default: -

throttle (int, optional)

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