Skip to content

Commit 63095fa

Browse files
Robert FeketeRobert Fekete
authored andcommitted
Sync with 4.6 generated docs
1 parent c4cf8da commit 63095fa

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+1275
-831
lines changed
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: FluentdConfig
3+
weight: 200
4+
generated_file: true
5+
---
6+
7+
## FluentdConfig
8+
9+
### (metav1.TypeMeta, required) {#fluentdconfig-}
10+
11+
12+
### metadata (metav1.ObjectMeta, optional) {#fluentdconfig-metadata}
13+
14+
15+
### spec (FluentdSpec, optional) {#fluentdconfig-spec}
16+
17+
18+
### status (FluentdConfigStatus, optional) {#fluentdconfig-status}
19+
20+
21+
22+
## FluentdConfigStatus
23+
24+
### active (*bool, optional) {#fluentdconfigstatus-active}
25+
26+
27+
### logging (string, optional) {#fluentdconfigstatus-logging}
28+
29+
30+
### problems ([]string, optional) {#fluentdconfigstatus-problems}
31+
32+
33+
### problemsCount (int, optional) {#fluentdconfigstatus-problemscount}
34+
35+
36+
37+
## FluentdConfigList
38+
39+
### (metav1.TypeMeta, required) {#fluentdconfiglist-}
40+
41+
42+
### metadata (metav1.ListMeta, optional) {#fluentdconfiglist-metadata}
43+
44+
45+
### items ([]FluentdConfig, required) {#fluentdconfiglist-items}
46+
47+
48+
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: SyslogNGConfig
3+
weight: 200
4+
generated_file: true
5+
---
6+
7+
## SyslogNGConfig
8+
9+
### (metav1.TypeMeta, required) {#syslogngconfig-}
10+
11+
12+
### metadata (metav1.ObjectMeta, optional) {#syslogngconfig-metadata}
13+
14+
15+
### spec (SyslogNGSpec, optional) {#syslogngconfig-spec}
16+
17+
18+
### status (SyslogNGConfigStatus, optional) {#syslogngconfig-status}
19+
20+
21+
22+
## SyslogNGConfigStatus
23+
24+
### active (*bool, optional) {#syslogngconfigstatus-active}
25+
26+
27+
### logging (string, optional) {#syslogngconfigstatus-logging}
28+
29+
30+
### problems ([]string, optional) {#syslogngconfigstatus-problems}
31+
32+
33+
### problemsCount (int, optional) {#syslogngconfigstatus-problemscount}
34+
35+
36+
37+
## SyslogNGConfigList
38+
39+
### (metav1.TypeMeta, required) {#syslogngconfiglist-}
40+
41+
42+
### metadata (metav1.ListMeta, optional) {#syslogngconfiglist-metadata}
43+
44+
45+
### items ([]SyslogNGConfig, required) {#syslogngconfiglist-items}
46+
47+
48+

