2.5 Monitoring the Messaging Agent

By monitoring the Messaging Agent, you can determine whether its current configuration is meeting the needs of your Messenger users. You have a variety of tools to help you monitor the operation of the Messaging Agent:

2.5.1 Using the Messaging Agent Console on Windows

The following topics help you use the Messaging Agent console on Windows:

NOTE:The Messaging Agent console is not available on Linux. Use the Web Console instead, as described in Using the Messaging Agent Web Console.

Monitoring the Messaging Agent from the Messaging Agent Console

The Messaging Agent console provides information, status, and message statistics about the Messaging Agent to help you assess its current functioning.

Figure 2-3 Messaging Agent Console

The Messaging Agent console includes several areas of information:

Table 2-3 Messaging Agent Console Information

Information

Description

Information Box

Identifies the Messaging Agent, displays description information provided in ConsoleOne, and shows how long the Messaging Agent has been running.

Status Box

Displays the number of current Messenger client users and the number of conversations that are queued for archiving. The rotating processing bar shows that the Messaging Agent is running.

Statistics Box

Displays the number of requests that the Messaging Agent has received from Messenger clients or from the Archive Agent, along with the number of requests that it has been unable to respond to. Pending requests might indicate a need to optimize Messaging Agent performance to better serve Messenger users.

Log Message Box

Displays the same information that is being written to the Messaging Agent log file. The amount of information displayed depends on the current log settings for the Messaging Agent. See Using Messaging Agent Log Files. The information scrolls up automatically.

Controlling the Messaging Agent from the Messaging Agent Console

You can perform the following tasks to monitor and control the Messaging Agent from the Messaging Agent console at the server where the Messaging Agent is running:

Table 2-4 Performing Messaging Agent Tasks

Task

Windows

Stop the Messaging Agent

File > Exit

Edit the startup file

Configuration > Edit Startup File

Display current agent settings

Configuration > Agent Settings

Display the current log file

Log > Auto Scroll Off > scroll as needed

Display a selected log file

Log > View Log

Change log settings for the current agent session

Log > Log Settings

Start a new log file

Log > Cycle Log

Display online help

Help > Help

2.5.2 Using the Messaging Agent Web Console

The Messaging Agent Web Console enables you to monitor and control the Messaging Agent from any location where you have access to a browser and the Internet. This provides substantially more flexible access than the Messaging Agent console, which can only be accessed from the server where the Messaging Agent is running.

Setting Up the Messaging Agent Web Console

  1. In ConsoleOne, browse to and expand the MessengerService object.

  2. Select the Messenger Server object to display its contents.

  3. Right-click the Messaging Agent object, then click Properties.

  4. Click Agent > Web Console.

    Messaging Agent Web Console page

  5. Fill in the following fields:

    HTTP Port: Specify the port number for the Messaging Agent to listen on for service requests from your browser; for example, 8313.

    Username: If you want to restrict access to the Messaging Agent Web Console, specify a user name for the Messaging Agent to prompt for before allowing access to the Web Console.

    Password: Specify the password for the Messaging Agent to prompt for before allowing access to the Web Console.

    Enable SSL for Web Console: Select this option if you want the Messaging Agent to use SSL encryption when communicating with your browser.

    In order to use SSL encryption for the Web Console, you must properly configure the Messaging Agent, as described in Section 2.3, Configuring Messaging Security with SSL Encryption.

  6. Click OK to save the Web Console settings.

  7. Stop and then start the Messaging Agent to put the HTTP settings into effect.

Corresponding Startup Switches: You can also use the /httpport, /httpuser, /httppassword, and /httpssl startup switches in the Messaging Agent startup file to enable and secure the Messaging Agent Web Console.

Accessing the Messaging Agent Web Console from Your Web Browser

To monitor the Messaging Agent from your browser, view the following URL: 

http://Messenger_server:agent_port

where Messenger_server represents the IP address or hostname of the server where the Messaging Agent is running and agent_port represents the port number you specified in Step 5 in Setting Up the Messaging Agent Web Console. For example:

