Bash-Script-Logger/script_logger.sh at master · steaksauce-/Bash-Script-Logger · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
#!/bin/bash
#
# NOTE: I am not the original author of this script.
# I have stumbled upon this script in my career and have found it useful, but do not know the original source.
# If you know the original author or origin of this script, please let me know in an issue and I will be glad to give credit where it is due.
#
#--------------------------------------------------------------------------------------------------------------
# This script is for logging other bash scripts.
# To enable logging of a bash script, you must place the flowing 3 lines in the beginning of THAT script:
#
# Replace /path/to/this/script_logger.sh with the full path to this script.
#
################################-PLACE THESE LINES BELOW THE BASH DELARATION-##################################
# source /path/to/this/script_logger.sh
# Enable_Logging
# Enable_Trap
###############################################################################################################
#
# MAKE SURE THERE ARE NO "#" SYMBOLS IN FRONT OF THE ABOVE LINES WHEN ENTEREND INTO ANOTHER SCRIPT.
# The "source" line assumes this script is saved in the custom Standard script directory.
#--------------------------------------------------------------------------------------------------------------


# DECLARING VARIABLES:
#
FileTime=`date +\%H\%M\%S`
FileDate=`date +\%Y\%m\%d`
TimeStamp=$(date +"%r")
DateStamp=$(date +"%Y-%m-%d")
SNWE=$(basename "$0")                          # SCRIPT NAME WITH EXTENSION.
ScriptName=$(basename "$0" | cut -d. -f1)       # SCRIPT NAME WITH EXTENSION REMOVED.
#LogFile="/var/log/$ScriptName.log"
LogFile="/var/log/custom.log"


# FUNCTION TO LOG THE OUTPUT OF A COMMAND:
#
function Log_out {
while read LINE; do
        local IN="$LINE"

        if [ -n "$IN" ]; then
                echo "${DateStamp}  ${TimeStamp}  $HOSTNAME  ($USER)  Source:[$SNWE] INFO: $IN" >> $LogFile
#        else
#                echo ${DateStamp} ${TimeStamp} info: $IN >> $LogFile
        fi

        unset IN
done
}


# FUNCTION TO LOG THE OUTPUT OF A COMMAND:
#
function Log_err {
while read LINE; do
        local IN="$LINE"

        if [ -n "$IN" ]; then
                echo "${DateStamp}  ${TimeStamp}  $HOSTNAME  ($USER)  Source:[$SNWE] ERROR: $IN" >> $LogFile
#        else
#                echo ${DateStamp} ${TimeStamp} error: $IN >> $LogFile
        fi

        unset IN
done
}


# FUNCTION TO ENABLE LOGGING OF ALL OUTPUT:
#
function Enable_Logging {
exec 1> >(Log_out)
exec 2> >(Log_err)
}


# FUNCTION TO CHECK THE EXITCODE AND LOG SUCCESS OR FAIL:
#
function Script_Exit {
if [ $? -eq 0 ]; then
        echo "${DateStamp}  ${TimeStamp}  $HOSTNAME  ($USER)  Source:[$SNWE] INFO: The Script Completed Successfully!" >> $LogFile
        echo ----------------------------------------------------------------------------------------------------------- >> $LogFile
        echo 0 > "/opt/custom/scripts/.$ScriptName.exit"
        exit 0
else
        echo "${DateStamp}  ${TimeStamp}  $HOSTNAME  ($USER)  Source:[$SNWE] ERROR: The Script Failed!" >> $LogFile
        echo ----------------------------------------------------------------------------------------------------------- >> $LogFile
        echo 1 > "/opt/custom/scripts/.$ScriptName.exit"
        exit 1
fi
}


function Enable_Trap {
# RUN EXITCODE CHECK REGARDLESS OF HOW THE SCRIPT EXITS:
#
trap Script_Exit EXIT INT TERM
}