Skip to content
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

Jump to bottom

OBSDOCS-768: Add docs for syslog input receiver #71744

Merged
merged 1 commit into from
Feb 20, 2024
Merged

OBSDOCS-768: Add docs for syslog input receiver #71744

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions logging/log_collection_forwarding/cluster-logging-collector.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,7 @@ include::modules/cluster-logging-collector-pod-location.adoc[leveloffset=+1]

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

//include::modules/log-collector-rsyslog-server.adoc[leveloffset=+1]
// uncomment for 5.9 release

include::modules/cluster-logging-collector-tuning.adoc[leveloffset=+1]
52 changes: 52 additions & 0 deletions modules/log-collector-rsyslog-server.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
// Module included in the following assemblies:
//
// * logging/log_collection_forwarding/cluster-logging-collector.adoc

:_mod-docs-content-type: PROCEDURE
[id="log-collector-rsyslog-server_{context}"]
= Configuring the collector to listen for connections as a syslog server

In {logging} version 5.9 and newer versions, you can configure your log collector to collect journal format infrastructure logs from outside the cluster by specifying `syslog` as a receiver input in the `ClusterLogForwarder` custom resource (CR). This enables you to use a single common log store for journal format infrastructure logs that are collected from both inside and outside of your {product-title} cluster.

.Prerequisites

* You have administrator permissions.
* You have installed the {oc-first}.
* You have installed the {clo}.
* You have created a `ClusterLogForwarder` CR.

.Procedure

. Modify the `ClusterLogForwarder` CR to add configuration for the `syslog` receiver input:
+
[source,yaml]
----
apiVersion: logging.openshift.io/v1beta1
kind: ClusterLogForwarder
metadata:
# ...
spec:
serviceAccountName: <service_account_name>
inputs:
- name: syslog-receiver # <1>
receiver:
type: syslog # <2>
syslog:
port: 10514 # <3>
pipelines: # <4>
- name: syslog-pipeline
inputRefs:
- syslog-receiver
# ...
----
<1> Specify a name for your input receiver.
<2> Specify the input receiver type as `syslog`.
<3> Optional: Specify the port that the input receiver listens on. This must be a value between `1024` and `65535`. The default value is `10514` if this is not specified.
<4> Configure a pipeline for your input receiver.

. Apply the changes to the `ClusterLogForwarder` CR by running the following command:
+
[source,terminal]
----
$ oc apply -f <filename>.yaml
----