http://172.16.5.18:8313

Figure 2-4 Messaging Agent Web Console Status Page

Monitoring the Messaging Agent at the Web Console

The Messaging Agent Web Console provides several pages of information to help you monitor the performance of the Messaging Agent. The bar at the top of the Messaging Agent Web Console displays the name of the agent. Below this bar appears the Web Console menu that lists the pages of information available in the Messaging Agent Web Console.

Monitoring Messaging Agent Status

When you first access the Messaging Agent Web Console, the Status page is displayed.

Figure 2-5 Messaging Agent Web Console Status Page

The Web Console provides more detailed status information than the Messaging Agent console.

Click Current Users to display a list of current Messenger users and their IP addresses. Click the User ID, then click Disconnect User to disconnect the user.

Click C/S Handler Threads to display the Messaging Agent client/server threads, the number of requests each thread has handled, and each thread's current activity.

Click Chat Rooms to display a list of current chat rooms and their CN names, owners, and number of active participants. Click Re-initialize Chat List to re-initialize the chat room process. By re-initializing the chat room process, chat rooms that are added in ConsoleOne are added to the list of chat rooms. Users can also use ConsoleOne to access the chat rooms after they have been added.

Checking Monitor Agent Configuration

On the Messaging Agent Web Console menu, click Configuration to display Messaging Agent configuration information.

Figure 2-6 Messaging Agent Web Console Configuration Page

Checking the Messaging Agent Operating System Environment

On the Messaging Agent Web Console menu, click Environment to display information about the operating system where the Messaging Agent is running.

On a Linux server, the following information is displayed:

Figure 2-7 Messaging Agent Web Console Environment Page for Linux

On a Windows server, the following information is displayed:

Figure 2-8 Messaging Agent Web Console Environment Page for Windows

Viewing and Searching Messaging Agent Log Files

On the Messaging Agent Web console menu, click Log Files to display and search Messaging Agent log files.

Figure 2-9 Messaging Agent Web Console Log Files Page

To view a particular log file, select the log file, then click View Events.

To search all log files for a particular string, type the string in the Events Containing field, select Select All, then click View Events. You can also manually select multiple log files to search. The results of the search are displayed on a separate page, which can be printed.

To start a new log file, click Cycle Log.

To view your log settings for the current Messaging Agent session, click Event Log Settings to display the Configuration page. To change your log settings for the current Message Agent session, click Event Log on the Configuration page.

Figure 2-10 Message Agent Web Console Event Log Settings Page

Accessing the Messaging Agent Web Console from GroupWise Monitor

If you use GroupWise Monitor to monitor your GroupWise agents, you can add the Messaging Agent to the list of monitored agents. Continue with Using GroupWise Monitor.

2.5.3 Using Messaging Agent Log Files

Error messages and other information about Messaging Agent functioning are written to log files as well as displaying on the Messaging Agent console. Log files can provide a wealth of information for resolving problems with Messaging Agent functioning.

  1. In ConsoleOne, browse to and expand the MessengerService object.

  2. Select the Messenger Server object.

  3. Right-click the Messaging Agent, then click Properties.

  4. Click Agent > Log Settings.

    Messaging Agent Log Settings page

  5. Fill in the following fields:

    Log Level: Controls the amount of information logged by the Messaging Agent. Logged information is displayed in the log message box and written to the Messaging Agent log file during the current agent session. The default is Normal, which displays only the essential information suitable for a smoothly running Messaging Agent. Use Verbose to display the essential information, plus additional information helpful for troubleshooting. Use Diagnostic where very detailed, code-specific information is required.

    Enable disk logging: Select this option so that the information displayed in the message log box at the Messaging Agent console is also saved to disk in log files.

    Log Files Path: Specify the directory where the Messaging Agent stores its log files. On Windows, the default location is the logs subdirectory of the Messaging Agent installation directory. On Linux, the default location is /var/opt/novell/log/messenger/ma.

    Typically, you find multiple log files in the specified directory. The first four characters represent the date. The next three identify the agent. A three-digit extension allows for multiple log files created on the same day. For example, a log file named 0518nma.001 indicates that it is a Messaging Agent log file, created on May 18. If you restarted the Messaging Agent on the same day, a new log file started, named 0518nma.002.

    Log Maximum Age: Specify how many days to keep Messaging Agent log files on disk. The default is 14 days.

    Log Maximum Size: Specify the maximum amount of disk space for all Messaging Agent log files. When the specified disk space is consumed, the Messaging Agent deletes existing log files, starting with the oldest. The default is 128 MB.

  6. Click OK to save the log file settings.

  7. Stop and then start the Messaging Agent to put the new log settings into effect.

