summaryrefslogtreecommitdiffstats
path: root/roles/openshift_logging/README.md
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2017-09-28 09:45:04 -0700
committerGitHub <noreply@github.com>2017-09-28 09:45:04 -0700
commite3d5519c6d68b9aa162a58e1a897b6e4f6b0eea1 (patch)
treef49b4006ea35837066c358a2d41053ec132ae7f0 /roles/openshift_logging/README.md
parent4c1283b13e32d91f14a10ccb45c9d98a90a64c71 (diff)
parent680016550bfd93fd8adb48ebd34b8799babb4ebc (diff)
downloadopenshift-e3d5519c6d68b9aa162a58e1a897b6e4f6b0eea1.tar.gz
openshift-e3d5519c6d68b9aa162a58e1a897b6e4f6b0eea1.tar.bz2
openshift-e3d5519c6d68b9aa162a58e1a897b6e4f6b0eea1.tar.xz
openshift-e3d5519c6d68b9aa162a58e1a897b6e4f6b0eea1.zip
Merge pull request #5531 from sqtran/remote-syslog-configs
Automatic merge from submit-queue. Added new variables for logging role for remote-syslog plugin This commit adds a few new parameters useful for the fluent-plugin-remote-syslog work. These won't be useful until https://github.com/openshift/origin-aggregated-logging/pull/679 is merged into the logging project first.
Diffstat (limited to 'roles/openshift_logging/README.md')
-rw-r--r--roles/openshift_logging/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/roles/openshift_logging/README.md b/roles/openshift_logging/README.md
index 9386da8c2..45477f60d 100644
--- a/roles/openshift_logging/README.md
+++ b/roles/openshift_logging/README.md
@@ -199,3 +199,26 @@ Elasticsearch OPS too, if using an OPS cluster:
Defaults to 'logging-mux'.
- `openshift_logging_mux_file_buffer_storage_group`: The storage group used for Mux.
Defaults to '65534'.
+
+### remote syslog forwarding
+`openshift_logging_fluentd_remote_syslog`: Set `true` to enable remote syslog forwarding, defaults to `false`
+`openshift_logging_fluentd_remote_syslog_host`: Required, hostname or IP of remote syslog server
+`openshift_logging_fluentd_remote_syslog_port`: Port of remote syslog server, defaults to `514`
+`openshift_logging_fluentd_remote_syslog_severity`: Syslog severity level, defaults to `debug`
+`openshift_logging_fluentd_remote_syslog_facility`: Syslog facility, defaults to `local0`
+`openshift_logging_fluentd_remote_syslog_remove_tag_prefix`: Remove the prefix from the tag, defaults to `''` (empty)
+`openshift_logging_fluentd_remote_syslog_tag_key`: If string specified, use this field from the record to set the key field on the syslog message
+`openshift_logging_fluentd_remote_syslog_use_record`: Set `true` to use the severity and facility from the record, defaults to `false`
+`openshift_logging_fluentd_remote_syslog_payload_key`: If string is specified, use this field from the record as the payload on the syslog message
+
+The corresponding openshift_logging_mux_ parameters are below.
+
+`openshift_logging_mux_remote_syslog`: Set `true` to enable remote syslog forwarding, defaults to `false`
+`openshift_logging_mux_remote_syslog_host`: Required, hostname or IP of remote syslog server
+`openshift_logging_mux_remote_syslog_port`: Port of remote syslog server, defaults to `514`
+`openshift_logging_mux_remote_syslog_severity`: Syslog severity level, defaults to `debug`
+`openshift_logging_mux_remote_syslog_facility`: Syslog facility, defaults to `local0`
+`openshift_logging_mux_remote_syslog_remove_tag_prefix`: Remove the prefix from the tag, defaults to `''` (empty)
+`openshift_logging_mux_remote_syslog_tag_key`: If string specified, use this field from the record to set the key field on the syslog message
+`openshift_logging_mux_remote_syslog_use_record`: Set `true` to use the severity and facility from the record, defaults to `false`
+`openshift_logging_mux_remote_syslog_payload_key`: If string is specified, use this field from the record as the payload on the syslog message