SRLM Logo
Home
Design
How To
Compare
Contact Us
SourceForge Resources
Summary
Discussion
Download

Secure Remote Log Monitor

Message ID Codes


Table of Contents

Message Name:

Message ID:

Trigger Encountered

0

Add Trigger

1

Remove Trigger

2

Get Specific Gile Data

3

Get x files from System

4

File Not Found

5

Specific File Data

6

List of x files

7

Get System Log Rotate Configuration File

8

Log Rotate Configurations File

9

Add Filename to .lrc File

10

Remove Filename from .lrc File

11

Get Active Systems and Last Connection

12

Active Systems and Last Connection

13

Get Server Connection Data

14

Server Connection Data

15

Update Server Connection Data

16

Get All Log Types

17

All Log Types

18

Create/Remove/Edit Log Type

19

Get System Log Types

20

System Log Types

21

Edit Trigger

22

Get All Triggers

23

All Triggers

24

Get Specific Trigger Data

25

Specific Trigger Data

26

Get System Triggers

27

System Triggers

28



Message Name:

Trigger Encountered

Message Number:

0

Receiver(s):

Controller, GUI

Sender(s):

Analyzer, Controller

Brief Description:

When a user-defined trigger event occurs, a message is sent to the GUI to notify a system administrator of a potential problem.

XML Example:

<Internal Number ="0">
        <IP>
                x.x.x.x
        </IP>
        <TimeStamp>
                x.x
        </TimeStamp>
        <FileName>
                filename.ext
        </FileName>
        <Triggers>
                triggerName
                . . .
                triggerName
        </Triggers>
        <LineNumbers>
                x
                . . .
                x
        </LineNumbers>
</Internal>


Message Name:

Add Trigger

Message Number:

1

Receiver(s):

Controller

Sender(s):

GUI

Brief Description:

If the user wishes to add a trigger to be monitored, the data is collected by the GUI and sent to the controller. The controller then adds this information to the keywords.xml file.

XML Example:

<Internal Number ="1">
        <Trigger type="Global/IP/Filename">
        <Name>
                 triggerName
        </Name>
        <Val>
                keyword
        </Val>
        <Num>
                number of times keyword must be encountered
        </Num>
        <Time>
                time limit (in seconds) in which Val must be encountered Num times
        </Time>
        </Trigger>
</Internal>



Message Name:

Remove Trigger

Message Number:

2

Receiver(s):

Controller

Sender(s):

GUI

Brief Description:

If the user requests that a trigger be removed, the GUI gathers the appropriate data and the trigger is removed from keywords.xml by the controller.

XML Example:

<Internal Number ="2">
        <Trigger type="Global/IP/Filename">
        <Name>
                triggerName
        </Name>
        </Trigger>
</Internal>



Message Name:

Get Specific File Data

Message Number:

3

Receiver(s):

Controller, Archiver

Sender(s):

GUI, Controller

Brief Description:

If the user requests the file data of a specific file, the GUI queries the controller and then the archiver to obtain the file data.

XML Example:

<Internal Number ="3">
        <System IP="x.x.x.x">
        <File name="filename">
                timestamp(seconds)
        </File>
        </System>
</Internal>



Message Name:

Get x Files from System

Message Number:

4

Receiver(s):

Controller, Archiver

Sender(s):

GUI, Controller

Brief Description:

The GUI uses this message to request a list of the last x files from a specific system.

XML Example:

<Internal Number ="4">
        <System IP="x.x.x.x">
        <NumFiles>
                x
        </NumFiles>
        </System>
</Internal>



Message Name:

File Not Found

Message Number:

5

Receiver(s):

Controller, GUI

Sender(s):

Archiver, Controller

Brief Description:

This message is returned to the controller, then to the GUI, if a requested file name cannot be found.

XML Example:

<Internal Number ="5">
        <Error>
                errorMessage
        </Error>
</Internal>



Message Name:

Specific File Data

Message Number:

6

Receiver(s):

Controller, GUI

Sender(s):

Archiver, Controller

Brief Description:

This message contains the data of the specific file name requested.

XML Example:

<Internal Number ="6">
        <System IP="x.x.x.x">
        <File name="filename">
                fileData
        </File>
        </System>
</Internal>



Message Name:

List of x files

