style fixes and comments

Author: Christopher M. Neill

ansible/roles/bash_aliases/templates/dot_bash_aliases.sh.j2

@@ -1,16 +1,26 @@
 # not really an alias
 function logtail() {
-    MY_APP="$1"
-    MY_DATE=`date +%Y/%m/%d/%H`
-    MY_LOGDIR="{{ app_log_dir }}"
-    MY_LOGFILE="${MY_LOGDIR}/${MY_DATE}/${MY_APP}.log"
-    tail -f ${MY_LOGFILE} | bunyan
+# Usage: logtail <app_name>
+    # Name of the app log you wish you view, eg: api, navi, docker-listener, swarm-manager
+    local app_name="$1"
+    # string of the current year, month, day and hour in YYYY/MM/DD/HH format
+    local datetime=`date +%Y/%m/%d/%H`
+    # location of application logs specified in ansible configuration
+    local app_log_dir="{{ app_log_dir }}"
+    # concatenate this strings to derive the full log path
+    local logfile="${app_log_dir}/${datetime}/${app_name}.log"
+    # follow logfile, format via bunyan
+    tail -f ${logfile} | bunyan
 }
 
 function npmlog() {
-    MY_APP="$1"
-    MY_LOGDIR="/var/log"
-    MY_LOGFILE="${MY_LOGDIR}/${MY_APP}.log"
-    less ${MY_LOGFILE}
+# Usage: npmlog <app_name>
+    # Name of the app npm log you wish to view.
+    local app_name="$1"
+    # system log dir
+    local app_log_dir="/var/log"
+    # npm log
+    local logfile="${app_log_dir}/${app_name}.log"
+    less ${logfile}
 }
 

ansible/roles/bash_aliases/templates/dot_bash_aliases_root.sh.j2

@@ -1,16 +1,26 @@
 # not really an alias
 function logtail() {
-    MY_APP="$1"
-    MY_DATE=`date +%Y/%m/%d/%H`
-    MY_LOGDIR="{{ app_log_dir }}"
-    MY_LOGFILE="${MY_LOGDIR}/${MY_DATE}/${MY_APP}.log"
-    tail -f ${MY_LOGFILE} | bunyan
+# Usage: logtail <app_name>
+    # Name of the app log you wish you view, eg: api, navi, docker-listener, swarm-manager
+    local app_name="$1"
+    # string of the current year, month, day and hour in YYYY/MM/DD/HH format
+    local datetime=`date +%Y/%m/%d/%H`
+    # location of application logs specified in ansible configuration
+    local app_log_dir="{{ app_log_dir }}"
+    # concatenate this strings to derive the full log path
+    local logfile="${app_log_dir}/${datetime}/${app_name}.log"
+    # follow logfile, format via bunyan
+    tail -f ${logfile} | bunyan
 }
 
 function npmlog() {
-    MY_APP="$1"
-    MY_LOGDIR="/var/log"
-    MY_LOGFILE="${MY_LOGDIR}/${MY_APP}.log"
-    less ${MY_LOGFILE}
+# Usage: npmlog <app_name>
+    # Name of the app npm log you wish to view.
+    local app_name="$1"
+    # system log dir
+    local app_log_dir="/var/log"
+    # npm log
+    local logfile="${app_log_dir}/${app_name}.log"
+    less ${logfile}
 }
 

ansible/roles/loggly/files/rsyslog.conf

@@ -36,6 +36,8 @@ $KLogPermitNonKernelFacility on
 $ActionFileDefaultTemplate RSYSLOG_TraditionalFileFormat
 
 # Runnable JSON logging format
+# Creates an "output formatter" template that accepts as input JSON and prints it out without any further processing ("raw JSON").
+# The formatting around the %msg% string is as such: start printing at the second character "2" until the end of the line "$" using the raw JSON format type.
 $template RunnableJSON,"%msg:2:$:jsonr%\n"
 
 # Filter duplicated messages