Google Cloud API Access Test

eG Enterprise accesses the Google Cloud Platform (GCP) to monitor the services hosted by the Google Cloud project. If there are issues in the connectivity between the eG agent and the GCP, or if any slowness is observed in the responsiveness of the GCP, eG's monitoring service is bound to get affected. This is why, it is important to periodically check the accessibility of the GCP. This can be achieved using the Google Cloud API Access test!

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

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

Target of the Test : Google Cloud

Agent deploying the test: A remote agent

Output of the test: One set of results for the target Google Cloud

Configurable parameters for the test
Parameters Description

Test Period

How often should the test be executed. By default, this is set to 180 minutes.

Host

The host for which the test is to be configured.

Private Keyfile Name

To connect to the Google Cloud Project in which the services are running, 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 Cloud?.

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 GCP is accessible.

Percent

A value of 100 percent indicates that the GCP 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 GCP is 0.

Response code

Indicates the response code returned by the GCP 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 GCP to respond to requests.

Seconds

A high value for this measure indicates the poor responsiveness of the GCP.