38.3. POP3 diagnostics, statistics and debug

38.3. POP3 diagnostics, statistics and debug
	Chapter 38. POP3 - Post Office Protocol 3

38.3.1. POP3 diagnostics

This command reports the current situation of the POP3 resource:

d d pop3: Shows the state of the resource.
d de pop3: Shows the state of the resource, and information about POP3 sessions.

[14:11:34] ABILIS_CPX:d d pop3

RES:Pop3 ----------------------------------------------------------------------
       Post_Office_Protocol_Ver3                                               
       STATE:ACTIVE   SESSIONS:10
       ------------------------------------------------------------------------

[14:11:39] ABILIS_CPX:d de pop3

RES:Pop3 ----------------------------------------------------------------------
       Post_Office_Protocol_Ver3                                               
       STATE:ACTIVE   SESSIONS:10
       - Pop3 Sessions --------------------------------------------------------
       CH TCP-State LocAdd-LocPort        RemAdd-RemPort        POP3-State
       ------------------------------------------------------------------------
       0  LISTEN    000.000.000.000-110                         READY
       1  LISTEN    000.000.000.000-110                         READY
       2  LISTEN    000.000.000.000-110                         READY
       3  LISTEN    000.000.000.000-110                         READY
       4  LISTEN    000.000.000.000-110                         READY
       5  LISTEN    000.000.000.000-110                         READY
       6  LISTEN    000.000.000.000-110                         READY
       7  LISTEN    000.000.000.000-110                         READY
       8  LISTEN    000.000.000.000-110                         READY
       9  LISTEN    000.000.000.000-110                         READY

The meaning:

STATE

The POP3 driver state:

INACTIVE - POP3 is not ready to receive connections.
ACTIVE - POP3 fully active.

SESSIONS

The total number of POP3 sessions in listening when driver state is ACTIVE.

CH

The ID of a single session channel.

TCP-State

POP3 Session TCP state

DOWN - channel is down;
READY - channel is ready;

LISTEN - channel is listening;
CALLED - called procedure;

CALLING - calling procedure;
CONNECTED - channel is connected;

CLEARING - clearing state;
CLEARED - cleared state;

UNDEFINED - state undefined.

LocAdd-LocPort: Local IP Address and Local Port.
RemAdd-RemPort: Remote IP Address and Remote Port.

POP3-state

POP3 Session state:

READY - waiting events;
INACTIVE - SMTP-ACT configuration parameter was set off;

DOWN - TCP port is down;
AUTH1 - POP3 Authorization State;

AUTH2 - POP3 Authorization State, waiting for PASS command;
TRANSACT - POP3 Transaction State;

UPDATE - POP3 Update State.

38.3.2. POP3 statistics

This command can help to understand what is happening, in case of troubles:

d s pop3: Shows the statistics of the POP3 resource.
d se pop3: Shows the statistics of the POP3 resource for each session.

[15:04:30] ABILIS_CPX:d s pop3

RES:Pop3 ----------------------------------------------------------------------
       Post_Office_Protocol_Ver3                                               
       --- Cleared 3 days 05:56:27 ago, on 11/09/2020 at 09:08:14 -------------
       -----------|---INPUT---|--OUTPUT---|-----------|---INPUT---|--OUTPUT---|
       CALL-SUCC  |        467|           |CALL-FAIL  |          0|           |
       CHAR       |      26152|     173601|PCK        |       3269|       3736|
       MAIL-SUCC  |           |          0|MAIL-FAIL  |           |          0|
       AVG-SIZE   |           |          0|DENIED-IP  |          0|           |
       BANNED-IP  |          0|           |
       ------------------------------------------------------------------------

[15:04:41] ABILIS_CPX:d se pop3

RES:Pop3 ----------------------------------------------------------------------
       Post_Office_Protocol_Ver3                                               
       --- Cleared 3 days 05:57:20 ago, on 11/09/2020 at 09:08:14 -------------
       - Pop3 Sessions --------------------------------------------------------
       CH TCP-State LocAdd-LocPort        RemAdd-RemPort        POP3-State
       ------------------------------------------------------------------------
       0  LISTEN    000.000.000.000-110                         READY
       -----------|---INPUT---|--OUTPUT---|-----------|---INPUT---|--OUTPUT---|
       CALL-SUCC  |         47|           |CALL-FAIL  |          0|           |
       CHAR       |       2632|      17470|PCK        |        329|        376|
       MAIL-SUCC  |           |          0|MAIL-FAIL  |           |          0|
       AVG-SIZE   |           |          0|
       ------------------------------------------------------------------------
       1  LISTEN    000.000.000.000-110                         READY
       -----------|---INPUT---|--OUTPUT---|-----------|---INPUT---|--OUTPUT---|
       CALL-SUCC  |         47|           |CALL-FAIL  |          0|           |
       CHAR       |       2632|      17472|PCK        |        329|        376|
       MAIL-SUCC  |           |          0|MAIL-FAIL  |           |          0|
       AVG-SIZE   |           |          0|
       ------------------------------------------------------------------------
       2  LISTEN    000.000.000.000-110                         READY
       -----------|---INPUT---|--OUTPUT---|-----------|---INPUT---|--OUTPUT---|
       CALL-SUCC  |         47|           |CALL-FAIL  |          0|           |
       CHAR       |       2632|      17473|PCK        |        329|        376|
       MAIL-SUCC  |           |          0|MAIL-FAIL  |           |          0|
       AVG-SIZE   |           |          0|
       ------------------------------------------------------------------------
       3  LISTEN    000.000.000.000-110                         READY
       -----------|---INPUT---|--OUTPUT---|-----------|---INPUT---|--OUTPUT---|
       CALL-SUCC  |         47|           |CALL-FAIL  |          0|           |
       CHAR       |       2632|      17470|PCK        |        329|        376|
       MAIL-SUCC  |           |          0|MAIL-FAIL  |           |          0|
       AVG-SIZE   |           |          0|
       ------------------------------------------------------------------------

