From 7ba08e5bf6eb2b37ec0a79785b64b456eba4b59f Mon Sep 17 00:00:00 2001
From: Qi Luo <qiluo-msft@users.noreply.github.com>
Date: Mon, 25 Jun 2018 10:48:42 -0700
Subject: [PATCH] Prefix docker container name to syslog syslogtag (program
 name) (#1810)

---
 dockers/docker-base/etc/rsyslog.conf              | 6 ++++--
 dockers/docker-database/Dockerfile.j2             | 3 +++
 dockers/docker-dhcp-relay/Dockerfile.j2           | 3 +++
 dockers/docker-fpm-frr/Dockerfile.j2              | 3 +++
 dockers/docker-fpm-quagga/Dockerfile.j2           | 3 +++
 dockers/docker-lldp-sv2/Dockerfile.j2             | 3 +++
 dockers/docker-orchagent/Dockerfile.j2            | 3 +++
 dockers/docker-platform-monitor/Dockerfile.j2     | 3 +++
 dockers/docker-router-advertiser/Dockerfile.j2    | 3 +++
 dockers/docker-snmp-sv2/Dockerfile.j2             | 3 +++
 dockers/docker-sonic-telemetry/Dockerfile.j2      | 3 +++
 dockers/docker-teamd/Dockerfile.j2                | 3 +++
 platform/broadcom/docker-syncd-brcm/Dockerfile.j2 | 3 +++
 platform/cavium/docker-syncd-cavm/Dockerfile.j2   | 3 +++
 platform/centec/docker-syncd-centec/Dockerfile.j2 | 3 +++
 platform/marvell/docker-syncd-mrvl/Dockerfile.j2  | 3 +++
 platform/mellanox/docker-syncd-mlnx/Dockerfile.j2 | 3 +++
 platform/nephos/docker-syncd-nephos/Dockerfile.j2 | 3 +++
 platform/p4/docker-sonic-p4/Dockerfile.j2         | 5 ++++-
 platform/vs/docker-sonic-vs/Dockerfile.j2         | 3 +++
 slave.mk                                          | 2 ++
 21 files changed, 64 insertions(+), 3 deletions(-)

diff --git a/dockers/docker-base/etc/rsyslog.conf b/dockers/docker-base/etc/rsyslog.conf
index 8cd8928e2b..cf5509a3e8 100644
--- a/dockers/docker-base/etc/rsyslog.conf
+++ b/dockers/docker-base/etc/rsyslog.conf
@@ -29,8 +29,10 @@ $ModLoad imuxsock # provides support for local system logging
 ###########################
 #### GLOBAL DIRECTIVES ####
 ###########################
-#Set remote syslog server
-*.* @127.0.0.1:514
+
+# Set remote syslog server
+template (name="ForwardFormatInContainer" type="string" string="<%PRI%>%TIMESTAMP:::date-rfc3339% %HOSTNAME% %syslogtag%%msg:::sp-if-no-1st-sp%%msg%")
+*.* action(type="omfwd" target="127.0.0.1" port="514" protocol="udp" Template="ForwardFormatInContainer")
 
 #
 # Use traditional timestamp format.
diff --git a/dockers/docker-database/Dockerfile.j2 b/dockers/docker-database/Dockerfile.j2
index 4690e1587c..712ada91a9 100644
--- a/dockers/docker-database/Dockerfile.j2
+++ b/dockers/docker-database/Dockerfile.j2
@@ -1,5 +1,8 @@
 FROM docker-config-engine
 
+ARG docker_container_name
+RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name\/%syslogtag%/;" /etc/rsyslog.conf
+
 # Make apt-get non-interactive
 ENV DEBIAN_FRONTEND=noninteractive
 
diff --git a/dockers/docker-dhcp-relay/Dockerfile.j2 b/dockers/docker-dhcp-relay/Dockerfile.j2
index 2c2bdcaecb..7382664c64 100644
--- a/dockers/docker-dhcp-relay/Dockerfile.j2
+++ b/dockers/docker-dhcp-relay/Dockerfile.j2
@@ -1,5 +1,8 @@
 FROM docker-config-engine
 
+ARG docker_container_name
+RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name\/%syslogtag%/;" /etc/rsyslog.conf
+
 # Make apt-get non-interactive
 ENV DEBIAN_FRONTEND=noninteractive
 
diff --git a/dockers/docker-fpm-frr/Dockerfile.j2 b/dockers/docker-fpm-frr/Dockerfile.j2
index 350b3b2efb..4796552d20 100644
--- a/dockers/docker-fpm-frr/Dockerfile.j2
+++ b/dockers/docker-fpm-frr/Dockerfile.j2
@@ -1,5 +1,8 @@
 FROM docker-config-engine
 
+ARG docker_container_name
+RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name\/%syslogtag%/;" /etc/rsyslog.conf
+
 # Make apt-get non-interactive
 ENV DEBIAN_FRONTEND=noninteractive
 
diff --git a/dockers/docker-fpm-quagga/Dockerfile.j2 b/dockers/docker-fpm-quagga/Dockerfile.j2
index 8836459e4e..39037f3d04 100644
--- a/dockers/docker-fpm-quagga/Dockerfile.j2
+++ b/dockers/docker-fpm-quagga/Dockerfile.j2
@@ -1,5 +1,8 @@
 FROM docker-config-engine
 
+ARG docker_container_name
+RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name\/%syslogtag%/;" /etc/rsyslog.conf
+
 # Make apt-get non-interactive
 ENV DEBIAN_FRONTEND=noninteractive
 
diff --git a/dockers/docker-lldp-sv2/Dockerfile.j2 b/dockers/docker-lldp-sv2/Dockerfile.j2
index f75e4ea314..fb91af2315 100644
--- a/dockers/docker-lldp-sv2/Dockerfile.j2
+++ b/dockers/docker-lldp-sv2/Dockerfile.j2
@@ -1,5 +1,8 @@
 FROM docker-config-engine
 
+ARG docker_container_name
+RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name\/%syslogtag%/;" /etc/rsyslog.conf
+
 # Make apt-get non-interactive
 ENV DEBIAN_FRONTEND=noninteractive
 
diff --git a/dockers/docker-orchagent/Dockerfile.j2 b/dockers/docker-orchagent/Dockerfile.j2
index 3d66719963..0df8e9ba1b 100755
--- a/dockers/docker-orchagent/Dockerfile.j2
+++ b/dockers/docker-orchagent/Dockerfile.j2
@@ -1,5 +1,8 @@
 FROM docker-config-engine
 
+ARG docker_container_name
+RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name\/%syslogtag%/;" /etc/rsyslog.conf
+
 ## Make apt-get non-interactive
 ENV DEBIAN_FRONTEND=noninteractive
 
diff --git a/dockers/docker-platform-monitor/Dockerfile.j2 b/dockers/docker-platform-monitor/Dockerfile.j2
index 95e9d150ea..c53ed494c4 100755
--- a/dockers/docker-platform-monitor/Dockerfile.j2
+++ b/dockers/docker-platform-monitor/Dockerfile.j2
@@ -1,5 +1,8 @@
 FROM docker-config-engine
 
+ARG docker_container_name
+RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name\/%syslogtag%/;" /etc/rsyslog.conf
+
 # Make apt-get non-interactive
 ENV DEBIAN_FRONTEND=noninteractive
 
diff --git a/dockers/docker-router-advertiser/Dockerfile.j2 b/dockers/docker-router-advertiser/Dockerfile.j2
index 5007daf122..c6c770bb76 100644
--- a/dockers/docker-router-advertiser/Dockerfile.j2
+++ b/dockers/docker-router-advertiser/Dockerfile.j2
@@ -1,5 +1,8 @@
 FROM docker-config-engine
 
+ARG docker_container_name
+RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name\/%syslogtag%/;" /etc/rsyslog.conf
+
 # Make apt-get non-interactive
 ENV DEBIAN_FRONTEND=noninteractive
 
diff --git a/dockers/docker-snmp-sv2/Dockerfile.j2 b/dockers/docker-snmp-sv2/Dockerfile.j2
index 2605e9b50c..e463d00441 100644
--- a/dockers/docker-snmp-sv2/Dockerfile.j2
+++ b/dockers/docker-snmp-sv2/Dockerfile.j2
@@ -1,5 +1,8 @@
 FROM docker-config-engine
 
+ARG docker_container_name
+RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name\/%syslogtag%/;" /etc/rsyslog.conf
+
 # Enable -O for all Python calls
 ENV PYTHONOPTIMIZE 1
 
diff --git a/dockers/docker-sonic-telemetry/Dockerfile.j2 b/dockers/docker-sonic-telemetry/Dockerfile.j2
index bbb15db69a..51d272c2a2 100644
--- a/dockers/docker-sonic-telemetry/Dockerfile.j2
+++ b/dockers/docker-sonic-telemetry/Dockerfile.j2
@@ -1,5 +1,8 @@
 FROM docker-config-engine
 
+ARG docker_container_name
+RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name\/%syslogtag%/;" /etc/rsyslog.conf
+
 ## Make apt-get non-interactive
 ENV DEBIAN_FRONTEND=noninteractive
 
diff --git a/dockers/docker-teamd/Dockerfile.j2 b/dockers/docker-teamd/Dockerfile.j2
index f604433a6c..f405fdde10 100644
--- a/dockers/docker-teamd/Dockerfile.j2
+++ b/dockers/docker-teamd/Dockerfile.j2
@@ -1,5 +1,8 @@
 FROM docker-config-engine
 
+ARG docker_container_name
+RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name\/%syslogtag%/;" /etc/rsyslog.conf
+
 ## Make apt-get non-interactive
 ENV DEBIAN_FRONTEND=noninteractive
 
diff --git a/platform/broadcom/docker-syncd-brcm/Dockerfile.j2 b/platform/broadcom/docker-syncd-brcm/Dockerfile.j2
index 042e7e764f..bd6d6cc357 100755
--- a/platform/broadcom/docker-syncd-brcm/Dockerfile.j2
+++ b/platform/broadcom/docker-syncd-brcm/Dockerfile.j2
@@ -1,5 +1,8 @@
 FROM docker-config-engine
 
+ARG docker_container_name
+RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name\/%syslogtag%/;" /etc/rsyslog.conf
+
 ## Make apt-get non-interactive
 ENV DEBIAN_FRONTEND=noninteractive
 
diff --git a/platform/cavium/docker-syncd-cavm/Dockerfile.j2 b/platform/cavium/docker-syncd-cavm/Dockerfile.j2
index a35abf576f..9f6e872ff1 100755
--- a/platform/cavium/docker-syncd-cavm/Dockerfile.j2
+++ b/platform/cavium/docker-syncd-cavm/Dockerfile.j2
@@ -1,5 +1,8 @@
 FROM docker-config-engine
 
+ARG docker_container_name
+RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name\/%syslogtag%/;" /etc/rsyslog.conf
+
 ## Make apt-get non-interactive
 ENV DEBIAN_FRONTEND=noninteractive
 
diff --git a/platform/centec/docker-syncd-centec/Dockerfile.j2 b/platform/centec/docker-syncd-centec/Dockerfile.j2
index d9b12bb426..7fa2bd2ae0 100755
--- a/platform/centec/docker-syncd-centec/Dockerfile.j2
+++ b/platform/centec/docker-syncd-centec/Dockerfile.j2
@@ -1,5 +1,8 @@
 FROM docker-config-engine
 
+ARG docker_container_name
+RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name\/%syslogtag%/;" /etc/rsyslog.conf
+
 ## Make apt-get non-interactive
 ENV DEBIAN_FRONTEND=noninteractive
 
diff --git a/platform/marvell/docker-syncd-mrvl/Dockerfile.j2 b/platform/marvell/docker-syncd-mrvl/Dockerfile.j2
index 7676b3f2ff..6e7c34d644 100755
--- a/platform/marvell/docker-syncd-mrvl/Dockerfile.j2
+++ b/platform/marvell/docker-syncd-mrvl/Dockerfile.j2
@@ -1,5 +1,8 @@
 FROM docker-config-engine
 
+ARG docker_container_name
+RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name\/%syslogtag%/;" /etc/rsyslog.conf
+
 ## Make apt-get non-interactive
 ENV DEBIAN_FRONTEND=noninteractive
 
diff --git a/platform/mellanox/docker-syncd-mlnx/Dockerfile.j2 b/platform/mellanox/docker-syncd-mlnx/Dockerfile.j2
index 966ef35ac9..73a16fac2a 100755
--- a/platform/mellanox/docker-syncd-mlnx/Dockerfile.j2
+++ b/platform/mellanox/docker-syncd-mlnx/Dockerfile.j2
@@ -1,5 +1,8 @@
 FROM docker-config-engine
 
+ARG docker_container_name
+RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name\/%syslogtag%/;" /etc/rsyslog.conf
+
 ## Make apt-get non-interactive
 ENV DEBIAN_FRONTEND=noninteractive
 
diff --git a/platform/nephos/docker-syncd-nephos/Dockerfile.j2 b/platform/nephos/docker-syncd-nephos/Dockerfile.j2
index e0248d460a..b25272be1a 100755
--- a/platform/nephos/docker-syncd-nephos/Dockerfile.j2
+++ b/platform/nephos/docker-syncd-nephos/Dockerfile.j2
@@ -1,5 +1,8 @@
 FROM docker-config-engine
 
+ARG docker_container_name
+RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name\/%syslogtag%/;" /etc/rsyslog.conf
+
 ## Make apt-get non-interactive
 ENV DEBIAN_FRONTEND=noninteractive
 
diff --git a/platform/p4/docker-sonic-p4/Dockerfile.j2 b/platform/p4/docker-sonic-p4/Dockerfile.j2
index 95ac5cc164..971d7a962e 100644
--- a/platform/p4/docker-sonic-p4/Dockerfile.j2
+++ b/platform/p4/docker-sonic-p4/Dockerfile.j2
@@ -1,5 +1,8 @@
 FROM docker-config-engine
 
+ARG docker_container_name
+RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name\/%syslogtag%/;" /etc/rsyslog.conf
+
 ## Make apt-get non-interactive
 ENV DEBIAN_FRONTEND=noninteractive
 
@@ -76,4 +79,4 @@ COPY ["files/arp_update", "/usr/bin"]
 RUN echo "docker-sonic-p4" > /etc/hostname
 RUN touch /etc/quagga/zebra.conf
 
-ENTRYPOINT ["/bin/bash"]
\ No newline at end of file
+ENTRYPOINT ["/bin/bash"]
diff --git a/platform/vs/docker-sonic-vs/Dockerfile.j2 b/platform/vs/docker-sonic-vs/Dockerfile.j2
index 0c242bb373..2d9b72aa32 100644
--- a/platform/vs/docker-sonic-vs/Dockerfile.j2
+++ b/platform/vs/docker-sonic-vs/Dockerfile.j2
@@ -1,5 +1,8 @@
 FROM docker-config-engine
 
+ARG docker_container_name
+RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name\/%syslogtag%/;" /etc/rsyslog.conf
+
 ## Make apt-get non-interactive
 ENV DEBIAN_FRONTEND=noninteractive
 
diff --git a/slave.mk b/slave.mk
index 7ca92dc4ce..fc14a8f10a 100644
--- a/slave.mk
+++ b/slave.mk
@@ -382,6 +382,7 @@ $(addprefix $(TARGET_PATH)/, $(SONIC_SIMPLE_DOCKER_IMAGES)) : $(TARGET_PATH)/%.g
 		--build-arg user=$(USER) \
 		--build-arg uid=$(UID) \
 		--build-arg guid=$(GUID) \
+		--build-arg docker_container_name=$($*.gz_CONTAINER_NAME) \
 		-t $* $($*.gz_PATH) $(LOG)
 	docker save $* | gzip -c > $@
 	# Clean up
@@ -412,6 +413,7 @@ $(addprefix $(TARGET_PATH)/, $(SONIC_DOCKER_IMAGES)) : $(TARGET_PATH)/%.gz : .pl
 		--build-arg user=$(USER) \
 		--build-arg uid=$(UID) \
 		--build-arg guid=$(GUID) \
+		--build-arg docker_container_name=$($*.gz_CONTAINER_NAME) \
 		-t $* $($*.gz_PATH) $(LOG)
 	docker save $* | gzip -c > $@
 	# Clean up