Merge pull request #42331 from libander/RHDEVDOCS-3258

RHDEVDOCS-3258 - Add Log Source

Author: JStickler

modules/cluster-logging-collector-log-forward-syslog.adoc

@@ -96,6 +96,51 @@ spec:
 $ oc create -f <file-name>.yaml
 ----
 
+[id=cluster-logging-collector-log-forward-examples-syslog-log-source]
+== Adding log source information to message output
+
+You can add `namespace_name`, `pod_name`, and `container_name` elements to the `message` field of the record by adding the `AddLogSource` field to your `ClusterLogForwarder` custom resource (CR).
+
+[source,yaml]
+----
+  spec:
+    outputs:
+    - name: syslogout
+      syslog:
+        addLogSource: true
+        facility: user
+        payloadKey: message
+        rfc: RFC3164
+        severity: debug
+        tag: mytag
+      type: syslog
+      url: tls://syslog-receiver.openshift-logging.svc:24224
+    pipelines:
+    - inputRefs:
+      - application
+      name: test-app
+      outputRefs:
+      - syslogout
+----
+
+[NOTE]
+====
+This configuration is compatible with both RFC3164 and RFC5424.
+====
+
+.Example syslog message output without `AddLogSource`
+[source, text]
+----
+<15>1 2020-11-15T17:06:14+00:00 fluentd-9hkb4 mytag - - -  {"msgcontent"=>"Message Contents", "timestamp"=>"2020-11-15 17:06:09", "tag_key"=>"rec_tag", "index"=>56}
+----
+
+.Example syslog message output with `AddLogSource`
+
+[source, text]
+----
+<15>1 2020-11-16T10:49:37+00:00 crc-j55b9-master-0 mytag - - -  namespace_name=clo-test-6327,pod_name=log-generator-ff9746c49-qxm7l,container_name=log-generator,message={"msgcontent":"My life is my message", "timestamp":"2020-11-16 10:49:36", "tag_key":"rec_tag", "index":76}
+----
+
 [id=cluster-logging-collector-log-forward-examples-syslog-parms]
 == Syslog parameters