Corresponding Startup Switches: You can also use the /log, /loglevel, /logdays, and /logmax startup switches in the Messaging Agent startup file to configure Messaging Agent log files.

2.5.4 Using GroupWise Monitor

GroupWise Monitor can be configured to monitor the Messaging Agent as well as the GroupWise Agents (Post Office Agent, Message Transfer Agent, Internet Agent, and WebAccess Agent). For background information about GroupWise Monitor, see Monitor in the GroupWise 2014 Administration Guide.

  1. Enable the Messaging Agent Web Console, as described in Setting Up the Messaging Agent Web Console.

  2. At the Windows Monitor Agent console, click Configuration > Add Novell Messenger System.

    Add Novell Messenger dialog box in the GroupWise Monitor Agent

  3. Fill in the following fields:

    Novell Messenger System Object: Browse to and select the MessengerService object.

    User Name: Browse to and select a User object that has sufficient rights to enable the Monitor Agent to access Messenger agent object properties in eDirectory.

    Password: Specify the eDirectory password associated with the selected User object.

  4. Provide the same eDirectory access information as you provided during installation:

    Use Direct Access: Select this option if the Messaging Agent uses direct access to eDirectory.

    • Replica Address: If the Messaging Agent is installed on a Windows server, provide the IP address of a server where the Messaging Agent can access a replica of eDirectory.

  5. Click OK to save the information about your Messenger system.

    The Messaging Agent appears in the root agent group, along with the Archive Agent if it is running on the same server. You might want to create an agent group specifically for the Messenger agents. See Creating and Managing Agent Groups in Monitor in the GroupWise 2014 Administration Guide.

2.5.5 Using SNMP Monitoring Programs

You can monitor the Messaging Agent from the Management and Monitoring component of any SNMP management and monitoring program. When properly configured, the Messaging Agent sends SNMP traps to network management consoles for display along with other SNMP monitored programs. It also responds to requests for configuration and status information from SNMP management and monitoring programs.

Although the Messaging Agent is SNMP-enabled by default, the server where the Messaging Agent is installed must be properly configured to support SNMP, and the Messaging Agent object in eDirectory must be properly configured as well. To set up SNMP services for your Messenger server, complete the following tasks:

Setting Up SNMP Services for the Messaging Agent

Select the instructions for the platform where the Messaging Agent runs:

Setting Up SNMP Services on a Linux Server

