Skip to content

Commit

Permalink
Updates generated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fekete-robert committed Oct 17, 2023
1 parent f665bfd commit 1ec6de3
Show file tree
Hide file tree
Showing 21 changed files with 256 additions and 79 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ Override podSpec fields for the given daemonset

Default: -

### image (tailer.ImageSpec, optional) {#hosttailerspec-image}

Default: -


## HostTailerStatus

Expand Down
2 changes: 0 additions & 2 deletions content/docs/configuration/plugins/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Supported Plugins
generated_file: true
---

# Supported Plugins

For more information please click on the plugin name
<center>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/configuration/plugins/filters/concat.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
12 changes: 6 additions & 6 deletions content/docs/configuration/plugins/filters/grep.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Expand Down Expand Up @@ -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}

Expand Down Expand Up @@ -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}

Expand Down Expand Up @@ -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}

Expand Down
4 changes: 1 addition & 3 deletions content/docs/configuration/plugins/filters/tagnormaliser.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

1 change: 0 additions & 1 deletion content/docs/configuration/plugins/outputs/gelf.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion content/docs/configuration/plugins/outputs/sqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 3 additions & 2 deletions content/docs/configuration/plugins/outputs/sumologic.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
```
Expand Down
50 changes: 50 additions & 0 deletions content/docs/configuration/plugins/syslog-ng-outputs/auth.md
Original file line number Diff line number Diff line change
@@ -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: -


Original file line number Diff line number Diff line change
Expand Up @@ -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/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{{</ highlight >}}

## Configuration

### (HTTPOutput, required) {#elasticsearchoutput-}
Expand All @@ -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}

Expand Down
6 changes: 4 additions & 2 deletions content/docs/configuration/plugins/syslog-ng-outputs/file.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
{{</ highlight >}}

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}
Expand Down
53 changes: 51 additions & 2 deletions content/docs/configuration/plugins/syslog-ng-outputs/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
{{</ highlight >}}

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}"
{{</ highlight >}}

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

Expand Down
29 changes: 26 additions & 3 deletions content/docs/configuration/plugins/syslog-ng-outputs/logscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
{{</ highlight >}}

## LogScaleOutput

### url (*secret.Secret, optional) {#logscaleoutput-url}

Expand Down
17 changes: 12 additions & 5 deletions content/docs/configuration/plugins/syslog-ng-outputs/loki.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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}
Expand All @@ -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: -

Expand Down
Loading

0 comments on commit 1ec6de3

Please sign in to comment.