Salesforce API Access Test

The Salesforce API is a way for other applications (or code in other applications) to programmatically access data within a Salesforce organization, in a simple and secure manner.

eG Enterprise uses the Salesforce API to pull metrics on the health of the Salesforce organization. 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 Salesforce API. This can be achieved using the Salesforce API Access test!

This test periodically checks if the eG agent is able to connect to the Salesforce API, and if so, how long it took for the connection to be established. This way, the test points you to API connection failures and/or connection latencies. 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. If the eG agent is unable to pull metrics from a Salesforce organization or is experiencing some delay in the process, then these metrics will help you explain why - is it because the API is inaccessible? is it due to a slow network connection between the agent and the API? or is it owing to the poor processing power of the API?

Target of the test : A Salesforce organization

Agent deploying the test : A remote agent.

Outputs of the test : One set of results for the Salesforce organization being monitored

Configurable parameters for the test

Parameters	Description
Test Period	How often should the test be executed.
Host	The host for which the test is to be configured.
Email	This test needs to login to the target Salesforce organization as a user with Administrative rights, in order to run API commands on it and pull metrics. To facilitate this connection, specify the email ID of the Administrator of the Salesforce organization here.
Password	Specify the password of the Administrator here.
Confirm Password	Confirm the administrator password by retyping here.

Measurements made by the test

Measurement	Description	Measurement Unit	Interpretation
Connection status	Indicates whether/not the eG agent could connect to the Salesforce API.		The values that this measure reports and the numeric values that map to them is as follows: Measure Value Numeric Value Success 1 Failure 0 Note: By default, this measure reports the Measure Values listed in the table above to indicate whether/not the Salesforce API is accessible. In the graph of this measure however, the same is indicated using the numeric equivalents only.
Time taken for connection establishment	Indicates the time taken to connect to the Salesforce API.	Secs	A high value for this measure is indicative of connection latencies.
Time taken for response	Indicates the time taken by the API to respond to requests.	Secs	A high value is indicative of the poor responsiveness