This chapter contains the following topics:
Section 5.1, "Understanding Monitoring System Web Services Gateway (WSG) Servers from the Web"
Section 5.2, "Monitoring System Web Services Gateway (WSG) Servers from the Web"
The System Web Services Gateway Server Monitor enables you to use the web to monitor a WSG Broker Server. The server-monitoring APIs for ActiveWorks are available in Java code, and JD Edwards EnterpriseOne uses them to provide the WSG Server Monitor.
To monitor an WSG server, you must enter a valid host name and port number in the WSG Server Monitor workspace. From the dialog box in the workspace, you can select from five views:
Broker Summary
Event Types
Client Groups
Client States
Broker Logs
The Broker Summary view enables you to monitor information about one or more brokers running on the Broker Server. The broker provides essential system services, such as receiving, sending, and queuing events. Events are messages sent to and received by resources in the system, including client workstations and other servers.
To view broker summary information, enter a host name and port number in the WSG Server Monitor workspace, and then select Broker Summary from the dialog box and click the Monitor button.
The Broker Summary view appears.
The Broker Summary view contains a table with various parameters, the values of which provide information about one or more brokers running on the server. This table identifies the parameters and offers a brief explanation of each one:
| Parameter in Table of Broker Summary View | Parameter Meaning |
|---|---|
| Number | The number of the broker. |
| Broker Name | The name of the broker. The default name is Broker # 1. |
| Broker Host | The Broker Server on which the broker is running. |
| Territory | A set of brokers that share information about event types and client groups. |
| Description | A full description of the broker, provided when the broker is installed on the server. |
| Event Types | Types of messages received and sent by the broker. |
| Client States | Information about a client maintained by the broker. Clients connect to brokers. |
| Client Groups | A list of all client groups on the broker. A client group is a set of properties shared by broker clients. |
The Event Types, Client States, and Client Groups parameter columns contain magnifying glass buttons you can click to view more detailed information about each one. Each of these parameters has its own view, which you can access from the dialog box in the Broker Summary view or in the WSG Server Monitor workspace.
The Broker Summary view also displays:
Number of non-SSL (Secure Sockets Layer) connections.
Highest number of non-SSL connections.
Number of SSL connections.
Highest number of SSL connections.
Server disk space, in megabytes.
You can view details about the server on which the broker is running by clicking the Server Statistics URL.
An event type defines the properties of an event, including the data fields that the event carries, the event's unique name, and a storage type, which defines how the broker stores the event.
The word events, when it is used in discussing the WSG Server Monitor, corresponds to the word messages, as that word is used in discussing the Enterprise Server Monitor. Events are messages exchanged by resources in the system. For example, an event might be processing a purchase order. To process a purchase order, the client and broker communicate.
When you select Event Types from the WSG Server Monitor workspace and click the Monitor button, the Event Types view appears.
The Event Types view contains a table with various parameters, the values of which provide information about the event types handled by the broker. This table identifies the parameters and offers a brief explanation of each one:
| Parameter in Table of Event Types View | Parameter Meaning |
|---|---|
| Event Name | The unique name of the event. |
| Description | A description of the function of each event. |
| Storage Type | An event attribute that determines how the event is stored in the broker. Storage types are:
|
| Time to Live | The amount of time that an event type can exist in the broker. |
| Fields | The names and types of each data field within the event type. |
You can view information about the data fields for each event type by clicking the magnifying glass button in the Fields column. The Event Types Fields view appears; it identifies each field name for the event type and the field type, such as string.
A client group is a set of broker clients with particular properties. For example, a client group defines the server on which clients access the broker.
When you select Client Groups from the WSG Server Monitor workspace and click the Monitor button, the Client Groups view appears.
The Client Groups view contains a table with various parameters, the values of which provide information about the client groups that provide control of client access to the broker. This table identifies the parameters and offers a brief explanation of each one:
| Parameter in the Client Groups View | Meaning |
|---|---|
| Client Group Name | The name of the client group. Each group has a specific set of properties defined using the ActiveWorks Manager. |
| ACL | The Access Control List, which is a list of SSL certificates that define the entities with permission to access the broker or create a client within a client group. |
| Can Publish | The event types that a client group can publish. |
| Can Subscribe | The event types that a client group can subscribe to. |
| Statistics | Additional statistics on the client group, such as how long the group has been on the server and how many events have been published by clients that belong to the group. |
Click the magnifying glass in the ACL, Can Publish, Can Subscribe, and Statistics columns to view additional information about each of these parameters.
A client state is information maintained by the broker about a client connected to the server. For example, the client group to which a client belongs is a client state.
When you select Client States from the WSG Server Monitor workspace and click the Monitor button, the Client States view appears.
The Client States view contains a table with various parameters, the values of which provide information about the clients connected to the server. This table identifies the parameters and offers a brief explanation of each one:
| Parameter in the Client States View | Meaning |
|---|---|
| Identifier | A unique identifier for the client connected to the server. |
| Client Group | The client group to which the client belongs. |
| App. Name | The name of the application that describes the client's connection to the server. |
| Access Label | Indicates, if appropriate, the value of the access label required for a client to connect to the client group to which it belongs. |
| Authenticator | The name of the certification authority that issued the certificate if SSL is enabled for the client. |
| Can Share | Indicates whether state sharing is enabled. If state sharing is enabled, the number of sessions allowed for a client can be set. |
| High Seq. | The highest published sequence number used by the client. |
| Max Shared Connections | The maximum number of server connections that the client can share. |
| Owner Name | The client owner's user name. |
| Sessions | Information about a client session. Click the magnifying glass button in the Sessions column to view detailed session information. |
You can use the WSG Server Monitor to view a broker log containing information about events that have run on the server during a specified time. You can view all log messages, or you can limit the view to warnings, alerts, or information messages.
When you select Broker Log from the WSG Server Monitor workspace and click the Monitor button, the Broker Log view appears.
From the Broker Log, you can specify:
The starting date from which you want to view log files.
The maximum number of entries you want to view.
The type of file you want to view.
Click the View Log button to see the log file entries.