Message Number:

7

Receiver(s):

Controller, GUI

Sender(s):

Archiver, Controller

Brief Description:

This message contains a list of the last x files received from a system and their associated timestamps.

XML Example:

<Internal Number ="7">
        <System IP="x.x.x.x">
        <File name="filename">
                timeStamp
        </File>
                . . .
        <File name="filename">
                timeStamp
        </File>
        </System>
</Internal>



Message Name:

Get System Log Rotate Configuration File

Message Number:

8

Receiver(s):

Controller

Sender(s):

GUI

Brief Description:

This message contains the GUI's request for a specific system's log rotate configuration file.

XML Example:

<Internal Number ="8">
        <System IP="x.x.x.x">
        </System>
</Internal>



Message Name:

Log Rotate Configuration File

Message Number:

9

Receiver(s):

GUI

Sender(s):

Controller

Brief Description:

This message contains the contents of the requested log rotate configuration file.

XML Example:

<Internal Number ="9">
        <System IP="x.x.x.x">
                logRotateConfigurationFile
        </System>
</Internal>



Message Name

Add Filename to .lrc File

Message Number:

10

Receiver(s):

Controller

Sender(s):

GUI

Brief Description:

If a new Log Type is added to a system, the system's log rotate configuration file must be updated. This message contains the Log Type which will be used to adjust the x.x.x.x.lrc file.

XML Example:

<Internal Number ="10">
        <System IP="x.x.x.x">
                Log Type
        </System>
</Internal>



Message Name:

Remove Filename from .lrc File

Message Number:

11

Receiver(s):

Controller

Sender(s):

GUI

Brief Description:

If a Log Type is no longer to be monitored by a specific system, this message is sent to the controller to remove the filename from the log rotate configuration file.

XML Example:

<Internal Number ="11">
        <System IP="x.x.x.x">
                Log Type
        </System>
</Internal>



Message Name:

Get Active Systems and Last Connection

Message Number:

12

Receiver(s):

Controller, Archiver

Sender(s):

GUI, Controller

Brief Description:

The GUI uses this message to request a list of the current systems with the timestamp of their most recent log files from the Archiver.

XML Example:

<Internal Number="12">
</Internal>



Message Name:

Active Systems and Last Connection

Message Number:

13

Receiver(s):

Controller, GUI

Sender(s):

Archiver, Controller

Brief Description:

The Archiver uses this message to return a list of the current systems with the timestamp of their most recent log files to the GUI.

XML Example:

<Internal Number="13">
        <System IP="x.x.x.x">
                timestamp
        </System>
        ...
        <System IP="x.x.x.x">
                timestamp
        </System>
</Internal>



Message Name:

Get Server Connection Data

Message Number:

14

Receiver(s):

Controller

Sender(s):

GUI

Brief Description:

The GUI uses this message to request the ports being used by all the server components and the IP address of the Collector.

XML Example:

<Internal Number="14">
</Internal>



Message Name:

Server Connection Data

Message Number:

15

Receiver(s):

GUI

Sender(s):

Controller

Brief Description:

The Controller uses this message to return the ports being used by all the server components and the IP address of the Collector to the GUI.

XML Example:

<Internal Number="15">
        <IP>
                x.x.x.x
        </IP>
        <Port component="Archiver">
                portNumber
        </Port>
        ...
        <Port component="Controller">
                portNumber
        </Port>
</Internal>



Message Name:

Update Server Connection Data

Message Number:

16

Receiver(s):

Controller

Sender(s):

GUI

Brief Description:

The GUI uses this message to update with any changes the user made to the server ports.

XML Example:

<Internal Number="16">
        <Port component="Archiver">
                portNumber
        </Port>
        ...
        <Port component="Controller">
                portNumber
        </Port>
</Internal>



Message Name:

Get All Log Types

Message Number:

17

Receiver(s):

Controller

Sender(s):

GUI

Brief Description:

The GUI uses this message to request a list of all defined Log Types and their associated log file names.

XML Example:

<Internal Number="17">
</Internal>



Message Name:

All Log Types

Message Number:

18

Receiver(s):

GUI

Sender(s):

Controller

Brief Description:

The Controller uses this message to return a list of all defined Log Types and their associated log file names to the GUI.

XML Example:

