Skip to content

Commit

Permalink
chore(docs): update formatting for followup
Browse files Browse the repository at this point in the history
Signed-off-by: Szilard Parrag <[email protected]>
  • Loading branch information
OverOrion committed Oct 6, 2023
1 parent 6e57690 commit adf4cd6
Show file tree
Hide file tree
Showing 47 changed files with 813 additions and 815 deletions.
120 changes: 60 additions & 60 deletions docs/configuration/crds/v1beta1/fluentbit_types.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/configuration/crds/v1beta1/logging_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,9 @@ Default: -

### clusterDomain (*string, optional) {#loggingspec-clusterdomain}

Cluster domain name to be used when templating URLs to services .
Cluster domain name to be used when templating URLs to services .

Default: "cluster.local."
Default: "cluster.local."

### controlNamespace (string, required) {#loggingspec-controlnamespace}

Expand Down
6 changes: 3 additions & 3 deletions docs/configuration/plugins/filters/concat.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@ Default: -

### use_first_timestamp (bool, optional) {#concat-use_first_timestamp}

Use timestamp of first record when buffer is flushed.
Use timestamp of first record when buffer is flushed.

Default: False
Default: False

### partial_key (string, optional) {#concat-partial_key}

Expand All @@ -85,7 +85,7 @@ Default: -

### keep_partial_key (bool, optional) {#concat-keep_partial_key}

If true, keep partial_key in concatenated records
If true, keep partial_key in concatenated records

Default: False

Expand Down
6 changes: 3 additions & 3 deletions docs/configuration/plugins/filters/dedot.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ generated_file: true

### de_dot_nested (bool, optional) {#dedotfilterconfig-de_dot_nested}

Will cause the plugin to recurse through nested structures (hashes and arrays), and remove dots in those key-names too.
Will cause the plugin to recurse through nested structures (hashes and arrays), and remove dots in those key-names too.

Default: false
Default: false

### de_dot_separator (string, optional) {#dedotfilterconfig-de_dot_separator}

Separator
Separator

Default: _

Expand Down
36 changes: 18 additions & 18 deletions docs/configuration/plugins/filters/detect_exceptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,57 +25,57 @@ generated_file: true

### message (string, optional) {#detectexceptions-message}

The field which contains the raw message text in the input JSON data.
The field which contains the raw message text in the input JSON data.

Default: ""
Default: ""

### remove_tag_prefix (string, optional) {#detectexceptions-remove_tag_prefix}

The prefix to be removed from the input tag when outputting a record.
The prefix to be removed from the input tag when outputting a record.

Default: kubernetes
Default: kubernetes

### multiline_flush_interval (string, optional) {#detectexceptions-multiline_flush_interval}

The interval of flushing the buffer for multiline format.
The interval of flushing the buffer for multiline format.

Default: nil
Default: nil

### languages ([]string, optional) {#detectexceptions-languages}

Programming languages for which to detect exceptions.
Programming languages for which to detect exceptions.

Default: []
Default: []

### max_lines (int, optional) {#detectexceptions-max_lines}

Maximum number of lines to flush (0 means no limit)
Maximum number of lines to flush (0 means no limit)

Default: 1000
Default: 1000

### max_bytes (int, optional) {#detectexceptions-max_bytes}

Maximum number of bytes to flush (0 means no limit)
Maximum number of bytes to flush (0 means no limit)

Default: 0
Default: 0

### stream (string, optional) {#detectexceptions-stream}

Separate log streams by this field in the input JSON data.
Separate log streams by this field in the input JSON data.

Default: ""
Default: ""

### force_line_breaks (bool, optional) {#detectexceptions-force_line_breaks}

Force line breaks between each lines when comibining exception stacks.
Force line breaks between each lines when comibining exception stacks.

Default: false
Default: false

### match_tag (string, optional) {#detectexceptions-match_tag}

Tag used in match directive.
Tag used in match directive.

Default: kubernetes.**
Default: kubernetes.**


## Example `Exception Detector` filter configurations
Expand Down
68 changes: 33 additions & 35 deletions docs/configuration/plugins/filters/enhance_k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,105 +13,103 @@ generated_file: true

### in_namespace_path ([]string, optional) {#enhancek8s-in_namespace_path}

parameters for read/write record
parameters for read/write record

Default: ['$.namespace']
Default: ['$.namespace']

### in_pod_path ([]string, optional) {#enhancek8s-in_pod_path}



Default: ['$.pod','$.pod_name']
Default: ['$.pod','$.pod_name']

### data_type (string, optional) {#enhancek8s-data_type}

Sumologic data type
Sumologic data type

Default: metrics
Default: metrics

### kubernetes_url (string, optional) {#enhancek8s-kubernetes_url}

Kubernetes API URL
Kubernetes API URL

Default: nil
Default: nil

### client_cert (secret.Secret, optional) {#enhancek8s-client_cert}

Kubernetes API Client certificate
Kubernetes API Client certificate

Default: nil
Default: nil

### client_key (secret.Secret, optional) {#enhancek8s-client_key}

// Kubernetes API Client certificate key
// Kubernetes API Client certificate key

Default: nil
Default: nil

### ca_file (secret.Secret, optional) {#enhancek8s-ca_file}

Kubernetes API CA file
Kubernetes API CA file

Default: nil
Default: nil

### secret_dir (string, optional) {#enhancek8s-secret_dir}

Service account directory
Service account directory

Default: /var/run/secrets/kubernetes.io/serviceaccount
Default: /var/run/secrets/kubernetes.io/serviceaccount

### bearer_token_file (string, optional) {#enhancek8s-bearer_token_file}

Bearer token path
Bearer token path

Default: nil
Default: nil

