TCPLOG (JANUS DEFINE parameter): Difference between revisions
Jump to navigation
Jump to search
(Automatically generated page update) |
m (minor formatting) |
||
| Line 8: | Line 8: | ||
The log file is opened and cleared when the associated Janus port is started, and it is closed when the port is stopped or if an error occurs writing data to the dataset. | The log file is opened and cleared when the associated Janus port is started, and it is closed when the port is stopped or if an error occurs writing data to the dataset. | ||
The log data is written in variable length blocks. The first four bytes of a block contain the length of the block. Each block contains at least one record. No character translation or formatting is done for the actual TCP data. Since the blocks are standard variable length blocks, they all start with a Block Descriptor Word | The log data is written in variable length blocks. The first four bytes of a block contain the length of the block. Each block contains at least one record. No character translation or formatting is done for the actual TCP data. Since the blocks are standard variable length blocks, they all start with a Block Descriptor Word (BDW) which consists of a halfword block length followed by two bytes of zero. | ||
The layout of the records in each block is described in detail below: | The layout of the records in each block is described in detail below: | ||
<table> | <table> | ||
<tr><th | <tr class="head"><th>Offset</th><th>Length</th><th>Type</th><th>Description</th></tr> | ||
<tr><td style="text-align:right">0</td><td style="text-align:right">2</td><td>Unsigned binary</td><td>RDW (Record descriptor word): the length of the current record</td></tr> | <tr><td style="text-align:right">0</td><td style="text-align:right">2</td><td>Unsigned binary</td><td>RDW (Record descriptor word): the length of the current record</td></tr> | ||
<tr><td style="text-align:right">2</td><td style="text-align:right">2</td><td>Unused</td><td>Unused</td></tr> | <tr><td style="text-align:right">2</td><td style="text-align:right">2</td><td>Unused</td><td>Unused</td></tr> | ||
<tr><td style="text-align:right">4</td><td style="text-align:right">8</td><td>Unsigned binary</td><td>Unique TCP connection number</td></tr> | <tr><td style="text-align:right">4</td><td style="text-align:right">8</td><td>Unsigned binary</td><td>Unique TCP connection number</td></tr> | ||
<tr><td style="text-align:right">12</td><td style="text-align:right">8</td><td>Unsigned binary</td><td>Time of day in clock units</td></tr> | <tr><td style="text-align:right">12</td><td style="text-align:right">8</td><td>Unsigned binary</td><td>Time of day in clock units</td></tr> | ||
<tr><td style="text-align:right">20</td><td style="text-align:right">4</td><td>Unsigned binary</td><td>Remote IP address</td></tr> | <tr><td style="text-align:right">20</td><td style="text-align:right">4</td><td>Unsigned binary</td><td>Remote IP address</td></tr> | ||
<tr><td style="text-align:right">24</td><td style="text-align:right">4</td><td>Unsigned binary</td><td>Local IP address</td></tr> | <tr><td style="text-align:right">24</td><td style="text-align:right">4</td><td>Unsigned binary</td><td>Local IP address</td></tr> | ||
<tr><td style="text-align:right">28</td><td style="text-align:right">2</td><td>Unsigned binary</td><td>Remote port number</td></tr> | <tr><td style="text-align:right">28</td><td style="text-align:right">2</td><td>Unsigned binary</td><td>Remote port number</td></tr> | ||
<tr><td style="text-align:right">30</td><td style="text-align:right">2</td><td>Unsigned binary</td><td>Local port number</td></tr> | <tr><td style="text-align:right">30</td><td style="text-align:right">2</td><td>Unsigned binary</td><td>Local port number</td></tr> | ||
<tr><td style="text-align:right">32</td><td style="text-align:right">1</td><td>EBCDIC character</td><td>Direction: S (Sent) or R (Received)</td></tr> | <tr><td style="text-align:right">32</td><td style="text-align:right">1</td><td>EBCDIC character</td><td>Direction: S (Sent) or R (Received)</td></tr> | ||
<tr><td style="text-align:right">33</td><td style="text-align:right">1</td><td>Unused</td><td>Unused</td></tr> | <tr><td style="text-align:right">33</td><td style="text-align:right">1</td><td>Unused</td><td>Unused</td></tr> | ||
<tr><td style="text-align:right">34</td><td style="text-align:right">2</td><td>Unsigned binary</td><td>Length of TCP data</td></tr> | <tr><td style="text-align:right">34</td><td style="text-align:right">2</td><td>Unsigned binary</td><td>Length of TCP data</td></tr> | ||
<tr><td style="text-align:right">36</td><td style="text-align:right">v</td><td>Binary</td><td>Any TCP data</td></tr> | <tr><td style="text-align:right">36</td><td style="text-align:right">v</td><td>Binary</td><td>Any TCP data</td></tr> | ||
</table> | </table> | ||
| Line 30: | Line 41: | ||
The <var>TCPLOG</var> parameter is valid only for <var>[[JANUS DEFINE#type|WEBSERV]]</var> ports. | The <var>TCPLOG</var> parameter is valid only for <var>[[JANUS DEFINE#type|WEBSERV]]</var> ports. | ||
==See also== | ==See also== | ||
Revision as of 22:29, 19 October 2015
TCPLOG filename — Log TCP activity to flatfile
TCPLOG is a parameter on JANUS DEFINE, which defines and sets characteristics of a Janus port.
A Janus Web Server port definition parameter, TCPLOG tells Janus Web Server to log in a sequential dataset all inbound and outbound TCP data transmitted for this port. The dataset name is specified as the value that follows the TCPLOG keyword.
The log file is opened and cleared when the associated Janus port is started, and it is closed when the port is stopped or if an error occurs writing data to the dataset.
The log data is written in variable length blocks. The first four bytes of a block contain the length of the block. Each block contains at least one record. No character translation or formatting is done for the actual TCP data. Since the blocks are standard variable length blocks, they all start with a Block Descriptor Word (BDW) which consists of a halfword block length followed by two bytes of zero.
The layout of the records in each block is described in detail below:
| Offset | Length | Type | Description |
|---|---|---|---|
| 0 | 2 | Unsigned binary | RDW (Record descriptor word): the length of the current record |
| 2 | 2 | Unused | Unused |
| 4 | 8 | Unsigned binary | Unique TCP connection number |
| 12 | 8 | Unsigned binary | Time of day in clock units |
| 20 | 4 | Unsigned binary | Remote IP address |
| 24 | 4 | Unsigned binary | Local IP address |
| 28 | 2 | Unsigned binary | Remote port number |
| 30 | 2 | Unsigned binary | Local port number |
| 32 | 1 | EBCDIC character | Direction: S (Sent) or R (Received) |
| 33 | 1 | Unused | Unused |
| 34 | 2 | Unsigned binary | Length of TCP data |
| 36 | v | Binary | Any TCP data |
The TCPLOG dataset cannot be shared by multiple Janus ports.
The TCPLOG parameter is valid only for WEBSERV ports.