Cluster Monitor Application

The Cluster Monitor application is a ready-to-run and configurable StreamBase Application that monitors the performance of clusters and nodes in a StreamBase Runtime fabric. The application consists of a StreamBase monitoring EventFlow fragment and a LiveView server fragment. The application:

Using the default configuration, the LiveView server automatically enables LiveView Web as the client to display cluster monitoring data.

Once the Cluster Monitor node is started and the Cluster Monitor application is running, open a browser to view cluster data in LiveView Web for your running application nodes.

Enter: http://localhost:11080/lvweb. The Cluster Monitor application uses 11080 as its default LiveView Web port, to avoid conflicts with the standard LiveView Web port, 10080.

LiveView Web displays cluster statistics using the following set of LiveView Web cards:

The following monitoring behavior parameters are configurable:

You can change the Cluster Monitor application's configuration:

After activating a new configuration, restart the Cluster Monitor application with the following command:

epadmin --servicename=MONITOR_NODE_NAME restart container --engine=cluster-monitor

For reference, the following shows the cluster-monitor-node.conf configuration file properties:

//
//  Copyright (c) 2020-2023 Cloud Software Group, Inc.
//  All Rights Reserved.  Confidential & Proprietary.
//
// Node deploy configuration for the Streaming Cluster Monitor.
//
name = "ClusterMonitor"
version = "1.0"
type = "com.tibco.ep.dtm.configuration.node"
configuration =
{
    NodeDeploy =
    {
        nodes  =
        {
            "${EP_NODE_NAME}" =
            {
                description = "Node for running the ClusterMonitor"

                engines =
                {
                    "cluster-monitor" =
                    {
                        fragmentIdentifier = "com.tibco.ep.cluster.liveview-server"
                    }
                }
            }
        }
    }
}

The Cluster Monitor configures the following statistics tables by default:

Services Table: The monitor always contains a Services table showing services that have been discovered and their current state.

StreamBaseInfo Table: EventFlow/LiveView server Java heap memory use, and aggregate total number of queued tuples.

NodeInfo Table: Per node shared memory usage, transaction rate, and deadlock counter, and CPU usage for the machine where the node is running.

epadmin --servicename=monitor.monitorCluster display history --seconds=1

The Cluster Monitor application attempts to connect to each discovered service, authenticating each using the configured credentials. The epadmin commands use the administrationAuthentication section of the ClusterMonitor configuration file, as shown in StreamBase Cluster Monitor Configuration. By default, no credentials are configured. The application is only able to monitor services running on the local node, started by the same user who installed the Cluster Monitor.

The configuration supports a single set of credentials for epadmin commands, and a single set of credentials for EventFlow and LiveView services. For simplicity, it is a best practice configuring a common login credential throughout the target cluster.

To configure EventFlow and LiveView services information, use the EventFlow section of the ClusterMonitor configuration.

Releases 10.6.1 and above support an optional TLS connection between the client and the Cluster Monitor application. Use the following two supplied files to get you started:

To set up a TLS connection, you must supply several substitution values as appropriate to your environment. For the simple non-TLS case, modifying the supplied cluster-monitor-node.conf is not required. If you have other security needs, see the security governance documentation; you can modify both of the following files to meet your needs.

The cluster-monitor-secure.subs file:

//
//  Copyright (c) 2020-2023 Cloud Software Group, Inc.
//  All Rights Reserved.  Confidential & Proprietary.
//
// Sample nodedeploy configuration for enabling TLS in the cluster monitor.
// Use with cluster-monitor-secure.subs
//
name = "ClusterMonitor"
version = "${VERSION}"
type = "com.tibco.ep.dtm.configuration.node"
configuration = {
    NodeDeploy = {
        nodes  = {
            "${EP_NODE_NAME}" = {
                engines = {
                    "cluster-monitor" = {
                        fragmentIdentifier = "com.tibco.ep.cluster.liveview-server"
                        configuration = [
                            """
                            name = "ClusterMonitorTLSServerConfig"
                            version = "${VERSION}"
                            type = "com.tibco.ep.dtm.configuration.security"
                            configuration = {
                              SecureCommunicationServerProfile  = {
                                name = "${SERVER_SECURE_PROFILE_NAME}"
                                keyStore = "${SERVER_KEYSTORE}"
                                keyStorePassword = "${SERVER_KEYSTORE_PASSWORD}"
                                requireClientAuthentication = false
                              }
                            }
                            """,
                            """
                            name = "ClusterMonitorTLSClientConfig"
                            version = "${VERSION}"
                            type = "com.tibco.ep.dtm.configuration.security"
                            configuration = {
                              SecureCommunicationClientProfile  = {
                                name = "${CLIENT_SECURE_PROFILE_NAME}"
                                trustStore = "${TRUSTSTORE}"
                                trustStorePassword = "${TRUSTSTORE_PASSWORD}"
                                requireClientAuthentication = false
                              }
                            }
                            """,
                            """
                            name = "cluster-monitor-internal-credentials"
                            type = "com.tibco.ep.ldm.configuration.ldminternalcredentials"
                            version = "${VERSION}"
                            configuration = {
                              InternalCredentials = {
                                ldmSecureInternalCommunicationProfileName = "${CLIENT_SECURE_PROFILE_NAME}"
                              }
                            }
                            """
                        ]
                    }
                }
            }
        }
    }
}

The cluster-monitor-secure.conf file:

#
#  Copyright (c) 2020-2023 Cloud Software Group, Inc.
#  All Rights Reserved.  Confidential & Proprietary.
#
#  Sample cluster monitor configuration substitution variables
#  for use with TLS sample file cluster-monitor-secure.conf
#
#  If using plain text passwords:
#
#  $ epadmin install node \ 
#      --application cluster-monitor.zip \ 
#      --nodedeploy cluster-monitor-secure.conf \
#      --substitutionfile cluster-monitor-secure.subs
#
#  Or, if using encrypted passwords, replace
#  the --keystore and --keystorepassword values.
#  See Encrypting Sensitive Configuration Data
#  in the StreamBase Administration Guide.
#
#  $ epadmin install node \ 
#      --application cluster-monitor.zip \ 
#      --nodedeploy cluster-monitor-secure.conf \
#      --substitutionfile cluster-monitor-secure.subs \
#      --keystore MyNodeSecretKeyStore.jks \
#      --keystorepassword MyNodeSecretKeyStorePassword

#
# Configuration verison number.
# Must be anything other than 1.0.0
#
VERSION = 1.0.1

#
# Name of your server secure profile
#
SERVER_SECURE_PROFILE_NAME = ClusterMonitorServerProfile

#
# Name of your client secure profile
#
CLIENT_SECURE_PROFILE_NAME = ClusterMonitorClientProfile

#
# Absolute path to your server keystore.
#
SERVER_KEYSTORE = /some/where/ServerKeyStore.jks

#
# Server keystore password.
#
# May be plain text or encrypted.
#
SERVER_KEYSTORE_PASSWORD = #!!j/PmnHg/Lg6EnjhB9/LS7owPWQk/nXozuXKXWs6FABaSmQ==

#
# Absolute path to the truststore
#
TRUSTSTORE = /some/where/TrustStore.jks

#
# Encrypted truststore password.
#
# May be plain text or encrypted.
#
TRUSTSTORE_PASSWORD = #!!j/PmnHg/Lg6EnjhB9/LS7owPWQk/nXozuXKXWs6FABaSmQ==

#
# Uncomment to change the default
# default LiveView port from 11080
#
#LIVEVIEW_PORT = 12080