Skip to content

Commit dd3f138

Browse files
bburt-rhbburt-rh
authored
Merge pull request #55093 from libander/RHDEVDOCS-4448-snips
RHDEVDOCS-4448-Snippets
2 parents 8fe9b1f + 03fcd39 commit dd3f138

6 files changed

+189
-0
lines changed

‎modules/logging-feature-reference-5.6.adoc

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
// Module is included in the following assemblies:
2+
//
3+
:_content-type: REFERENCE
4+
[id="logging-5-6-collector-ref_{context}"]
5+
6+
= Collector features
7+
8+
include::snippets/logging-outputs-5.6-snip.adoc[]
9+
10+
.Log Sources
11+
[options="header"]
12+
|===============================================================
13+
| Feature | Fluentd | Vector
14+
| App container logs | ✓ | ✓
15+
| App-specific routing | ✓ | ✓
16+
| App-specific routing by namespace | ✓ | ✓
17+
| Infra container logs | ✓ | ✓
18+
| Infra journal logs | ✓ | ✓
19+
| Kube API audit logs | ✓ | ✓
20+
| OpenShift API audit logs | ✓ | ✓
21+
| Open Virtual Network (OVN) audit logs| ✓ | ✓
22+
|===============================================================
23+
24+
.Authorization and Authentication
25+
[options="header"]
26+
|=================================================================
27+
| Feature | Fluentd | Vector
28+
| Elasticsearch certificates | ✓ | ✓
29+
| Elasticsearch username / password | ✓ | ✓
30+
| Cloudwatch keys | ✓ | ✓
31+
| Cloudwatch STS | ✓ | ✓
32+
| Kafka certificates | ✓ | ✓
33+
| Kafka username / password | ✓ | ✓
34+
| Kafka SASL | ✓ | ✓
35+
| Loki bearer token | ✓ | ✓
36+
|=================================================================
37+
38+
.Normalizations and Transformations
39+
[options="header"]
40+
|============================================================================
41+
| Feature | Fluentd | Vector
42+
| Viaq data model - app | ✓ | ✓
43+
| Viaq data model - infra | ✓ | ✓
44+
| Viaq data model - infra(journal) | ✓ | ✓
45+
| Viaq data model - Linux audit | ✓ | ✓
46+
| Viaq data model - kube-apiserver audit | ✓ | ✓
47+
| Viaq data model - OpenShift API audit | ✓ | ✓
48+
| Viaq data model - OVN | ✓ | ✓
49+
| Loglevel Normalization | ✓ | ✓
50+
| JSON parsing | ✓ | ✓
51+
| Structured Index | ✓ | ✓
52+
| Multiline error detection | ✓ |
53+
| Multicontainer / split indices | ✓ | ✓
54+
| Flatten labels | ✓ | ✓
55+
| CLF static labels | ✓ | ✓
56+
|============================================================================
57+
58+
.Tuning
59+
[options="header"]
60+
|==========================================================
61+
| Feature | Fluentd | Vector
62+
| Fluentd readlinelimit | ✓ |
63+
| Fluentd buffer | ✓ |
64+
| - chunklimitsize | ✓ |
65+
| - totallimitsize | ✓ |
66+
| - overflowaction | ✓ |
67+
| - flushthreadcount | ✓ |
68+
| - flushmode | ✓ |
69+
| - flushinterval | ✓ |
70+
| - retrywait | ✓ |
71+
| - retrytype | ✓ |
72+
| - retrymaxinterval | ✓ |
73+
| - retrytimeout | ✓ |
74+
|==========================================================
75+
76+
.Visibility
77+
[options="header"]
78+
|=====================================================
79+
| Feature | Fluentd | Vector
80+
| Metrics | ✓ | ✓
81+
| Dashboard | ✓ | ✓
82+
| Alerts | ✓ |
83+
|=====================================================
84+
85+
.Miscellaneous
86+
[options="header"]
87+
|===========================================================
88+
| Feature | Fluentd | Vector
89+
| Global proxy support | ✓ | ✓
90+
| x86 support | ✓ | ✓
91+
| ARM support | ✓ | ✓
92+
| PowerPC support | ✓ | ✓
93+
| IBM Z support | ✓ | ✓
94+
| IPv6 support | ✓ | ✓
95+
| Log event buffering | ✓ |
96+
| Disconnected Cluster | ✓ | ✓
97+
|===========================================================
98+
99+
100+
[role="_additional-resources"]
101+
.Additional resources
102+
* link:https://vector.dev/docs/about/what-is-vector/[Vector Documentation]

