Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions logging/cluster-logging-external.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,14 @@ include::modules/cluster-logging-collector-log-forwarding-supported-plugins-5-1.

include::modules/cluster-logging-collector-log-forwarding-supported-plugins-5-2.adoc[leveloffset=+1]

include::modules/cluster-logging-collector-log-forwarding-supported-plugins-5-3.adoc[leveloffset=+1]

include::modules/cluster-logging-collector-log-forwarding-supported-plugins-5-4.adoc[leveloffset=+1]

include::modules/cluster-logging-collector-log-forwarding-supported-plugins-5-5.adoc[leveloffset=+1]

include::modules/cluster-logging-collector-log-forwarding-supported-plugins-5-6.adoc[leveloffset=+1]

include::modules/cluster-logging-collector-log-forward-es.adoc[leveloffset=+1]

include::modules/cluster-logging-collector-log-forward-fluentd.adoc[leveloffset=+1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,3 @@ kafka 2.7.0
// This file is the authoritative source of information about which items and versions Red Hat tests and supports.
// According to this link:https://github.com/zendesk/ruby-kafka#compatibility[Zendesk compatibility list for ruby-kafka], the fluent-plugin-kafka plugin supports Kafka version 0.11.
// Logstash support is according to https://github.com/openshift/cluster-logging-operator/blob/master/test/functional/outputs/forward_to_logstash_test.go#L37

[NOTE]
====
Previously, the syslog output supported only RFC-3164. The current syslog output adds support for RFC-5424.
====
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
// Module included in the following assemblies:
//
// logging/cluster-logging-external.adoc

[id="cluster-logging-collector-log-forwarding-supported-plugins-5-3_{context}"]

= Supported log data output types in OpenShift Logging 5.3

Red Hat OpenShift Logging 5.3 provides the following output types and protocols for sending log data to target log collectors.

Red Hat tests each of the combinations shown in the following table. However, you should be able to send log data to a wider range target log collectors that ingest these protocols.

[options="header"]
|====
| Output types | Protocols | Tested with

| Amazon CloudWatch
| REST over HTTPS
| The current version of Amazon CloudWatch


| elasticsearch
| elasticsearch
a| Elasticsearch 7.10.1

| fluentdForward
| fluentd forward v1
a| fluentd 1.7.4

logstash 7.10.1

| Loki
| REST over HTTP and HTTPS
| Loki 2.2.1 deployed on OCP

| kafka
| kafka 0.11
a| kafka 2.7.0

| syslog
| RFC-3164, RFC-5424
| rsyslog-8.39.0

|====

// Note: validate these items against the corresponding line of the test configuration files that Red Hat OpenShift Logging uses:
//
// cloudwatch https://github.com/openshift/cluster-logging-operator/blob/release-5.3/test/functional/outputs/forward_to_cloudwatch_test.go#L18
// elasticsearch https://github.com/openshift/cluster-logging-operator/blob/release-5.3/test/functional/outputs/forward_to_elasticsearch_index_test.go#L17
// es fluentd https://github.com/ViaQ/logging-fluentd/blob/release-5.5/fluentd/Gemfile.lock#L55
// fluentd https://github.com/openshift/cluster-logging-operator/blob/release-5.3/Makefile#L23
// kafka https://github.com/openshift/cluster-logging-operator/blob/release-5.3/test/helpers/kafka/constants.go#L17
// kafka fluentd https://github.com/zendesk/ruby-kafka/tree/v1.4.0#compatibility
// logstash https://github.com/openshift/cluster-logging-operator/blob/release-5.3/test/functional/outputs/forward_to_logstash_test.go#L30
// loki https://github.com/openshift/cluster-logging-operator/blob/release-5.3/test/helpers/loki/receiver.go#L25
// syslog protocols https://github.com/openshift/cluster-logging-operator/tree/release-5.3/test/functional/outputs/syslog
// syslog version https://github.com/openshift/cluster-logging-operator/blob/release-5.3/test/framework/functional/output_syslog.go#L13
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
// Module included in the following assemblies:
//
// logging/cluster-logging-external.adoc

[id="cluster-logging-collector-log-forwarding-supported-plugins-5-4_{context}"]

= Supported log data output types in OpenShift Logging 5.4

Red Hat OpenShift Logging 5.4 provides the following output types and protocols for sending log data to target log collectors.

Red Hat tests each of the combinations shown in the following table. However, you should be able to send log data to a wider range target log collectors that ingest these protocols.

[options="header"]
|====
| Output types | Protocols | Tested with

| Amazon CloudWatch
| REST over HTTPS
| The current version of Amazon CloudWatch


| elasticsearch
| elasticsearch
a| Elasticsearch 7.10.1

| fluentdForward
| fluentd forward v1
a| fluentd 1.14.5

logstash 7.10.1

| Loki
| REST over HTTP and HTTPS
| Loki 2.2.1 deployed on OCP

| kafka
| kafka 0.11
a| kafka 2.7.0

| syslog
| RFC-3164, RFC-5424
| rsyslog-8.39.0

|====

// Note: validate these items against the corresponding line of the test configuration files that Red Hat OpenShift Logging uses:
//
// cloudwatch https://github.com/openshift/cluster-logging-operator/blob/release-5.4/test/functional/outputs/forward_to_cloudwatch_test.go#L18
// elasticsearch https://github.com/openshift/cluster-logging-operator/blob/release-5.4/test/functional/outputs/forward_to_elasticsearch_index_test.go#L17
// es fluentd https://github.com/ViaQ/logging-fluentd/blob/release-5.5/fluentd/Gemfile.lock#L55
// fluentd https://github.com/openshift/cluster-logging-operator/blob/release-5.4/Makefile#L23
// kafka https://github.com/openshift/cluster-logging-operator/blob/release-5.4/test/helpers/kafka/constants.go#L17
// kafka fluentd https://github.com/zendesk/ruby-kafka/tree/v1.4.0#compatibility
// logstash https://github.com/openshift/cluster-logging-operator/blob/release-5.4/test/functional/outputs/forward_to_logstash_test.go#L30
// loki https://github.com/openshift/cluster-logging-operator/blob/release-5.4/test/helpers/loki/receiver.go#L26
// syslog protocols https://github.com/openshift/cluster-logging-operator/tree/release-5.4/test/functional/outputs/syslog
// syslog version https://github.com/openshift/cluster-logging-operator/blob/release-5.4/test/framework/functional/output_syslog.go#L13
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
// Module included in the following assemblies:
//
// logging/cluster-logging-external.adoc

[id="cluster-logging-collector-log-forwarding-supported-plugins-5-5_{context}"]

= Supported log data output types in OpenShift Logging 5.5

Red Hat OpenShift Logging 5.5 provides the following output types and protocols for sending log data to target log collectors.

Red Hat tests each of the combinations shown in the following table. However, you should be able to send log data to a wider range target log collectors that ingest these protocols.

[options="header"]
|====
| Output types | Protocols | Tested with

| Amazon CloudWatch
| REST over HTTPS
| The current version of Amazon CloudWatch


| elasticsearch
| elasticsearch
a| Elasticsearch 7.10.1

| fluentdForward
| fluentd forward v1
a| fluentd 1.14.6

logstash 7.10.1

| Loki
| REST over HTTP and HTTPS
| Loki 2.5.0 deployed on OCP

| kafka
| kafka 0.11
a| kafka 2.7.0

| syslog
| RFC-3164, RFC-5424
| rsyslog-8.39.0

|====

// Note: validate these items against the corresponding line of the test configuration files that Red Hat OpenShift Logging uses:
//
// cloudwatch https://github.com/openshift/cluster-logging-operator/blob/release-5.5/test/functional/outputs/forward_to_cloudwatch_test.go#L18
// elasticsearch https://github.com/openshift/cluster-logging-operator/blob/release-5.5/test/functional/outputs/elasticsearch/forward_to_elasticsearch_index_test.go#L24
// elasticsearch https://github.com/openshift/cluster-logging-operator/blob/release-5.5/test/framework/functional/output_elasticsearch7.go#L13
// es fluentd https://github.com/ViaQ/logging-fluentd/blob/release-5.5/fluentd/Gemfile.lock#L55
// fluentd https://github.com/openshift/cluster-logging-operator/blob/release-5.5/Makefile#L24
// kafka https://github.com/openshift/cluster-logging-operator/blob/release-5.5/test/helpers/kafka/constants.go#L17
// kafka fluentd https://github.com/zendesk/ruby-kafka/tree/v1.4.0#compatibility
// logstash https://github.com/openshift/cluster-logging-operator/blob/release-5.5/test/functional/outputs/forward_to_logstash_test.go#L30
// loki https://github.com/openshift/cluster-logging-operator/blob/release-5.5/test/helpers/loki/receiver.go#L26
// syslog protocols https://github.com/openshift/cluster-logging-operator/tree/release-5.5/test/functional/outputs/syslog
// syslog version https://github.com/openshift/cluster-logging-operator/blob/release-5.5/test/framework/functional/output_syslog.go#L14
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
// Module included in the following assemblies:
//
// logging/cluster-logging-external.adoc

[id="cluster-logging-collector-log-forwarding-supported-plugins-5-6_{context}"]

= Supported log data output types in OpenShift Logging 5.6

Red Hat OpenShift Logging 5.6 provides the following output types and protocols for sending log data to target log collectors.

Red Hat tests each of the combinations shown in the following table. However, you should be able to send log data to a wider range target log collectors that ingest these protocols.

[options="header"]
|====
| Output types | Protocols | Tested with

| Amazon CloudWatch
| REST over HTTPS
| The current version of Amazon CloudWatch


| elasticsearch
| elasticsearch
a| Elasticsearch 6.8.23

Elasticsearch 7.10.1

Elasticsearch 8.6.1

| fluentdForward
| fluentd forward v1
a| fluentd 1.14.6

logstash 7.10.1

| Loki
| REST over HTTP and HTTPS
| Loki 2.5.0 deployed on OCP

| kafka
| kafka 0.11
a| kafka 2.7.0

| syslog
| RFC-3164, RFC-5424
| rsyslog-8.39.0

|====

[IMPORTANT]
====
Fluentd doesn't support Elasticsearch 8 as of 5.6.2.
Vector doesn't support fluentd/logstash/rsyslog before 5.7.0.
====

// Note: validate these items against the corresponding line of the test configuration files that Red Hat OpenShift Logging uses:
//
// cloudwatch https://github.com/openshift/cluster-logging-operator/blob/release-5.6/test/functional/outputs/cloudwatch/forward_to_cloudwatch_test.go#L13
// elasticsearch https://github.com/openshift/cluster-logging-operator/blob/release-5.6/test/framework/functional/output_elasticsearch.go#L16-L18
// es fluentd https://github.com/ViaQ/logging-fluentd/blob/release-5.6/fluentd/Gemfile.lock#L55
// fluentd https://github.com/openshift/cluster-logging-operator/blob/release-5.6/Makefile#L50
// kafka https://github.com/openshift/cluster-logging-operator/blob/release-5.6/test/helpers/kafka/constants.go#L17
// kafka fluentd https://github.com/zendesk/ruby-kafka/tree/v1.4.0#compatibility
// logstash https://github.com/openshift/cluster-logging-operator/blob/release-5.6/test/functional/outputs/forward_to_logstash_test.go#L30
// loki https://github.com/openshift/cluster-logging-operator/blob/release-5.6/test/helpers/loki/receiver.go#L27
// syslog protocols https://github.com/openshift/cluster-logging-operator/tree/release-5.6/test/functional/outputs/syslog
// syslog version https://github.com/openshift/cluster-logging-operator/blob/release-5.6/test/framework/functional/output_syslog.go#L14