Small fry Unix commands can get the job done A look at the tail and date utilities

May  1998

In this first of a series on "small fry" commands, Mo shows you some nifty tricks you can do with two simple Unix utilities.

The tail display command is particularly useful for examining log files, while date can be used to custom format date fields. (1,700 words)

Mail this article to a friend

nix is filled with hundreds of fascinating little commands that do one or more small jobs. They are designed to work in conjunction with other programs, usually as part of a pipe, in order to get another job done.

Most of them are too simple to warrant a whole article, but these commands are more than just simple short-cuts.

tail
The tail command displays the last 10 lines of a file on standard output (usually the terminal). The number can be modified by using -nn, where nn is the number of lines to display. For example tail -20 log.txt will display the last 20 lines of the file log.txt.

If a + is used, the number of lines specified is from the beginning of the file. For example tail +20 log.txt will skip lines 1 through 19 of log.txt and display lines 20 through to the end of the file.

The tail utility is particularly useful for looking at the last lines logged in a log file. It also has a very useful option called the -f flag. If tail is used with a -f flag, the file being displayed is not closed, but is kept open. The tail program sleeps for one second, wakes, and checks to see if more lines have been added to the file. If they have, the new lines are displayed. This option is particularly useful for monitoring a log file that is currently active and being written to.

Assuming that log.txt is a logging file being written to by one or more programs, tail -f log.txt will display the last 10 lines of log.txt, and then update the screen each second with any new records added to log.txt by other programs.

tail -f is an excellent debugging tool. The first time I used it was to monitor a file that was being filled with transactions by cash registers as cashiers rang up purchases. For testing purposes, we set up the register, rang up different types of transactions, and then examined the result on the Unix screen, immediately. In this way we were quickly able to isolate transactions that were being written to the file incorrectly.

Because tail routes its output to standard output, it is possible to pipe the results of tail into another process. At one point in the debugging, we were concerned that the cash registers were writing garbage or nulls to the transaction file. tail processed the files as text, and it was not possible to see nulls in the data. We used tail to pump the data into od (octal dump) and displayed the files in hex, so that we could examine them for nulls. Using tail -f at the beginning of the stream meant that the transaction file was kept open and constantly pumped into od where the bytes were translated into hex and displayed.

Here is the command:

tail -f trx.txt|od -xc

Testing tail
You might want to try the following to test tail. First we will create a process that writes to a log file. Start the Korn shell by typing ksh and pressing Enter.

Type each of the following lines. As you press Enter after each line, the > prompt will appear indicating that more input is expected. The following lines have been numbered for explanation. The initial $ on line 1 and the > on lines 2 through 6 are provided as prompts for your input. You will be typing everything to the right of the first character.

The command listed below creates a process that sleeps for two seconds and then awakens and appends the date and time to log.txt. The process is submitted to the background by enclosing all of the commands in parentheses at lines 1 and 6, and a final ampersand (&) at line 6. When you press Enter at the end of line 6, the process is submitted to the background and runs as a detached job with no terminal to write to. It doesn't need a terminal since it is writing to log.txt.

On line 7, the operating system responds by giving you the job number of the job that is now running in the background. Make a note of the process id number that appears on your terminal, as you will need it later to kill the process. In this example it is 657.

1    $ ( while true
2    > do
3    > sleep 2
4    > echo `date` >>log.txt
5    > done
6    > )&
7    [1]   657
8    $

Now that log.txt is being filled with date and time stamps, enter the following command:

tail -f log.txt

As you watch the screen, log.txt is filled with more information, and tail -f continues to display the information on the screen as in the following example.

$ tail -f log.txt
Sun Apr 12 14:03:01 PDT 1998
Sun Apr 12 14:03:03 PDT 1998
Sun Apr 12 14:03:05 PDT 1998
Sun Apr 12 14:03:07 PDT 1998

Press Control-C or the Delete key to stop your tail -f process depending on how your terminal is set up.

Finally you need to stop the background process that is logging to the log.txt file. Using the process id number you noted after the process started type:

kill 657

The system will usually respond with a message that the specified job has been terminated as in the following example.

$ kill 657
[1] + Terminated     (while true;do;sleep 2;echo `date` >>log.txt;done)&
$

Formatting with date
The date command is frequently used to set the date and time, but it can also be used to extract the date and time in numerous formats.

The simplest format is the default:

$ date
Sun Apr 12 14:03:01 PDT 1998

A simple logging shell script can be created by using this format. After you have edited this with vi, save it as logit.sh. Then change the permissions on it by typing chmod a+x logit.sh to make it executable.

The logit.sh script

# logit.sh
# log all the arguments passed on the command line, with a date and time stamp
echo `date` $@ >> log.txt

You can run logit.sh by typing:

$ logit.sh This is a line to log

If you then type out the last line of log.txt it will contain:

$ cat log.txt
Sun Apr 12 14:03:01 PDT 1998 This is a line to log

The date may also be formatted by using a + followed by formatting characters as in:

$ date +%D
04/12/98

In this example %D stands for the date in mm/dd/yy format. Other formatting characters are listed below. Your version of date may not support all of these, and may support others. Check your man pages for a list of formatting characters.

It is frequently necessary to include spaces in a date format so it is usual to include the date format string in quotes. In the following example, the quotes are necessary because of the space in the format string.

$ date "+%D %R"
04/12/98 13:22

This ability to format the date fields can be used to create log file names that contain a date stamp. In the following version of logit.sh, the log file name is created from the year, month, day, and hour. This ensures that log files don't become too large to be easily handled.

# logit.sh
# log all the arguments passed on the command line, in an
# hourly log file.
logtime=`date "+%y%m%d%H"`
logfile=${logtime}.log
echo `date` $@ >> $logfile

This could be taken down to the minute if a lot of logging is going on by using:

# logit.sh
# log all the arguments passed on the command line, in an
# hourly log file.
logtime=`date "+%y%m%d%H%M"`
logfile=${logtime}.log
echo `date` $@ >> $logfile

One of the advantages of using date to create log file names is the natural sort order provided by the ls command. If the file name is created by concatenating year, month, day, and hour (or hour and minute) the log files will sort together, in time order when a ls command is used.

Resources

• Previous Unix 101 column on killing a process http://www.sun.com/sunworldonline/swol-04-1998/swol-04-unix101.html
• and on logging http://www.sun.com/sunworldonline/swol-12-1997/swol-12-unix101.html
• Using kill to terminate a process http://www.gci.ulaval.ca/HPManuel/base/kill.htm
• and http://www.ccs.ornl.gov/news/guide/xps_man/kill.1.html
• A guide to common Unix commands http://www.ccs.ornl.gov/news/guide/xps_unix.html
• An introduction to Unix http://www.cit.ac.nz/smac/os100/unix01.htm
• An illustrated explanation of pipes http://www.cit.ac.nz/smac/os100/unix04.htm#pipes
• Full listing of previous Unix 101 columns in SunWorld http://www.sun.com/sunworldonline/common/swol-backissues-columns.html#unix101

About the author
Mo Budlong, president of King Computer Services Inc., specializes in Unix and client/server consulting and training and currently publishes the COBOL Just In Time Course, a crash course for the Year 2000 problem as well as COBOL Dates and the Year 2000 which offers date solutions. Reach Mo at mo.budlong@sunworld.com.

If you have technical problems with this magazine, contact webmaster@sunworld.com

URL: http://www.sunworld.com/swol-05-1998/swol-05-unix101.html
Last modified: