diff --git a/content/docs/configuration/crds/extensions/eventtailer_types.md b/content/docs/configuration/crds/extensions/eventtailer_types.md index 52bc28ed5..d3653a1ca 100644 --- a/content/docs/configuration/crds/extensions/eventtailer_types.md +++ b/content/docs/configuration/crds/extensions/eventtailer_types.md @@ -38,6 +38,12 @@ Override container fields for the given statefulset Default: - +### image (*tailer.ImageSpec, optional) {#eventtailerspec-image} + +Override image related fields for the given statefulset, highest precedence + +Default: - + ## EventTailerStatus diff --git a/content/docs/configuration/crds/extensions/hosttailer_types.md b/content/docs/configuration/crds/extensions/hosttailer_types.md index 843cf81cb..9a61caa27 100644 --- a/content/docs/configuration/crds/extensions/hosttailer_types.md +++ b/content/docs/configuration/crds/extensions/hosttailer_types.md @@ -38,6 +38,10 @@ Override podSpec fields for the given daemonset Default: - +### image (tailer.ImageSpec, optional) {#hosttailerspec-image} + +Default: - + ## HostTailerStatus diff --git a/content/docs/configuration/crds/v1beta1/_index.md b/content/docs/configuration/crds/v1beta1/_index.md index fb7a481bb..20c9b9355 100644 --- a/content/docs/configuration/crds/v1beta1/_index.md +++ b/content/docs/configuration/crds/v1beta1/_index.md @@ -14,9 +14,10 @@ For more information please click on the name | **[ClusterOutput](clusteroutput_types/)** | ClusterOutput is the Schema for the clusteroutputs API | v1beta1 | | **[Common](common_types/)** | ImageSpec Metrics Security | v1beta1 | | **[FlowSpec](flow_types/)** | FlowSpec is the Kubernetes spec for Flows | v1beta1 | -| **[FluentbitSpec](fluentbit_types/)** | FluentbitSpec defines the desired state of Fluentbit | v1beta1 | +| **[FluentbitSpec](fluentbit_types/)** | FluentbitSpec defines the desired state of FluentbitAgent | v1beta1 | | **[FluentdSpec](fluentd_types/)** | FluentdSpec defines the desired state of Fluentd | v1beta1 | | **[Logging](logging_types/)** | Logging system configuration | v1beta1 | +| **[LoggingRouteSpec](loggingroute_types/)** | LoggingRouteSpec defines the desired state of LoggingRoute | v1beta1 | | **[NodeAgent](node_agent_types/)** | | v1beta1 | | **[OutputSpec](output_types/)** | OutputSpec defines the desired state of Output | v1beta1 | | **[SyslogNGClusterFlow](syslogng_clusterflow_types/)** | SyslogNGClusterFlow is the Schema for the syslog-ng clusterflows API | v1beta1 | diff --git a/content/docs/configuration/crds/v1beta1/fluentbit_types.md b/content/docs/configuration/crds/v1beta1/fluentbit_types.md index f85d92ee9..b37c6044a 100644 --- a/content/docs/configuration/crds/v1beta1/fluentbit_types.md +++ b/content/docs/configuration/crds/v1beta1/fluentbit_types.md @@ -297,6 +297,12 @@ spec: value: message ``` +### healthCheck (*HealthCheck, optional) {#fluentbitspec-healthcheck} + +Available in Logging operator version 4.4 and later. + +Default: - + ## FluentbitStatus FluentbitStatus defines the resource status for FluentbitAgent @@ -331,6 +337,12 @@ Default: ts Default: iso8601 +### Workers (*int, optional) {#fluentbittcpoutput-workers} + +Available in Logging operator version 4.4 and later. + +Default: - + ## FluentbitNetwork @@ -419,6 +431,39 @@ If storage.path is set, Fluent Bit will look for data chunks that were not deliv Default: 5M +### storage.metrics (string, optional) {#bufferstorage-storage.metrics} + +Available in Logging operator version 4.4 and later. + +If the `http_server` option has been enabled in the main Service configuration section, this option registers a new endpoint where internal metrics of the storage layer can be consumed. + +Default: Off + + +## HealthCheck + +Available in Logging operator version 4.4 and later. + +HealthCheck configuration + +### hcErrorsCount (int, optional) {#healthcheck-hcerrorscount} + +The error count to meet the unhealthy requirement, this is a sum for all output plugins in a defined HC_Period. + +Default: 5 + +### hcRetryFailureCount (int, optional) {#healthcheck-hcretryfailurecount} + +The retry failure count to meet the unhealthy requirement, this is a sum for all output plugins in a defined HC_Period + +Default: 5 + +### hcPeriod (int, optional) {#healthcheck-hcperiod} + +The time period (in seconds) to count the error and retry failure data point + +Default: 60 + ## InputTail @@ -1066,17 +1111,11 @@ Default: - Default: - +### Workers (*int, optional) {#forwardoptions-workers} -## FluentbitNameProvider - -Defines a FluentbitNameProvider +Available in Logging operator version 4.4 and later. -### Logging (*Logging, optional) {#fluentbitnameprovider-logging} +Enables dedicated thread(s) for this output. Default value (2) is set since version 1.8.13. For previous versions is 0. Default: - -### FluentbitAgent (*FluentbitAgent, optional) {#fluentbitnameprovider-fluentbitagent} - -Default: - - - diff --git a/content/docs/configuration/crds/v1beta1/fluentd_types.md b/content/docs/configuration/crds/v1beta1/fluentd_types.md index 8346a9ff5..386d8c6aa 100644 --- a/content/docs/configuration/crds/v1beta1/fluentd_types.md +++ b/content/docs/configuration/crds/v1beta1/fluentd_types.md @@ -98,7 +98,9 @@ Default: - ### port (int32, optional) {#fluentdspec-port} -Default: - +Fluentd port inside the container (24240 by default). The headless service port is controlled by this field as well. Note that the default ClusterIP service port is always 24240, regardless of this field. + +Default: 24240 ### tolerations ([]corev1.Toleration, optional) {#fluentdspec-tolerations} @@ -299,7 +301,7 @@ Default: - ### annotations (map[string]string, optional) {#fluentddrainconfig-annotations} -Container image to use for the drain watch sidecar +Annotations to use for the drain watch sidecar Default: - @@ -307,6 +309,8 @@ Default: - Labels to use for the drain watch sidecar on top of labels added by the operator by default. Default values can be overwritten. +Default: - + ### deleteVolume (bool, optional) {#fluentddrainconfig-deletevolume} Should persistent volume claims be deleted after draining is done @@ -323,4 +327,20 @@ Container image to use for the fluentd placeholder pod Default: - +### resources (*corev1.ResourceRequirements, optional) {#fluentddrainconfig-resources} + +Available in Logging operator version 4.4 and later. + +Configurable resource requirements for the drainer sidecar container. Default 20m cpu request, 20M memory limit + +Default: - + +### securityContext (*corev1.SecurityContext, optional) {#fluentddrainconfig-securitycontext} + +Available in Logging operator version 4.4 and later. + +Configurable security context, uses fluentd pods' security context by default + +Default: - + diff --git a/content/docs/configuration/crds/v1beta1/logging_types.md b/content/docs/configuration/crds/v1beta1/logging_types.md index e32103877..8c9048083 100644 --- a/content/docs/configuration/crds/v1beta1/logging_types.md +++ b/content/docs/configuration/crds/v1beta1/logging_types.md @@ -144,10 +144,26 @@ LoggingStatus defines the observed state of Logging ### configCheckResults (map[string]bool, optional) {#loggingstatus-configcheckresults} +Result of the config check. Under normal conditions there is a single item in the map with a bool value. + Default: - ### problems ([]string, optional) {#loggingstatus-problems} +Problems with the logging resource + +Default: - + +### problemsCount (int, optional) {#loggingstatus-problemscount} + +Count of problems for printcolumn + +Default: - + +### watchNamespaces ([]string, optional) {#loggingstatus-watchnamespaces} + +List of namespaces that watchNamespaces + watchNamespaceSelector is resolving to. Not set means all namespaces. + Default: - diff --git a/content/docs/configuration/crds/v1beta1/output_types.md b/content/docs/configuration/crds/v1beta1/output_types.md index abebe06c4..be033bae9 100644 --- a/content/docs/configuration/crds/v1beta1/output_types.md +++ b/content/docs/configuration/crds/v1beta1/output_types.md @@ -72,6 +72,10 @@ Default: - Default: - +### kinesisFirehose (*output.KinesisFirehoseOutputConfig, optional) {#outputspec-kinesisfirehose} + +Default: - + ### kinesisStream (*output.KinesisStreamOutputConfig, optional) {#outputspec-kinesisstream} Default: - diff --git a/content/docs/configuration/crds/v1beta1/syslogng_output_types.md b/content/docs/configuration/crds/v1beta1/syslogng_output_types.md index 557709ef5..9e33b54ec 100644 --- a/content/docs/configuration/crds/v1beta1/syslogng_output_types.md +++ b/content/docs/configuration/crds/v1beta1/syslogng_output_types.md @@ -64,6 +64,12 @@ Default: - Default: - +### s3 (*output.S3Output, optional) {#syslogngoutputspec-s3} + +Available in Logging operator version 4.4 and later. + +Default: - + ## SyslogNGOutput diff --git a/content/docs/configuration/plugins/_index.md b/content/docs/configuration/plugins/_index.md index 9b08a93cf..f4ade1654 100644 --- a/content/docs/configuration/plugins/_index.md +++ b/content/docs/configuration/plugins/_index.md @@ -3,8 +3,6 @@ title: Supported Plugins generated_file: true --- -# Supported Plugins - For more information please click on the plugin name
diff --git a/content/docs/configuration/plugins/filters/concat.md b/content/docs/configuration/plugins/filters/concat.md index bfbe5607c..fee9bc823 100644 --- a/content/docs/configuration/plugins/filters/concat.md +++ b/content/docs/configuration/plugins/filters/concat.md @@ -17,7 +17,7 @@ Specify field name in the record to parse. If you leave empty the Container Runt Default: - -### separator (string, optional) {#concat-separator} +### separator (*string, optional) {#concat-separator} The separator of lines. diff --git a/content/docs/configuration/plugins/filters/grep.md b/content/docs/configuration/plugins/filters/grep.md index 98fbed1cf..d5bd1cfa2 100644 --- a/content/docs/configuration/plugins/filters/grep.md +++ b/content/docs/configuration/plugins/filters/grep.md @@ -36,9 +36,9 @@ Default: - Default: - -## [Regexp Directive](https://docs.fluentd.org/filter/grep#less-than-regexp-greater-than-directive) {#Regexp-Directive} +## Regexp Directive {#Regexp-Directive} -Specify filtering rule. This directive contains two parameters. +Specify filtering rule (as described in the [Fluentd documentation](https://docs.fluentd.org/filter/grep#less-than-regexp-greater-than-directive)). This directive contains two parameters. ### key (string, required) {#regexp-directive-key} @@ -83,9 +83,9 @@ spec: ``` --- -## [Exclude Directive](https://docs.fluentd.org/filter/grep#less-than-exclude-greater-than-directive) {#Exclude-Directive} +## Exclude Directive -Specify filtering rule to reject events. This directive contains two parameters. +Specify filtering rule to reject events (as described in the [Fluentd documentation](https://docs.fluentd.org/filter/grep#less-than-exclude-greater-than-directive)). This directive contains two parameters. ### key (string, required) {#exclude-directive-key} @@ -132,7 +132,7 @@ spec: --- ## [Or Directive](https://docs.fluentd.org/filter/grep#less-than-or-greater-than-directive) {#Or-Directive} -Specify filtering rule. This directive contains either `regexp` or `exclude` directive. +Specify filtering rule (as described in the [Fluentd documentation](https://docs.fluentd.org/filter/grep#less-than-or-greater-than-directive). This directive contains either `regexp` or `exclude` directive. ### regexp ([]RegexpSection, optional) {#or-directive-regexp} @@ -185,7 +185,7 @@ spec: --- ## [And Directive](https://docs.fluentd.org/filter/grep#less-than-and-greater-than-directive) {#And-Directive} -Specify filtering rule. This directive contains either `regexp` or `exclude` directive. +Specify filtering rule (as described in the [Fluentd documentation](https://docs.fluentd.org/filter/grep#less-than-and-greater-than-directive). This directive contains either `regexp` or `exclude` directive. ### regexp ([]RegexpSection, optional) {#and-directive-regexp} diff --git a/content/docs/configuration/plugins/filters/tagnormaliser.md b/content/docs/configuration/plugins/filters/tagnormaliser.md index f9d67d19e..bd8ab5858 100644 --- a/content/docs/configuration/plugins/filters/tagnormaliser.md +++ b/content/docs/configuration/plugins/filters/tagnormaliser.md @@ -4,9 +4,7 @@ weight: 200 generated_file: true --- -# Fluentd Plugin to re-tag based on log metadata -## Overview - More info at https://github.com/kube-logging/fluent-plugin-tag-normaliser +Fluentd Plugin to re-tag based on log metadata. More info at https://github.com/kube-logging/fluent-plugin-tag-normaliser Available kubernetes metadata diff --git a/content/docs/configuration/plugins/outputs/elasticsearch.md b/content/docs/configuration/plugins/outputs/elasticsearch.md index bf4287188..535d766b5 100644 --- a/content/docs/configuration/plugins/outputs/elasticsearch.md +++ b/content/docs/configuration/plugins/outputs/elasticsearch.md @@ -578,3 +578,4 @@ Default: - If set to true, the output uses the [legacy index template format](https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-templates-v1.html). Otherwise, it uses the [composable index template](https://www.elastic.co/guide/en/elasticsearch/reference/7.13/index-templates.html) format. Default: true + diff --git a/content/docs/configuration/plugins/outputs/gelf.md b/content/docs/configuration/plugins/outputs/gelf.md index 272d7122f..f91ef752d 100644 --- a/content/docs/configuration/plugins/outputs/gelf.md +++ b/content/docs/configuration/plugins/outputs/gelf.md @@ -42,7 +42,6 @@ TLS Options - for options see https://github.com/graylog-labs/gelf-rb/blob/7291 Default: {} - ## Example `GELF` output configurations ```yaml apiVersion: logging.banzaicloud.io/v1beta1 diff --git a/content/docs/configuration/plugins/outputs/sqs.md b/content/docs/configuration/plugins/outputs/sqs.md index 0020a471e..9f169ce1b 100644 --- a/content/docs/configuration/plugins/outputs/sqs.md +++ b/content/docs/configuration/plugins/outputs/sqs.md @@ -84,7 +84,6 @@ The threshold for chunk flush performance check. Parameter type is float, not ti Default: - - ## Example `SQS` output configurations ```yaml apiVersion: logging.banzaicloud.io/v1beta1 diff --git a/content/docs/configuration/plugins/outputs/sumologic.md b/content/docs/configuration/plugins/outputs/sumologic.md index ab5b3f383..1c019959b 100644 --- a/content/docs/configuration/plugins/outputs/sumologic.md +++ b/content/docs/configuration/plugins/outputs/sumologic.md @@ -9,8 +9,9 @@ generated_file: true This plugin has been designed to output logs or metrics to SumoLogic via a HTTP collector endpoint More info at https://github.com/SumoLogic/fluentd-output-sumologic - Example secret for HTTP input URL - ``` +Example secret for HTTP input URL + +``` export URL='https://endpoint1.collection.eu.sumologic.com/receiver/v1/http/.......' kubectl create secret generic sumo-output --from-literal "endpoint=$URL" ``` diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/auth.md b/content/docs/configuration/plugins/syslog-ng-outputs/auth.md new file mode 100644 index 000000000..ca81c1a4d --- /dev/null +++ b/content/docs/configuration/plugins/syslog-ng-outputs/auth.md @@ -0,0 +1,50 @@ +--- +title: Authentication for syslog-ng outputs +weight: 200 +generated_file: true +--- + +## Overview +GRPC-based outputs use this configuration instead of the simple `tls` field found at most HTTP based destinations. For details, see the documentation of a related syslog-ng destination, for example, [Grafana Loki](https://axoflow.com/docs/axosyslog-core/chapter-destinations/destination-loki/#auth). + +## Configuration +## Auth + +### alts (*ALTS, optional) {#auth-alts} + +Application Layer Transport Security (ALTS) is a simple to use authentication, only available within Google’s infrastructure. + +Default: - + +### adc (*ADC, optional) {#auth-adc} + +Application Default Credentials (ADC). + +Default: - + +### insecure (*Insecure, optional) {#auth-insecure} + +This is the default method, authentication is disabled (`auth(insecure())`). + +Default: - + +### tls (*TLS, optional) {#auth-tls} + +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://axoflow.com/docs/axosyslog-core/chapter-encrypted-transport-tls/tlsoptions). + +Default: - + + +## ADC + + +## Insecure + + +## ALTS + +### target-service-accounts ([]string, optional) {#alts-target-service-accounts} + +Default: - + + diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/disk_buffer.md b/content/docs/configuration/plugins/syslog-ng-outputs/disk_buffer.md index 2fac0f3bc..aaad4794e 100644 --- a/content/docs/configuration/plugins/syslog-ng-outputs/disk_buffer.md +++ b/content/docs/configuration/plugins/syslog-ng-outputs/disk_buffer.md @@ -4,8 +4,6 @@ weight: 200 generated_file: true --- -## DiskBuffer - The parameters of the syslog-ng disk buffer. Using a disk buffer on the output helps avoid message loss in case of a system failure on the destination side. For details on how [syslog-ng disk buffers work, see the documentation of the AxoSyslog syslog-ng distribution](https://axoflow.com/docs/axosyslog-core/chapter-routing-filters/concepts-diskbuffer/). diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/elasticsearch.md b/content/docs/configuration/plugins/syslog-ng-outputs/elasticsearch.md index 3fbf6451d..26d5e3697 100644 --- a/content/docs/configuration/plugins/syslog-ng-outputs/elasticsearch.md +++ b/content/docs/configuration/plugins/syslog-ng-outputs/elasticsearch.md @@ -8,6 +8,26 @@ generated_file: true Based on the [ElasticSearch destination of AxoSyslog core](https://axoflow.com/docs/axosyslog-core/chapter-destinations/configuring-destinations-elasticsearch-http/). +## Example + +{{< highlight yaml >}} +apiVersion: logging.banzaicloud.io/v1beta1 +kind: SyslogNGOutput +metadata: + name: elasticsearch +spec: + elasticsearch: + url: "https://elastic-search-endpoint:9200/_bulk" + index: "indexname" + type: "" + user: "username" + password: + valueFrom: + secretKeyRef: + name: elastic + key: password +{{}} + ## Configuration ### (HTTPOutput, required) {#elasticsearchoutput-} @@ -22,7 +42,9 @@ Default: - ### type (*string, optional) {#elasticsearchoutput-type} -The document type associated with the operation. Elasticsearch indices now support a single document type: `_doc` +The document type associated with the operation. Elasticsearch indices now support a single document type: `_doc` + +Default: - ### custom_id (string, optional) {#elasticsearchoutput-custom_id} diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/file.md b/content/docs/configuration/plugins/syslog-ng-outputs/file.md index c3f49dabd..3ea50b65d 100644 --- a/content/docs/configuration/plugins/syslog-ng-outputs/file.md +++ b/content/docs/configuration/plugins/syslog-ng-outputs/file.md @@ -6,15 +6,17 @@ generated_file: true The `file` output stores log records in a plain text file. -```yaml +{{< highlight yaml >}} spec: file: path: /mnt/archive/logs/${YEAR}/${MONTH}/${DAY}/app.log create_dirs: true -``` +{{}} For details on the available options of the output, see the [documentation of the AxoSyslog syslog-ng distribution](https://axoflow.com/docs/axosyslog-core/chapter-destinations/configuring-destinations-file/). +For available macros like `${YEAR}/${MONTH}/${DAY}` see [documentation of the AxoSyslog syslog-ng distribution](https://axoflow.com/docs/axosyslog-core/chapter-manipulating-messages/customizing-message-format/reference-macros/). + ## Configuration ### path (string, required) {#fileoutput-path} diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/http.md b/content/docs/configuration/plugins/syslog-ng-outputs/http.md index 933165eec..6a603d2a7 100644 --- a/content/docs/configuration/plugins/syslog-ng-outputs/http.md +++ b/content/docs/configuration/plugins/syslog-ng-outputs/http.md @@ -4,9 +4,58 @@ weight: 200 generated_file: true --- -## Overview +Sends messages over HTTP. For details on the available options of the output, see the [documentation of the AxoSyslog syslog-ng distribution](https://axoflow.com/docs/axosyslog-core/chapter-destinations/configuring-destinations-http-nonjava/). + +## Example + +A simple example sending logs over HTTP to a fluentbit HTTP endpoint: + +{{< highlight yaml >}} +kind: SyslogNGOutput +apiVersion: logging.banzaicloud.io/v1beta1 +metadata: + name: http +spec: + http: + #URL of the ingest endpoint + url: http://fluentbit-endpoint:8080/tag + method: POST + headers: + - "Content-type: application/json" +{{}} + +A more complex example to demonstrate sending logs to OpenObserve +{{< highlight yaml >}} +kind: SyslogNGOutput +apiVersion: logging.banzaicloud.io/v1beta1 +metadata: + name: openobserve +spec: + http: + #URL of the ingest endpoint + url: https://openobserve-endpoint/api/default/log-generator/_json + user: "username" + password: + valueFrom: + secretKeyRef: + name: openobserve + key: password + method: POST + # Parameters for sending logs in batches + batch-lines: 5000 + batch-bytes: 4096 + batch-timeout: 300 + headers: + - "Connection: keep-alive" + # Disable TLS peer verification for demo + tls: + peer_verify: "no" + body-prefix: "[" + body-suffix: "]" + delimiter: "," + body: "${MESSAGE}" +{{}} -For details on the available options of the output, see the [documentation of the AxoSyslog syslog-ng distribution](https://axoflow.com/docs/axosyslog-core/chapter-destinations/configuring-destinations-http-nonjava/). ## Configuration diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/logscale.md b/content/docs/configuration/plugins/syslog-ng-outputs/logscale.md index 6ff1fdf34..9caba7233 100644 --- a/content/docs/configuration/plugins/syslog-ng-outputs/logscale.md +++ b/content/docs/configuration/plugins/syslog-ng-outputs/logscale.md @@ -4,9 +4,32 @@ weight: 200 generated_file: true --- -Based on the [LogScale destination of AxoSyslog core](https://axoflow.com/docs/axosyslog-core/chapter-destinations/crowdstrike-falcon/). - -## Configuration +Based on the [LogScale destination of AxoSyslog core](https://axoflow.com/docs/axosyslog-core/chapter-destinations/crowdstrike-falcon/). Sends log records over HTTP to Falcon's LogScale. + +## Example + +{{< highlight yaml >}} +apiVersion: logging.banzaicloud.io/v1beta1 +kind: SyslogNGOutput +metadata: + name: test-logscale + namespace: logging +spec: + logscale: + token: + valueFrom: + secretKeyRef: + key: token + name: logscale-token + timezone: "UTC" + batch_lines: 1000 + disk_buffer: + disk_buf_size: 512000000 + dir: /buffers + reliable: true +{{}} + +## LogScaleOutput ### url (*secret.Secret, optional) {#logscaleoutput-url} diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/loki.md b/content/docs/configuration/plugins/syslog-ng-outputs/loki.md index 152d6462b..04cccb0cc 100644 --- a/content/docs/configuration/plugins/syslog-ng-outputs/loki.md +++ b/content/docs/configuration/plugins/syslog-ng-outputs/loki.md @@ -6,7 +6,7 @@ generated_file: true Sends messages to Grafana Loki over gRPC, based on the [Loki destination of AxoSyslog Core](https://axoflow.com/docs/axosyslog-core/chapter-destinations/syslog-ng-with-loki/). -For example: +## Example {{< highlight yaml >}} apiVersion: logging.banzaicloud.io/v1beta1 @@ -16,14 +16,21 @@ metadata: spec: loki: url: "loki.loki:8000" + batch-lines: 2000 + batch-timeout: 10 + workers: 3 + log-fifo-size: 1000 labels: "app": "$PROGRAM" "host": "$HOST" - workers: 16 - batch-timeout: 10000 - batch-lines: 1000 + timestamp: "msg" + template: "$ISODATE $HOST $MSGHDR$MSG" + auth: + insecure: {} {{< /highlight >}} +For available macros like `$PROGRAM` and `$HOST` see https://axoflow.com/docs/axosyslog-core/chapter-manipulating-messages/customizing-message-format/reference-macros/ + ## Configuration ### labels (filter.ArrowMap, optional) {#lokioutput-labels} @@ -34,7 +41,7 @@ Default: - ### url (string, optional) {#lokioutput-url} -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` +Specifies the hostname or IP address and optionally the port number of the service that can receive log data via gRPC. Use a colon (:) after the address to specify the port number of the server. For example: `grpc://127.0.0.1:8000` Default: - diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/mongodb.md b/content/docs/configuration/plugins/syslog-ng-outputs/mongodb.md index 0fdf212ff..74054d152 100644 --- a/content/docs/configuration/plugins/syslog-ng-outputs/mongodb.md +++ b/content/docs/configuration/plugins/syslog-ng-outputs/mongodb.md @@ -17,7 +17,7 @@ metadata: spec: mongodb: collection: syslog - uri: mongodb://127.0.0.1:27017/syslog?wtimeoutMS=60000&socketTimeoutMS=60000&connectTimeoutMS=60000 + uri: "mongodb://mongodb-endpoint/syslog?wtimeoutMS=60000&socketTimeoutMS=60000&connectTimeoutMS=60000" value_pairs: scope("selected-macros" "nv-pairs") {{}} @@ -29,12 +29,6 @@ The name of the MongoDB collection where the log messages are stored (collection Default: - -### compaction (bool, required) {#mongodb-compaction} - -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. - -Default: - - ### dir (string, optional) {#mongodb-dir} Defines the folder where the disk-buffer files are stored. @@ -47,11 +41,11 @@ This option enables putting outgoing messages into the disk buffer of the destin Default: false -### uri (string, optional) {#mongodb-uri} +### uri (*secret.Secret, optional) {#mongodb-uri} -Defines the folder where the disk-buffer files are stored. +Connection string used for authentication. See the [AxoSyslog Core documentation](https://axoflow.com/docs/axosyslog-core/chapter-destinations/configuring-destinations-mongodb/reference-destination-mongodb/#mongodb-option-uri) -Default: "mongodb://127.0.0.1:27017/syslog?wtimeoutMS=60000&socketTimeoutMS=60000&connectTimeoutMS=60000" +Default: `mongodb://127.0.0.1:27017/syslog?wtimeoutMS=60000&socketTimeoutMS=60000&connectTimeoutMS=60000` ### value_pairs (ValuePairs, optional) {#mongodb-value_pairs} diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/s3.md b/content/docs/configuration/plugins/syslog-ng-outputs/s3.md index a310e7f73..2759d7030 100644 --- a/content/docs/configuration/plugins/syslog-ng-outputs/s3.md +++ b/content/docs/configuration/plugins/syslog-ng-outputs/s3.md @@ -1,33 +1,36 @@ --- -title: Sending messages from a local network to a S3 (compatible) server -linktitle: S3 +title: S3 weight: 200 generated_file: true --- +Sends messages from a local network to a S3 (compatible) server. More information at: https://axoflow.com/docs/axosyslog-core/chapter-destinations/destination-s3/ + ## Example {{< highlight yaml >}} apiVersion: logging.banzaicloud.io/v1beta1 kind: SyslogNGOutput metadata: -name: s3 + 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" + 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) {#s3output-url} diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/splunk_hec.md b/content/docs/configuration/plugins/syslog-ng-outputs/splunk_hec.md index 57d678005..5252b55d5 100644 --- a/content/docs/configuration/plugins/syslog-ng-outputs/splunk_hec.md +++ b/content/docs/configuration/plugins/syslog-ng-outputs/splunk_hec.md @@ -6,6 +6,23 @@ generated_file: true Based on the [Splunk destination of AxoSyslog core](https://axoflow.com/docs/axosyslog-core/chapter-destinations/syslog-ng-with-splunk/). +## Example + +{{< highlight yaml >}} +apiVersion: logging.banzaicloud.io/v1beta1 +kind: SyslogNGOutput +metadata: + name: splunkhec +spec: + splunk_hec_event: + url: "https://splunk-endpoint" + token: + valueFrom: + secretKeyRef: + name: splunk-hec + key: token +{{}} + ## Configuration ### (HTTPOutput, required) {#splunkhecoutput-} diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/syslog.md b/content/docs/configuration/plugins/syslog-ng-outputs/syslog.md index 8832b96e4..875d0ccda 100644 --- a/content/docs/configuration/plugins/syslog-ng-outputs/syslog.md +++ b/content/docs/configuration/plugins/syslog-ng-outputs/syslog.md @@ -4,29 +4,33 @@ weight: 200 generated_file: true --- -The `syslog` output sends log records over a socket using the Syslog protocol (RFC 5424). +The `syslog` output sends log records over a socket using the Syslog protocol (RFC 5424). Based on https://axoflow.com/docs/axosyslog-core/chapter-destinations/configuring-destinations-syslog/ {{< highlight yaml >}} - spec: - syslog: - host: 10.12.34.56 - transport: tls - tls: - ca_file: - mountFrom: - secretKeyRef: - name: tls-secret - key: ca.crt - cert_file: - mountFrom: - secretKeyRef: - name: tls-secret - key: tls.crt - key_file: - mountFrom: - secretKeyRef: - name: tls-secret - key: tls.key +kind: SyslogNGOutput +metadata: + name: test + namespace: default +spec: + syslog: + host: 10.12.34.56 + transport: tls + tls: + ca_file: + mountFrom: + secretKeyRef: + name: tls-secret + key: ca.crt + cert_file: + mountFrom: + secretKeyRef: + name: tls-secret + key: tls.crt + key_file: + mountFrom: + secretKeyRef: + name: tls-secret + key: tls.key {{}} The following example also configures disk-based buffering for the output. For details, see the [Syslog-ng DiskBuffer options](../disk_buffer/). @@ -70,6 +74,8 @@ spec: For details on the available options of the output, see the [documentation of the AxoSyslog syslog-ng distribution](https://axoflow.com/docs/axosyslog-core/chapter-destinations/configuring-destinations-syslog/). +## Configuration + ### host (string, required) {#syslogoutput-host} Address of the destination host