Salesforce
Overviewβ
Salesforce.com, Inc. is an American cloud-based software company headquartered in San Francisco, California. It provides customer-relationship management (CRM) service and also sells a complementary suite of enterprise applications focused on customer service, marketing automation, analytics, and application development.
Monitoring Connector assetsβ
Monitored objectsβ
- Salesforce instances
Collected metricsβ
- Instance-Status
Metric name | Description |
---|---|
instanceStatus | Status of a Salesforce instance |
Prerequisitesβ
To monitoring your Salesforce instance, the Centreon poller must be allowed to reach the Salesforce API endpoint (api.status.salesforce.com) through HTTPS.
Installationβ
- Online License
- Offline License
- Install the Centreon Plugin on poller(s) expected to monitor Salesforce
yum install centreon-plugin-Applications-Salesforce-Restapi
- Install the Salesforce Monitoring Connector on Configuration > Monitoring Connectors ManagerCentreon Web UI page
- Install the Centreon Plugin on every poller expected to monitor Salesforce:
yum install centreon-plugin-Applications-Salesforce-Restapi
- Install the Centreon Monitoring Connector RPM:
yum install centreon-pack-applications-salesforce-restapi
- Install the Salesforce Monitoring Connector on Configuration > Monitoring Connectors ManagerCentreon Web UI page:
Configurationβ
Add a new host into Centreon and apply the 'App-Salesforce-Restapi-custom' host template. The host macros marked hereafter as "mandatory" have to be configured:
Mandatory | Name | Description |
---|---|---|
x | INSTANCENAME | Name or region-code of the salesforce instance |
x | APIURL | Default is 'api.status.salesfoce.com'. Do not change it |
EXTRAOPTIONS | Any extraoptions you may want to add to every command_line (eg. a --verbose flag) | |
x | DUMMYSTATUS | Host state. Default is OK, do not modify it until you know what you are doing |
x | DUMMYOUTPUT | Host check output. Default is 'This is a dummy check'. Customize it with your own if needed |
FAQβ
How to test my plugin and what do the main parameters stand for ?β
Once the plugin is installed, you can test it logging into the CLI with the centreon-engine user.
/usr/lib/centreon/plugins//centreon_salesforce_restapi.pl \
--plugin=apps::salesforce::restapi::plugin \
--mode=sfdc-instance \
--hostname='api.status.salesforce.com' \
--http-backend=curl \
--instance='sfdcinstance' \
--alias
The above command monitors the status of a Salesforce instance (--mode=sfdc-instance
). An alias flag is added (--alias
) to use the instance alias instead of the Salesforce geographical code. The monitored instance here is named 'sfdcinstance' (--instance='sfdcinstance'
).
All options and what they mean can be displayed through the help of the mode:
/usr/lib/centreon/plugins//centreon_salesforce_restapi.pl \
--plugin=apps::salesforce::restapi::plugin \
--mode=sfdc-instance \
--help
UNKNOWN: Cannot decode JSON responseβ
If you get this error, it may indicate that the received data is not formatted as expected by the Plugin. This usually may happen because of a proxy blocking the request and its answer is wrongly interpreted as the API response.
You can perform further investigation by adding --debug
option to your command line.
What's the name of my instance ?β
Your instance name is the first part of the Salesforce Instance URL. As an example, if you connect to your Salesforce instance using archimede.my.salesforce.com URL, the instance name to use is 'archimede'