‎snippets/logging-elastic-dep-snip.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// Text snippet included in the following assemblies:
2+
//
3+
//
4+
// Text snippet included in the following modules:
5+
//
6+
//
7+
:_content-type: SNIPPET
8+
9+
[NOTE]
10+
====
11+
As of logging version 5.4.3 the Elasticsearch Operator is deprecated and is planned to be removed in a future release. Red Hat will provide bug fixes and support for this feature during the current release lifecycle, but this feature will no longer receive enhancements and will be removed. As an alternative to using the Elasticsearch Operator to manage the default log storage, you can use the Loki Operator.
12+
====

‎snippets/logging-fluentd-dep-snip.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// Text snippet included in the following assemblies:
2+
//
3+
//
4+
// Text snippet included in the following modules:
5+
//
6+
//
7+
:_content-type: SNIPPET
8+
9+
[NOTE]
10+
====
11+
In Logging 5.6, Fluentd is deprecated and is planned to be removed in a future release. Red Hat will provide bug fixes and support for this feature during the current release lifecycle, but this feature will no longer receive enhancements and will be removed. As an alternative to Fluentd, you can use Vector instead.
12+
====

‎snippets/logging-outputs-5.5-snip.adoc

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// Text snippet included in the following assemblies:
2+
//
3+
//
4+
// Text snippet included in the following modules:
5+
//
6+
//
7+
:_content-type: SNIPPET
8+
9+
.Output Destinations
10+
[options="header"]
11+
|======
12+
|Feature|Protocol|Tested with|Fluentd|Vector
13+
|Cloudwatch|REST over HTTPS||✓|✓
14+
|Elasticearch||||
15+
| * v6||v6.8.1|✓|✓
16+
| * v7||v7.12.2|✓|✓
17+
| * v8||||✓
18+
|Google Cloud Logging||||✓
19+
20+
|Kafka|kafka 0.11|kafka 2.4.1 kafka 2.7.0 kafka 3|✓|✓
21+
22+
|Fluent Forward|fluentd forward v1|fluentd 1.14.6
23+
logstash 7.10.1|✓|
24+
25+
|Loki|REST over HTTP(S)|Loki 2.3.0 Loki 2.6.0|✓|✓
26+
|Syslog|RFC3164,RFC5424|rsyslog 8.39.0|✓|
27+
|======

‎snippets/logging-outputs-5.6-snip.adoc

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// Text snippet included in the following assemblies:
2+
//
3+
//
4+
// Text snippet included in the following modules:
5+
//
6+
//
7+
:_content-type: SNIPPET
8+
9+
[options="header"]
10+
|====================================================================================================
11+
| Output | Protocol | Tested with | Fluentd | Vector
12+
| Cloudwatch | REST over HTTP(S) | | ✓ | ✓
13+
| Elasticsearch v6 | | v6.8.1 | ✓ | ✓
14+
| Elasticsearch v7 | | v7.12.2, 7.17.7 | ✓ | ✓
15+
| Elasticsearch v8 | | v8.4.3 | | ✓
16+
| Fluent Forward | Fluentd forward v1 | Fluentd 1.14.6, Logstash 7.10.1 | ✓ |
17+
| Google Cloud Logging | | | | ✓
18+
| HTTP | HTTP 1.1 | Fluentd 1.14.6, Vector 0.21 | |
19+
| Kafka | Kafka 0.11 | Kafka 2.4.1, 2.7.0, 3.3.1 | ✓ | ✓
20+
| Loki | REST over HTTP(S) | Loki 2.3.0, 2.7 | ✓ | ✓
21+
| Splunk | HEC | v8.2.9, 9.0.0 | | ✓
22+
| Syslog | RFC3164, RFC5424 | Rsyslog 8.37.0-9.el7 | ✓ |
23+
|====================================================================================================

‎snippets/logging-restructure-snip.adoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
// Text snippet included in the following assemblies:
2+
//
3+
//
4+
// Text snippet included in the following modules:
5+
//
6+
//
7+
:_content-type: SNIPPET
8+
9+
10+
[NOTE]
11+
====
12+
For Logging 5.5 and higher, documentation is organized by version.
13+
====

0 commit comments

Comments
 (0)