Skip to content

RHDEVDOCS-2614 Define ClusterLogForwarder compatibility matrix #29573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ahardin-rh merged 1 commit into from
Feb 24, 2021
Merged

RHDEVDOCS-2614 Define ClusterLogForwarder compatibility matrix #29573

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions logging/cluster-logging-external.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ You cannot use the config map methods and the Log Forwarding API in the same clu
// assemblies.

include::modules/cluster-logging-collector-log-forwarding-about.adoc[leveloffset=+1]
include::modules/cluster-logging-collector-log-forward-es.adoc[leveloffset=+2]
include::modules/cluster-logging-collector-log-forward-fluentd.adoc[leveloffset=+2]
include::modules/cluster-logging-collector-log-forward-syslog.adoc[leveloffset=+2]
include::modules/cluster-logging-collector-log-forward-kafka.adoc[leveloffset=+2]
include::modules/cluster-logging-collector-log-forward-project.adoc[leveloffset=+2]
include::modules/cluster-logging-collector-legacy-fluentd.adoc[leveloffset=+2]
include::modules/cluster-logging-collector-legacy-syslog.adoc[leveloffset=+2]
// modules/cluster-logging-collector-log-forward-update.adoc[leveloffset=+2]
include::modules/cluster-logging-collector-log-forwarding-supported-plugins.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]
include::modules/cluster-logging-collector-log-forward-syslog.adoc[leveloffset=+1]
include::modules/cluster-logging-collector-log-forward-kafka.adoc[leveloffset=+1]
include::modules/cluster-logging-collector-log-forward-project.adoc[leveloffset=+1]
include::modules/cluster-logging-collector-legacy-fluentd.adoc[leveloffset=+1]
include::modules/cluster-logging-collector-legacy-syslog.adoc[leveloffset=+1]
34 changes: 34 additions & 0 deletions modules/cluster-logging-collector-log-forwarding-supported-plugins.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// Module included in the following assemblies:
//
// logging/cluster-logging-external.adoc

[id="cluster-logging-collector-log-forwarding-supported-plugins_{context}"]

= Supported log data output types

[role="_abstract"]
Copy link
Copy Markdown
Contributor

@vikram-redhat vikram-redhat Mar 3, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @rolfedh - we are not using these Pv2 tags at the moment. Do you mind removing this as a follow up PR?

See my note in Slack.

Copy link
Copy Markdown
Contributor Author

@rolfedh rolfedh Mar 3, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vikram-redhat Sure - no problem. I'll fix it today. This particular case comes from the redhat-documentation/modular-docs templates. We should have a tete-a-tete with Emily Murphy to avoid expanding issues like this.

Copy link
Copy Markdown
Contributor Author

@rolfedh rolfedh Mar 4, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vikram-redhat I've removed [role="_abstract"] in #30088, which is WIP. Please note that [role= also appears in the following locations:

Results for "[role=" in "*.adoc"

/home/rdlugyhe/openshift-docs/migration/migrating_3_4/migrating-applications-with-cam-3-4.adoc:
  62:  [role="_additional-resources"]


/home/rdlugyhe/openshift-docs/migration/migrating_3_4/troubleshooting-3-4.adoc:
  38:  [role="_additional-resources"]


/home/rdlugyhe/openshift-docs/migration/migrating_4_1_4/migrating-applications-with-cam-4-1-4.adoc:
  61:  [role="_additional-resources"]


/home/rdlugyhe/openshift-docs/migration/migrating_4_1_4/troubleshooting-4-1-4.adoc:
  37:  [role="_additional-resources"]


/home/rdlugyhe/openshift-docs/migration/migrating_4_2_4/migrating-applications-with-cam-4-2-4.adoc:
  61:  [role="_additional-resources"]


/home/rdlugyhe/openshift-docs/migration/migrating_4_2_4/troubleshooting-4-2-4.adoc:
  37:  [role="_additional-resources"]

Red Hat OpenShift Logging version 5.0 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

| fluentdForward | fluent forward v1 | fluentd 1.7.4

| elasticsearch | elasticsearch v? | Elasticsearch 6.8.1

| syslog | RFC-3164, RFC-5424 | rsyslog 8.37.0-9.el7

| kafka | kafka 0.11 | kafka 2.4.1

|====

// Note to tech writer, validate these items against the corresponding line of the test configuration file that Red Hat OpenShift Logging version 5.0 uses: https://github.com/openshift/origin-aggregated-logging/blob/release-5.0/fluentd/Gemfile.lock. 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 plug-in supports Kafka version 0.11.

[NOTE]
====
Previously, the syslog output supported only RFC-3164. The current syslog output adds support for RFC-5424.
====