12.0 Using Self-Monitoring

12.1 What is Self-Monitoring?

12.2 Enabling Self-Monitoring

12.3 arameters that can be Monitored

12.4 Using Self-Monitoring Commands

12.1 What is Self-Monitoring?

Self-Monitoring enables the TL1 Agent to monitor the Agent details such as the number of requests received, number of responses and autonomous messages sent, etc. The Agent details are automatically updated and monitored by the TL1 Agent and their values can be retrieved whenever you require by sending the appropriate input  messages.

12.2 Enabling Self-Monitoring

Follow the steps given below to enable the Self-Monitoring. Please note that you have to enable Self-Monitoring before code generation.

1. In the TL1Compiler, choose Project >> Settings from the Menu Bar or using the shortcut key CNTRL+SHIFT+S. A Dialog Box will appear with Settings tree on the left frame of the box.

2. Choose the node General from the Settings tree. Here, you can enable or disable Self Monitoring support.

12.3 Parameters That Can Be Monitored

The Self Monitoring feature allows the TL1 Agent to monitor the following agent parameter details:

• Input Request Received

• Autonomous Messages Sent

• Acknowledgement Messages Sent

• Delayed Activation Messages

• Output Responses

These parameters are automatically updated and monitored by the TL1 Agent and their values can be retrieved whenever you require by sending the appropriate input command messages.

12.4 Using Self-Monitoring Commands

Following are the commands that are available for Self-Monitoring of the TL1 Agent. These commands are available in the tl1builtincommands.tcs file. Before testing the examples for Self-Monitoring commands, make sure you do the following.

1. Run a simple TL1 Agent at a specified Port.

2. Connect to the Agent using the TL1Browser.

3. Load the TCS for which the Agent was created, tl1security.tcs, and tl1builtincommands.tcs in the TL1Browser.

4. Expand the tl1security.tcs tree and select ACT-USER command.

5. Authenticate into the TL1 Agent by sending the  Input command "ACT-USER::root:1::public;". Here, the user is the "root" ( the administrator) and the password is "public". Please refer to Chapter 7 on "Testing the TL1 Agent" for more information on Authentication.

6. After executing the above command successfully, you can start using the Self Monitoring commands that are available in the tl1builtincommands.tcs as explained in the following sections.

1. Command for Getting Count of Input Requests Received

This Self-Monitoring command gets the count of the number of Input Request messages that were received by  the Agent from the Clients.

The Syntax of the Input Command is as follows

GET-SM-MSGIN:::<CTAG>::;

e.g. Request: GET-SM-MSGIN:::11::;

The Response Message for the above input command will appear as shown below.

2. Command for Getting the Count of Autonomous Messages Sent

This Self-Monitoring command gets the count of the number of Autonomous Messages sent by the Agent.

The Syntax of the Input Command is as follows

GET-SM-ALRMSENT:::<CTAG>::;

e.g. Request:

GET-SM-ALRMSENT:::12::;

The Response Message for the above input command will appear as shown below.

3. Acknowledgement Messages Sent

This Self-Monitoring command gets the count of the number of  Acknowledgement Messages sent by the Agent for the request messages received from the Clients.

The Syntax of the Input Command is as follows:

GET-SM-MSGACK:::<CTAG>::;

e.g. Request: GET-SM-MSGACK:::13::;

The Response Message for the above input command will appear as shown below.

4. Delayed Activation Messages

This Self-Monitoring command gets the count of the number of the number of input request messages that are pending (i.e. delayed activation messages) which requires processing to send responses at a later stage. In other words This Self-Monitoring command gets the count of the number of Delay activation messages that are to be processed and responded to the Client at a later stage.

The Syntax of the Input Command is as follows

GET-SM-MSGDA:::<CTAG>::;

e.g.Request: GET-SM-MSGDA:::14::;

The Response Message for the above input command will appear as shown below.

5. Output Responses.

This Self-Monitoring command gets the count of the number of number of Output Response Messages that have been sent by the Agent.

The Syntax of the Input Command for getting the value of this parameter is as follows

GET-SM-MSGOUT::<CommandcompletionCode>:<CTAG>::;

e.g.Request: GET-SM-MSGOUT::COMPLD:15::;

The Response Message for the above input command will appear as shown below.

The above input command gets and displays the count of the number of Output Response Messages that were processed and sent successfully.

The following is the syntax for the Input Command for getting and displaying the count of the number of Output Messages for the input messages that were partially completed.

GET-SM-MSGOUT::PRTL:<CTAG>::;

e.g.Request: GET-SM-MSGOUT::PRTL:17::;

The Response Message for the above input command will appear as shown below.

The following is the syntax for the Input Command for getting and displaying the count of the number of Input Messages that were denied  successful execution.

GET-SM-MSGOUT::DENY:<CTAG>::;

e.g.Request: GET-SM-MSGOUT::DENY:17::;

The Response Message for the above input command will appear as shown below.

The following is the syntax for the Input Command for getting and displaying the count of the number of Output Messages that were sent for the input retrieve commands that were sent to retrieve from the NE.

GET-SM-MSGOUT::RTRV:<CTAG>::;

e.g. Request: GET-SM-MSGOUT::RTRV:20::;.

The Response Message for the above input command will appear as shown below.

The following is the syntax for the Input Command for getting and displaying the count of the number of Output Messages that were delayed  processing and queued up in the processing queue.

GET-SM-MSGOUT::DELAY:<CTAG>::;

e.g. Request: GET-SM-MSGOUT::DELAY:11::;

The Response Message for the above input command will appear as shown below.