Rooms-Test
Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing, and video conferencing. Zoom Rooms can be used for room-only attendees, or remote attendees joining from another room, from their desktop, or from their mobile device.
Given the utility of Zoom rooms and widespread usage, it is important to monitor the rooms for administrators to get insights into the number of meeting, call, webinars happening and resources being used including user licensees.
This test monitors the Zoom rooms and collects key statistics like total number of rooms critical rooms, warning rooms etc. The metrics help administrators understand the performance and efficacy of Zoom infrastructure and collect data to report to Zoom.
Target of the test : Zoom
Agent deploying the test : A remote agent
Outputs of the test : One set of results for the Zoom account being monitored.
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:
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:
|
Measurement | Description | Measurement Unit | Interpretation |
---|---|---|---|
Total Zoom rooms |
Indicates the total number of Zoom rooms in current account. |
Number |
Administrators need to ensure that the numbers of room created whould not be too large as it affects billing. |
Critical Zoom rooms |
Indicates the total number of rooms where the number of issues is in critical range. |
Number |
Rooms with critical issues cannot be used and will need to be investigated first. |
Warning Zoom rooms |
Indicates the total number of rooms where the number of issues is in warning range. |
Number |
Rooms with warning are the ones which are still working but are at risk of going critical at any point of time. |
Zoom rooms without issues |
Indicates the total number of Zoom rooms which are working well. |
Number |
Ideally most of the rooms should be without issues, apart from a small number which are being investigated. |