### verify_ssl (*bool, optional) {#enhancek8s-verify_ssl}

Verify SSL
Verify SSL

Default: true
Default: true

### core_api_versions ([]string, optional) {#enhancek8s-core_api_versions}

Kubernetes core API version (for different Kubernetes versions)
Kubernetes core API version (for different Kubernetes versions)

Default: ['v1']
Default: ['v1']

### api_groups ([]string, optional) {#enhancek8s-api_groups}

Kubernetes resources api groups
Kubernetes resources api groups

Default: ["apps/v1", "extensions/v1beta1"]
Default: ["apps/v1", "extensions/v1beta1"]

### ssl_partial_chain (*bool, optional) {#enhancek8s-ssl_partial_chain}

if `ca_file` is for an intermediate CA, or otherwise we do not have the root CA and want to trust the intermediate CA certs we do have, set this to `true` - this corresponds to the openssl s_client -partial_chain flag and X509_V_FLAG_PARTIAL_CHAIN
if `ca_file` is for an intermediate CA, or otherwise we do not have the root CA and want to trust the intermediate CA certs we do have, set this to `true` - this corresponds to the openssl s_client -partial_chain flag and X509_V_FLAG_PARTIAL_CHAIN

Default: false
Default: false

### cache_size (int, optional) {#enhancek8s-cache_size}

Cache size
Cache size

Default: 1000
Default: 1000

### cache_ttl (int, optional) {#enhancek8s-cache_ttl}

Cache TTL
Cache TTL

Default: 60*60*2
Default: 60*60*2

### cache_refresh (int, optional) {#enhancek8s-cache_refresh}

Cache refresh
Cache refresh

Default: 60*60
Default: 60*60

### cache_refresh_variation (int, optional) {#enhancek8s-cache_refresh_variation}

Cache refresh variation
Cache refresh variation

Default: 60*15
Default: 60*15


## Example `EnhanceK8s` filter configurations
Expand Down
4 changes: 2 additions & 2 deletions docs/configuration/plugins/filters/geoip.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ generated_file: true

### geoip_lookup_keys (string, optional) {#geoip-geoip_lookup_keys}

Specify one or more geoip lookup field which has ip address
Specify one or more geoip lookup field which has ip address

Default: host
Default: host

### geoip_database (string, optional) {#geoip-geoip_database}

Expand Down
8 changes: 4 additions & 4 deletions docs/configuration/plugins/filters/kube_events_timestamp.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ generated_file: true

### timestamp_fields ([]string, optional) {#kubeeventstimestampconfig-timestamp_fields}

Time field names in order of relevance
Time field names in order of relevance

Default: event.eventTime, event.lastTimestamp, event.firstTimestamp
Default: event.eventTime, event.lastTimestamp, event.firstTimestamp

### mapped_time_key (string, optional) {#kubeeventstimestampconfig-mapped_time_key}

Added time field name
Added time field name

Default: triggerts
Default: triggerts


## Example `Kubernetes Events Timestamp` filter configurations
Expand Down
40 changes: 20 additions & 20 deletions docs/configuration/plugins/filters/parser.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,27 +136,27 @@ Default: -

### time_type (string, optional) {#parse section-time_type}

Parse/format value according to this type available values: float, unixtime, string
Parse/format value according to this type available values: float, unixtime, string

Default: string
Default: string

### local_time (bool, optional) {#parse section-local_time}

Ff true, use local time. Otherwise, UTC is used. This is exclusive with utc.
Ff true, use local time. Otherwise, UTC is used. This is exclusive with utc.

Default: true
Default: true

### utc (bool, optional) {#parse section-utc}

If true, use UTC. Otherwise, local time is used. This is exclusive with localtime
If true, use UTC. Otherwise, local time is used. This is exclusive with localtime

Default: false
Default: false

### timezone (string, optional) {#parse section-timezone}

Use specified timezone. one can parse/format the time value in the specified timezone.
Use specified timezone. one can parse/format the time value in the specified timezone.

Default: nil
Default: nil

### format (string, optional) {#parse section-format}

Expand All @@ -172,9 +172,9 @@ Default: -

### delimiter (string, optional) {#parse section-delimiter}

Only available when using type: ltsv
Only available when using type: ltsv

Default: "\t"
Default: "\t"

### delimiter_pattern (string, optional) {#parse section-delimiter_pattern}

Expand All @@ -184,9 +184,9 @@ Default: -

### label_delimiter (string, optional) {#parse section-label_delimiter}

Only available when using type: ltsv
Only available when using type: ltsv

Default: ":"
Default: ":"

### multiline ([]string, optional) {#parse section-multiline}

Expand Down Expand Up @@ -295,27 +295,27 @@ Default: -

### time_type (string, optional) {#parse section (single)-time_type}

Parse/format value according to this type available values: float, unixtime, string
Parse/format value according to this type available values: float, unixtime, string

Default: string
Default: string

### local_time (bool, optional) {#parse section (single)-local_time}

Ff true, use local time. Otherwise, UTC is used. This is exclusive with utc.
Ff true, use local time. Otherwise, UTC is used. This is exclusive with utc.

Default: true
Default: true

### utc (bool, optional) {#parse section (single)-utc}

If true, use UTC. Otherwise, local time is used. This is exclusive with localtime
If true, use UTC. Otherwise, local time is used. This is exclusive with localtime

Default: false
Default: false

### timezone (string, optional) {#parse section (single)-timezone}

Use specified timezone. one can parse/format the time value in the specified timezone.
Use specified timezone. one can parse/format the time value in the specified timezone.

Default: nil
Default: nil

### format (string, optional) {#parse section (single)-format}

Expand Down
Loading

0 comments on commit adf4cd6

Please sign in to comment.