Monitor the Gateway
This checklist provides the steps necessary to monitor Kaazing Gateway:
|#||Step||Topic or Reference|
|1||Learn about monitoring Kaazing Gateway.||Introduction to Monitoring Kaazing Gateway|
|2||Configure secure monitoring services.||Secure Kaazing Gateway Monitoring|
|3||Monitor a Gateway or Gateway cluster.||Monitor with JMX|
|4||Troubleshoot common problems with startup, security, clusters, and clients.||Troubleshoot the Gateway|
Note: For an example of the JMX management service configuration for the Gateway, see management.jmx.
Introduction to Monitoring Kaazing Gateway
You can track and monitor Kaazing WebSocket Gateway sessions using Java Management Extension (JMX). Monitoring services can be enabled in the Gateway configuration file. You can use this service to collect and view:
- Statistics about performance
- Resource usage
- Configuration and property information
- Notification events such as state changes
You can also terminate Gateway sessions .
A major benefit of monitoring with JMX is the ability to view all members of a cluster in a single interface.
Kaazing Gateway supports monitoring user sessions and configuration data using JMX Managed Beans. You can use the
management.jmx service available with the Gateway.
You can use JMX through any JMX-compliant console such as Java’s built-in Java Management and Monitoring Console (JConsole) or MC4J, or through any program that supports communication using the JMX protocol. This documentation uses Java’s built-in Java Management and Monitoring Console (JConsole) in its examples. With JMX, you can program a management console using a JMX API to:
- Examine available Gateway sessions
- Configure notifications
- Terminate sessions on the Gateway
- Configuration visualization - view the configuration, including cluster configuration and security configuration
- Service Reference to configure the
management.jmxservice in the Gateway configuration.
- Monitor with JMX for detailed information about monitoring with JMX.
Secure Gateway Monitoring
For secure monitoring, the Gateway provides a way to specify a security realm and authorization constraint on which each management service accepts connections. See Secure Kaazing Gateway Monitoring for detailed information and an example configuration.