With reference to the shown interval of time («Cleared 3 days 05:57:20 ago») these counters show the number of:

`CALL-SUCC`	Successful incoming/outgoing TCP connections.
`CALL-FAIL`	Unsuccessful incoming/outgoing TCP connections.
`CHAR`	The total number of chars received/sent by this POP3 session.
`PCK`	Incoming/Outgoing packets.
`MAIL-SUCC`	Successfully downloaded mails.
`MAIL-FAIL`	Mails not downloaded because of a failure.
`AVG-SIZE`	Average mails dimension.
`DENIED-IP`	POP3 requests received from the clients but not processed because requester (the author of this POP3 request) is not allowed. The not-allowed requester is a client whose IP address is not present in `IPSRC` and `IPSRCLIST` parameters configuration.
`BANNED-IP`	Requests that was discarded because the source IP was banned by IPBAN service.

38.3.3. POP3 debug

Type the following command to view allowed commands:

[15:24:00] ABILIS_CPX:debug res:pop3

RES:Pop3 ----------------------------------------------------------------------
       Post_Office_Protocol_Ver3                                               
       BufferLength:64512  Date/Time:14/09/2020 15:37:54 TraceTime:282563675

Usage:

   LSN:0                                      - This help
   LSN:1                                      - Debug
   LSN:3                                      - Show session log
   LSN:3 CMD:CLR                              - Clear session log

	Note
	To use these commands you need to have administrator or super user rights.

Type the following command to view the POP3 session log:

[15:37:54] ABILIS_CPX:debug res:pop3 lsn:3

RES:Pop3 ----------------------------------------------------------------------
       Post_Office_Protocol_Ver3                                               
       BufferLength:64512  Date/Time:14/09/2020 15:39:50 TraceTime:282680199

13/09 14:43:59 [ 0] Started session with 192.168.20.100
13/09 14:43:59 [ 0] Closed session
13/09 14:53:45 [ 1] Started session with 192.168.20.100
13/09 14:53:45 [ 1] Closed session
13/09 15:03:55 [ 2] Started session with 192.168.20.100
13/09 15:03:55 [ 2] Closed session
13/09 15:13:49 [ 3] Started session with 192.168.20.100
13/09 15:13:49 [ 3] Closed session
13/09 15:23:59 [ 4] Started session with 192.168.20.100
13/09 15:23:59 [ 4] Closed session
13/09 15:33:33 [ 5] Started session with 192.168.20.100
13/09 15:33:33 [ 5] Closed session
13/09 15:43:38 [ 6] Started session with 192.168.20.100
13/09 15:43:38 [ 6] Closed session
13/09 15:53:45 [ 7] Started session with 192.168.20.100
13/09 15:53:45 [ 7] Closed session
13/09 16:04:08 [ 8] Started session with 192.168.20.100
13/09 16:04:08 [ 8] Closed session

Alternative to view the POP3 session log type the following command:

[15:42:44] ABILIS_CPX:d pop3 log

13/09 14:53:45 [ 1] Started session with 192.168.20.100
13/09 14:53:45 [ 1] Closed session
13/09 15:03:55 [ 2] Started session with 192.168.20.100
13/09 15:03:55 [ 2] Closed session
13/09 15:13:49 [ 3] Started session with 192.168.20.100
13/09 15:13:49 [ 3] Closed session
13/09 15:23:59 [ 4] Started session with 192.168.20.100
13/09 15:23:59 [ 4] Closed session
13/09 15:33:33 [ 5] Started session with 192.168.20.100
13/09 15:33:33 [ 5] Closed session
13/09 15:43:38 [ 6] Started session with 192.168.20.100
13/09 15:43:38 [ 6] Closed session
13/09 15:53:45 [ 7] Started session with 192.168.20.100
13/09 15:53:45 [ 7] Closed session


38.2. Example of configuration of the POP3 resource		Chapter 39. SNTP - Simple Network Time Protocol