Documentation

Start logging tile statistics.

tsmApi offers functionality to log a number of time-stamped events to either a log file, to a port/host combination, or to syslog. This functionality is implemented using the NetLogger library from LBNL (http://www-didc.lbl.gov/NetLogger).

Logging is off by default. In order to start logging you must first call this function for the particular connection. To do this you specify the logging method you wish to use (NL_FILE, NL_SYSLOG, or NL_HOST). If you specify NL_FILE, then you must supply the name of the log file you wish to generate in the destination parameter. If you specify NL_HOST, then you must specify the name of the host that you wish to log to via the destination parameter. If you specify NL_SYSLOG, then you should pass NULL for destination.

Currently, it is hardwired that: a) the program name that is written out for each event is "TerraVision", and b) the port to use when you specify NL_HOST is always DPSS_NETLOGGER_PORT (14830).

Once logging has been started, a number of tsmApi calls will automatically generate log events, e.g. tsmReadTile. However, you can explicitly send your own log event to the log file by using the tsmLog function. When you are done logging, you should call tsmEndLogging.

N.B. if the connection that is being logged is for a DPSS dataset, then this function will also tell the DPSS to start logging its data (which is also done using NetLogger). If you have requested logging to a file, then the DPSS logging will be sent to the filename given by the filename you specified in the destination parameter with a ".dpss" extension appended.