Performance Counters (KPIs)

This article describes the basics of how Co-browse works with the third-party Metrics Library to let you observe what is going on with your server's Co-browse sessions. It also gives an example of how to set up a sample JMX interface in order to view the metrics the Co-browse server creates.

Related Topics

Metrics Java library 

Co-browse and Metrics Library

Genesys Co-browse integrates with the third-party Metrics Java library, a toolkit that support all kinds of metrics out of the box: for example, counter, timer, histogram, gauge, and so on.

This Metric library gives you several ways to report on current values: JMX (the main method), REST (for performance testing), and Logging.

About Co-browse Metrics

Starting with release 8.5.100.05, the Co-browse Server integrates with the Metrics Library client for the Java Management Extensions (JMX) reporter interface. JMX lets you observe Co-browse metrics using JMX tools.

Overview of Available Co-browse Metrics

Co-browse Server generates these kinds of metrics:

• Current count of sessions in different states (counter metric)
• Count of completed sessions since the start of the server (counter metric)
• Session timings (timer/histogram)
  • Slave overall rendering time (histogram)
  • Slave stages rendering time (histogram)
  • Co-browse session initialization on server side (timer)
  • Time of Master, Slave and Controller joining to the Co-browse session (timer)
• Sessions interrupted without accept (counter metric).

Breakdown of Available Co-browse Metrics

Metric name	Description
ActiveSessions	Sessions got "Activated" status when Master created session and Slave joined to it
CanceledInactiveSessions	Sessions canceled by initiator
InactiveSessions	Session gets "Inactive" status when Master creates session and waiting Slave to join
LiveSessions	All sessions in status "Inactive" and "Activated".
NormallyEndedActiveSessions	Sessions ended during period of two sides Co-browse activity
TerminatedByUserDisconnectionSessions	Sessions finished by User timeout disconnect
TimeoutedInactiveSessions	Sessions finished by timeout in awaiting for Slave connection
TotalFinishedSessions	Total count of all finished sessions
CreateSessionAverage	Histogram of timing for creating session procedure on server side
JoinSessionAverage	Histogram of timing for server join procedure against each member of Co-browse session activity
SlaveInitAverage	Histogram of timing for Slave initialization since page reload with session ID
SlaveGetSessionAverage	Histogram of timing for Slave get session environment since page reload with session ID
SlaveHandshakeAverage	Histogram of timing for Slave handshake via CometD since page reloaded with session ID
SlaveJoinAverage	Histogram of timing for Slave joined to session since page reload with session ID
SlavePageDataAverage	Histogram of timing for Slave got page data since page reload with session ID
SlaveRenderAverage	Histogram of timing for Slave fully rendered since page reload with session ID

How To Expose Co-browse metrics through the JMX interface

There are many JMX tools that you can use to observe the metrics Co-browse server creates:

• JConsole tool bundled with Oracle Java (TM)
• EJTools JMX Browser
• Panoptes
• jManage
• MC4J
• Zabbix

Connect to Co-browse started as a service.

1. Run jconsole.exe from the <jdk>/bin directory.
2. In the New Connection dialog, specify Co-browse launcher java process:

if the Co-browse Server was started via .bat file in the same host where JMX console is opened – select com.genesys.launcher.bootstrap.Bootstrap process from the Local Process list.

Connect to Co-browse started as a server.

1. Run jconsole.exe from the <jdk>/bin directory.
2. Open setenv.bat and uncomment all lines under :: Uncomment for enabling JMX Remote. Memorize JMX port. Save changes.
3. Restart the Co-browse Server application.
4. Specify host:<JMX port> in the Remote Process section:

Connect to Co-browse started as a Windows service.

If Co-browse Server is started as a Windows service, you should at first stop the service, reinstall it and start again.

To reinstall the service, do the following:

1. Open setenv.bat and find the service name in the line set SVC_NAME=
2. Run command:

cobrowse.bat -service SERVICENAME remove

to remove the service.

1. Open setenv.bat and uncomment all lines under :: Uncomment for enabling JMX Remote. Memorize JMX port. Save changes.
2. Run command:

cobrowse.bat -service SERVICENAME install

to install the service.

1. Specify host:<JMX port> in the Remote Process section, see above.

Open the JMX panel to view the metrics.

1. Click Connect. JNX panel opened.
2. Open MBeans tab and expand Cobrowse branch. All Co-browse metrics are there.
3. To refresh the metrics, click Refresh.