API Access Chrome - OS Test

eG Enterprise uses the APIs to pull metrics on the performance of devices in the Google Chromebooks Group. If there are issues in the connectivity between the eG agent and the API, or if any slowness is observed in the responsiveness of the API, eG's monitoring service is bound to get affected. This is why, it is important to periodically check the accessibility of the service APIs. This can be achieved using the API Access Chrome - OS test!

This test periodically checks the availability of the APIs. Additionally, the test measures the responsiveness of the API to requests from the eG agent. In the process, the test brings to focus bottlenecks in the functioning of the API by revealing the response code returned. If the eG agent is unable to pull metrics from the device or is experiencing some delay in the process, then these metrics will help you explain why - is it because the API is inaccessible/unavailable? or is it owing to the poor responsiveness of the API?

This test helps administrators figure out whether/not the API is accessible.

Target of the Test : Google Chromebooks Group

Agent deploying the test: A remote agent

Output of the test: One set of results for the target Google Chromebooks Group

Configurable parameters for the test
Parameters	Description
Test Period	How often should the test be executed. By default, this is set to 5 minutes.
Host	The host for which the test is to be configured.
Customer ID	To enable the eG agent to communicate to the devices managed by the target Google Chromebooks Group within the Google Workspace console and make REST API calls to collect metrics, the tests should be configured with the customer ID. To know how to obtain the customer ID mapped to the organization to which the target Google Chromebooks Group is mapped fron the Google Workspace console, refer to How does eG Enterprise Monitor Google Chromebooks Group? topic.
Private Keyfile Name	To connect to the Google Chromebooks Group, the eG agent requires a private key of a service account with Compute Viewer, Monitoring Viewer, and Cloud Asset Viewer roles in the target project. If a service account pre-exists in the project, then you can download the private key as a JSON file. Save this JSON file in the <eG_Install_Dir>/agent/lib folder and provide the name of that file against this parameter. However, if no such service account pre-exists, you will have to create one for monitoring the project. To know how to create a service account and download its private key, refer to How does eG Enterprise Monitor Google Chromebooks Group? topic.
Proxy Host and Proxy Port	In some environments, all communication with the Google Chromebooks Group be routed through a proxy server. In such environments, you should make sure that the eG agent connects to the devices in the group via the proxy server and collects metrics. To enable metrics collection via a proxy, specify the IP address of the proxy server and the port at which the server listens against the Proxy Host and Proxy Port parameters. By default, these parameters are set to none, indicating that the eG agent is not configured to communicate via a proxy, by default.
Proxy Username, Proxy Password and Confirm Password	If the proxy server requires authentication, then, specify a valid proxy user name and password in the Proxy Username and Proxy Password parameters, respectively. Then, confirm the password by retyping it in the Confirm Password text box.
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 enable/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.

Measures made by the test
Measurement	Description	Measurement Unit	Interpretation
API availability	Indicates whether/not the API is accessible.	Percent	A value of 100 percent indicates that the API is available and a value of 0 indicates that the API is not available. The detailed diagnosis of this measure lists the error message reported when the availability of the API is 0.
Response code	Indicates the response code returned by the API for the requests received.	Number	A value between 200 and 300 indicates a good response. A 4xx value indicates a problem with the requested content (eg., page not found). A 5xx value indicates a server error.
Response time	Indicates the time taken by the API to respond to requests.	Seconds	A high value for this measure indicates the poor responsiveness of the API.