<Internal Number="18">
        <LogTypeFile>
        <LogType type="logTypeName">
                logFilename
        </LogType>
        ...
        <LogType type="logTypeName">
                logFilename
        </LogType>
        </LogTypeFile>
</Internal>



Message Name:

Create/Remove/Edit Log Type

Message Number:

19

Receiver(s):

Controller

Sender(s):

GUI

Brief Description:

The GUI uses this message to either create, remove, or edit a Log Type. If the filename is empty, the Log Type given will be removed. If the filename is not empty and the Log Type exists already, the Log Type is updated, otherwise it is created.

XML Example:

<Internal Number="19">
        <LogType type="logTypeName">
                logFilename
        </LogType>
</Internal>



Message Name:

Get System Log Types

Message Number:

20

Receiver(s):

Controller

Sender(s):

GUI

Brief Description:

The GUI uses this message to request all the Log Types associated with a given client's IP address.

XML Example:

<Internal Number="20">
        <System IP="x.x.x.x">
        </System>
</Internal>



Message Name:

System Log Types

Message Number:

21

Receiver(s):

GUI

Sender(s):

Controller

Brief Description:

The Controller uses this message to return all the Log Types associated with a given client's IP address.

XML Example:

<Internal Number="21">
        <System IP="x.x.x.x">
                logTypeName
                ...
                logTypeName
        </System>
</Internal>



Message Name:

Edit Trigger

Message Number:

22

Receiver(s):

Controller

Sender(s):

GUI

Brief Description:

The GUI uses this message to edit a trigger that has already been defined.

XML Example:

<Internal Number="22">
        <Trigger type="Global/IP/filename">
        <Name>
                triggerName
        </Name>
        <Val>
                keyword
        </Val>
        <Num>
                number of times keyword must be encountered
        </Num>
        <Time>
                time limit (in seconds) in which Val must be encountered Num times
        </Time>
        </Trigger>
</Internal>



Message Name:

Get All Triggers

Message Number:

23

Receiver(s):

Controller

Sender(s):

GUI

Brief Description:

The GUI must display all of the available triggers for editing and removal. This msssage will be sent to request this information.

XML Example:

<Internal Number="23">
</Internal>



Message Name:

All Triggers

Message Number:

24

Receiver(s):

GUI

Sender(s):

Controller

Brief Description:

This message contains all of the Triggers that have been created by the user. This information is displayed in the GUI. When selected, the triggerName will be used to call message 25 containing the detailed information regarding this trigger.

XML Example:

<Internal Number="24">
        triggerName
        . . .
        triggerName
</Internal>



Message Name:

Get Specific Trigger Data

Message Number:

25

Receiver(s):

Controller

Sender(s):

GUI

Brief Description:

If a triggerName is selected by the user, its detailed information is requested by this message.

XML Example:

<Internal Number="25">
        triggerName
</Internal>



Message Name:

Specific Trigger Data

Message Number:

26

Receiver(s):

GUI

Sender(s):

Controller

Brief Description:

This message contains the specific data of the trigger requested by the GUI.

XML Example:

<Internal Number="26">
        <Name>
                triggerName
        </Name>
        <Val>
                keyword
        </Val>
        <Num>
                number of times keyword must be encountered
        </Num>
        <Time>
                time limit (in seconds) in which Val must be encountered Num times
        </Time>
</Internal>



Message Name:

Get System Triggers

Message Number:

27

Receiver(s):

Controller

Sender(s):

GUI

Brief Description:

This message requests the triggers being monitored by SRLM for a specific instrumented system. It includes the global, IP specific, and filename specific triggers.

XML Example:

<Internal Number="27">
        <System IP="x.x.x.x">
        </System>
</Internal>



Message Name:

System Triggers

Message Number:

28

Receiver(s):

GUI

Sender(s):

Controller

Brief Description:

This message contains all of the global, IP specific, and filename specific trigger names for a monitored system.

XML Example:

<Internal Number="28>
        <System IP="x.x.x.x">
                triggerName (type)
                . . .
                triggerName (type)
        </System>
</Internal>
 
SAIC : An Employee-Owned Company
Advanced Technologies and Solutions Group
7120 Columbia Gateway Dr
Columbia, MD 21046
Site Hosted By:
SourceForge.net Logo