Chat Metrics Test

Chat is key feature of any communication platform and same on Zoom is widely used. Zoom provide peer to peer chats, chat channels, meeting chat etc. All media including text, images, videos, documents can be shared over chats. It is important for administrators to have full analytics of chat available to them so that they can draw insights like usage of different features of chat, usage of chats channels etc. Also, large files sent over chat consume network bandwidth, which would concern administrators. That's the reason it is important to monitor the Zoom chat, so as to collect key details for administrators.

This test monitors the Zoom chats and captures key metrics like total number of chat messages sent, Peer to peer messages sent, chat channel messages etc. These metrics provide a clear picture to organization administrators around chat usage.

Target of the test : Zoom

Agent deploying the test : A remote agent

Outputs of the test : One set of results for the monitored account in Zoom.

Configurable parameters for the test
Parameters	Description
Test period	How often should the test be executed, the default value is 12 hrs.
Host	The host for which the test is to be configured. By default, this is Zoom.us.
Client ID	When configuring the Zoom API, you should have created an API client with OAuth authentication. Each client app is assigned with a Client ID which you need to copy from client app configuration wizard and save down. Zoom API requires Client ID and Secret Token when calling REST APIs. To know more about how to create Client ID and Secret Token, refer to Setting up Zoom API
Client Secret	Secret Token is generated along with Client ID during API configuration. Each client app is assigned with a Client ID which you need to copy from client app configuration wizard. Zoom API requires Client ID and Secret Token when calling REST APIs. To know more about how to create Client ID and Client Secret, refer to Setting up Zoom API
Authorization Code	Authorization Code acts as an access token which tells Zoom on subsequent requests that current client has already been authorized. The Authorization Code is sent to client as string along with redirect URL once the client request has been authorized. In this text box, you need to specify the authorization code that you obtained during API configuration. For more details, refer to Setting up Zoom API
Redirect URL	In the authorization flow, the Zoom API request is first passed on to Zoom Auth Server. Once the authorization is successful, the client request is redirected back to URL provided by user in Redirect URL along with authorization code. Client can now hit the API with given authorization code to pull metrics.
API URL	Zoom offers globally accessible URL for Zoom REST APIs. To enable the eG agent to connect Zoom REST APIs and pull out metrics, this test should be configured with the accessible URL against this parameter. The default value of this parameter is https://api.zoom.us/v2/. Before using the APIs, first you need to create an API client, set up the authentication and authorization details as elaborated in topic Setting up Zoom API.
Show N DD	By default, this parameter is set to 50. This indicates that, by default, the detailed diagnosis of this test will display the details of only 50 events. If you wish this test to report details of all events, then specify "all" against this parameter.
Proxy Host and Port	If the eG agent need to communicates with Zoom via a proxy, then, you also need to configure the eG agent on the connector with the proxy server details. This will enable the eG agent to connect to the Zoom without a glitch, and pull metrics. To facilitate this communication. do the following: Specify the IP address/fully-qualified host name of the proxy server, against PROXY HOST. Specify the port at which the Proxy server listens for requests from the eG agent, against PROXY PORT. By default, both these parameters are set to none, indicating that the eG agent does not communicate with the Zoom via a proxy.
Proxy User Name and Password	Specify the Proxy username and password if proxy server is being used to connect with Zoom.
Confirm Password	Confirm the password by typing it in Confirm password box.
DD Frequency	Refers to the frequency with which detailed diagnosis measures are to be generated for this test. The default is 1:1. This indicates that, by default, detailed measures will be generated every time the test runs, and also every time the test detects a problem. You can modify this frequency, if you so desire. Also, if you intend to disable the detailed diagnosis capability for this test, you can do so by specifying none against DD Frequency.
Detailed Diagnosis	To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option. The option to selectively enabled/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled: The eG manager license should allow the detailed diagnosis capability Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.

Measurements made by the test
Measurement	Description	Measurement Unit	Interpretation
Total messages sent	Indicates the total number of chat messages sent by users across all kind of chats.	Number	Administrators need to ensure that the number of messages are well within the limit for maximum messages in Zoom account. The detailed diagnosis of this measure reveal further details like Username, Email, Sent count, User Id and As on.
P2P chat messages sent	Indicates the number of peer to peer chat messages sent by the users..	Number	These metrics help administrators understand what users are using Zoom for the most, and ensure that corresponding services are able to handle load, The detailed diagnosis of this measure reveal further details like Username, Email, Sent count, User Id and As on.
Chat channel messages sent	Indicates the chat channel messages sent by the users.	Number	These metrics help administrators understand what users are using Zoom for the most, and ensure that corresponding services are able to handle load,
Files sent	Indicates the total number of files sent by users over chat.	Number	Files consume bandwidth, much more as compared to chat messages. If the system is facing bandwidth issues it could be because large number of files being transferred at any given point in time.
Text messages sent	Indicates the total number of text messages sent by users over chat.	Number	The detailed diagnosis of this measure reveal further details like Username, Email, Sent count, User Id and As on.
Images sent	Indicates the total number of images sent by users over chat.	Number	Large size images not only consume bandwidth but also occupies storage in Zoom account. If too many images are being exchanged it would affect both network latency as well as account billing.
Code snippet sent	Indicates the total number of code snippets sent by users over chat.	Number	Code snippet are like text messages but consume more bandwidth by being verbose to accommodate the spacing and indentation. Administrators might want to separate that from text chat messages.
Giphy images sent	Indicates the total number of Giphy images sent by users over chat.	Number	Large size images not only consume bandwidth but also occupies storage in Zoom account. If too many images are being exchanged it would affect both network latency as well as account billing.
Audio files sent	Indicates the total number of audio files sent by users over chat.	Number
Video files sent	Indicates the total number of video files sent by users over chat.	Number

The detailed diagnosis of Total messages sent reveal further details like Username, Email, Sent count, User Id and As on:

Figure 1 : Detailed diagnosis of Total messages sent measure

The detailed diagnosis of P2P chat messages sent reveal further details like Username, Email, Sent count, User Id and As on:

Figure 2 : Detailed diagnosis of P2P messages sent measure

The detailed diagnosis of Test messages sent sent reveal further details like Username, Email, Sent count, User Id and As on:

Figure 3 : Detailed diagnosis of text messages sent measure