The Linux Messaging Agent is compatible with NET-SNMP. An older version of SNMP called UCD-SNMP cannot be used with the Linux Messaging Agent. NET-SNMP comes with the versions of Red Hat Linux supported for Messenger 1.0 for Linux, but it does not come with the supported versions of SUSE Linux. If you are using SUSE Linux, you must update to NET-SNMP in order to use SNMP to monitor the Linux Messaging Agent.

  1. Ensure you are logged in as root.

  2. If NET-SNMP is not already set up on your Linux server, use the following command to configure SNMP:

    snmpconf -g basic_setup

    The snmpconf command creates the snmpd.conf file in one of the following directories, depending on your version of Linux:

    /usr/share/snmp ~

    /usr/local/share/snmp

    /.snmp

  3. Locate the snmpd.conf file on your Linux server.

  4. In a text editor, modify the snmpd.conf file:

    1. Add the following line:

      dlmod Nmweb /opt/novell/messenger/lib/libnmsnmp.so.1

    2. Save and exit the snmpd.conf file.

  5. Restart the SNMP daemon (snmpd) to put the changes into effect.

  6. In a text editor, modify the nmsnmp.conf file in the /etc/opt/novell/messenger directory:

    1. Set /daemonPort to a unique port number for the Messaging Agent to listen on; for example, 8305.

    2. If you have not already configured the Messaging Agent Web Console, as described in Setting Up the Messaging Agent Web Console, assign an HTTP port for the Messaging Agent.

      You can set the HTTP port in ConsoleOne, using the same steps as for setting up the Web Console, or you can set /maPort to a unique port number, such as 8301. If you want to use SNMP with the Archive Agent, you can also provide an HTTP port for it by using /aaPort if you update the nmsnmp.conf file, rather than providing the settings in ConsoleOne.

    3. Save and exit the nmsnmp.conf file.

  7. In ConsoleOne, enable SNMP:

    1. Browse to and right-click the Messenger Server object, then click Properties.

    2. Click Server > General.

    3. Select Enable SNMP.

    4. Click OK to save the setting.

  8. Restart the Messaging Agent.

  9. Skip to Copying and Compiling the Messaging Agent MIB File.

Setting Up SNMP Services on a Windows Server

The SNMP service is usually not included during the initial Windows operating system installation. The SNMP service can be easily added at any time. To add or configure the SNMP service, you must be logged in as a member of the Administrator group.

For information about how to add the SNMP service to a Windows server, see the Windows documentation.

The Messenger Installation program includes an option for installing SNMP support. However, if the Windows server where you installed the Messaging Agent did not yet have SNMP set up, that installation option was not available. Now that you have set up SNMP, you can install Messaging Agent SNMP support.

Rerun the Messenger Installation program, using the Install Server option as described in the Novell Messenger 3.0 Installation Guide, noticing that the Install and Configure SNMP for the Messenger Agents option is now available and selected.

Figure 2-11 Server Information Dialog Box with the SNMP Option Selected

When you have finished installing the Messenger Agent, continue with Copying and Compiling the Messaging Agent MIB File.

Copying and Compiling the Messaging Agent MIB File

An SNMP-enabled Messaging Agent returns information contained in a Management Information Base (MIB). The MIB is an ASCII data structure that defines the information gathered. It also defines the properties that can be monitored and managed on the SNMP-enabled Messaging Agent.

Before you can monitor an SNMP-enabled Messaging Agent, you must compile the nmma.mib file by using your SNMP management program. On Windows, the Messenger agent MIBs are located in the downloaded Novell Messenger 3.0 image in the \server\snmp directory. On Linux, the Messenger MIBs are located in the /etc/opt/novell/messenger/mibs directory after installation.

  1. Copy the nmma.mib file to the location required by your SNMP management program.

  2. Compile or import the nmma.mib file as required by your SNMP management program.

    For example:

    1. In ConsoleOne, right-click the Site Server object, then click Properties > MIB Pool.

    2. Click Modify Pool > Add.

    3. Browse to and select the nmma.mib file, then click OK.

    4. Click Compile.

    5. Make sure that the server where the Messaging Agent is running is configured to send SNMP traps to the ZfS Site Server by adding the IP address or hostname of the ZfS Site Server to the list of trap destinations. From the Windows 2000 Control Panel, double-click Administrative Tools, then click Services > SNMP Service > Properties > Traps.

      Refer to your SNMP management program documentation for specific instructions.

Configuring the Messaging Agent for SNMP Monitoring

In order for SNMP monitoring programs to monitor the Messaging Agent, the Messaging Agent must be configured with an SNMP community string.

  1. In ConsoleOne, browse to and expand the MessengerService object.

  2. Right-click the Messenger Server object, then click Properties.

  3. Click Server > General.

    Server General page

  4. Make sure that Enable SNMP is selected.

  5. In the SNMP Community field, provide your system SNMP community GET string.

  6. Click OK to save the SNMP settings.

  7. Stop and then start the Messaging Agent to put the SNMP settings into effect.