content/docs/configuration/crds/v1beta1/syslogng_types.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ Available in Logging operator version 4.5 and later. Create [custom log metrics
7272
## SourceDateParser
7373

7474

75+
7576
Available in Logging operator version 4.5 and later.
7677

7778
Parses date automatically from the timestamp registered by the container runtime.

content/docs/configuration/plugins/filters/concat.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The number of seconds after which the last received event log is flushed. If set
2323

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

26-
If true, keep partial_key in concatenated records
26+
If true, keep partial_key in concatenated records
2727

2828
Default: False
2929

@@ -95,9 +95,9 @@ The label name to handle events caused by timeout.
9595

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

98-
Use timestamp of first record when buffer is flushed.
98+
Use timestamp of first record when buffer is flushed.
9999

100-
Default: False
100+
Default: False
101101

102102
### use_partial_cri_logtag (bool, optional) {#concat-use_partial_cri_logtag}
103103

@@ -111,6 +111,7 @@ Use partial metadata to concatenate multiple records
111111

112112

113113

114+
114115
## Example `Concat` filter configurations
115116

116117
{{< highlight yaml >}}

content/docs/configuration/plugins/filters/dedot.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,17 @@ generated_file: true
1515

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

18-
Default: false
18+
Default: false
1919

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

22-
Separator
22+
Separator
2323

2424
Default: _
2525

2626

2727

28+
2829
## Example `Dedot` filter configurations
2930

3031
{{< highlight yaml >}}

content/docs/configuration/plugins/filters/detect_exceptions.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ generated_file: true
99

1010
This filter plugin consumes a log stream of JSON objects which contain single-line log messages. If a consecutive sequence of log messages form an exception stack trace, they forwarded as a single, combined JSON object. Otherwise, the input log data is forwarded as is. More info at https://github.com/GoogleCloudPlatform/fluent-plugin-detect-exceptions
1111

12-
> Note: As Tag management is not supported yet, this Plugin is **mutually exclusive** with [Tag normaliser](../tagnormaliser)
12+
> Note: As Tag management is not supported yet, this Plugin is **mutually exclusive** with [Tag normaliser](../tagnormaliser)
1313
1414
## Example output configurations
1515

@@ -26,57 +26,58 @@ filters:
2626
2727
### force_line_breaks (bool, optional) {#detectexceptions-force_line_breaks}
2828
29-
Force line breaks between each lines when comibining exception stacks.
29+
Force line breaks between each lines when combining exception stacks.
3030
31-
Default: false
31+
Default: false
3232
3333
### languages ([]string, optional) {#detectexceptions-languages}
3434
35-
Programming languages for which to detect exceptions.
35+
Programming languages for which to detect exceptions.
3636
3737
Default: `[]`
3838

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

41-
Tag used in match directive.
41+
Tag used in match directive.
4242

4343
Default: `kubernetes.**`
4444

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

47-
Maximum number of bytes to flush (0 means no limit)
47+
Maximum number of bytes to flush (0 means no limit)
4848

49-
Default: 0
49+
Default: 0
5050

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

53-
Maximum number of lines to flush (0 means no limit)
53+
Maximum number of lines to flush (0 means no limit)
5454

55-
Default: 1000
55+
Default: 1000
5656

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

59-
The field which contains the raw message text in the input JSON data.
59+
The field which contains the raw message text in the input JSON data.
6060

61-
Default: ""
61+
Default: ""
6262

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

65-
The interval of flushing the buffer for multiline format.
65+
The interval of flushing the buffer for multiline format.
6666

67-
Default: nil
67+
Default: nil
6868

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

71-
The prefix to be removed from the input tag when outputting a record.
71+
The prefix to be removed from the input tag when outputting a record.
7272

73-
Default: kubernetes
73+
Default: kubernetes
7474

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

77-
Separate log streams by this field in the input JSON data.
77+
Separate log streams by this field in the input JSON data.
78+
79+
Default: ""
7880

79-
Default: ""
8081

8182

8283

content/docs/configuration/plugins/filters/enhance_k8s.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4,82 +4,81 @@ weight: 200
44
generated_file: true
55
---
66

7-
# [Enhance K8s Metadata](https://github.com/SumoLogic/sumologic-kubernetes-collection/tree/main/fluent-plugin-enhance-k8s-metadata)
8-
## Overview
9-
Fluentd Filter plugin to fetch several metadata for a Pod
7+
## [Enhance K8s Metadata](https://github.com/SumoLogic/sumologic-kubernetes-fluentd/tree/main/fluent-plugin-enhance-k8s-metadata)
8+
Fluentd Filter plugin to fetch several metadata for a Pod
109

1110
## Configuration
1211
## EnhanceK8s
1312

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

16-
Kubernetes resources api groups
15+
Kubernetes resources api groups
1716

1817
Default: `["apps/v1", "extensions/v1beta1"]`
1918

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

22-
Bearer token path
21+
Bearer token path
2322

24-
Default: nil
23+
Default: nil
2524

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

28-
Kubernetes API CA file
27+
Kubernetes API CA file
2928

30-
Default: nil
29+
Default: nil
3130

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

34-
Cache refresh
33+
Cache refresh
3534

36-
Default: 60*60
35+
Default: 60*60
3736

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

40-
Cache refresh variation
39+
Cache refresh variation
4140

42-
Default: 60*15
41+
Default: 60*15
4342

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

46-
Cache size
45+
Cache size
4746

48-
Default: 1000
47+
Default: 1000
4948

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

52-
Cache TTL
51+
Cache TTL
5352

54-
Default: 60*60*2
53+
Default: 60*60*2
5554

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

58-
Kubernetes API Client certificate
57+
Kubernetes API Client certificate
5958

60-
Default: nil
59+
Default: nil
6160

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

64-
// Kubernetes API Client certificate key
63+
Kubernetes API Client certificate key
6564

66-
Default: nil
65+
Default: nil
6766

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

70-
Kubernetes core API version (for different Kubernetes versions)
69+
Kubernetes core API version (for different Kubernetes versions)
7170

72-
Default: ['v1']
71+
Default: ['v1']
7372

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

76-
Sumologic data type
75+
Sumo Logic data type
7776

78-
Default: metrics
77+
Default: metrics
7978

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

82-
parameters for read/write record
81+
parameters for read/write record
8382

8483
Default: `['$.namespace']`
8584

@@ -89,27 +88,28 @@ Default: `['$.pod','$.pod_name']`
8988

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

92-
Kubernetes API URL
91+
Kubernetes API URL
9392

94-
Default: nil
93+
Default: nil
9594

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

9897
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
9998

100-
Default: false
99+
Default: false
101100

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

104-
Service account directory
103+
Service account directory
105104

106-
Default: /var/run/secrets/kubernetes.io/serviceaccount
105+
Default: /var/run/secrets/kubernetes.io/serviceaccount
107106

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

110-
Verify SSL
109+
Verify SSL
110+
111+
Default: true
111112

112-
Default: true
113113

114114

115115

0 commit comments

Comments
 (0)