This step-by-step guide explains how to setup and monitor standalone API (XML) Endpoint resources using CloudMonix.
In this article
1. Monitoring setup
2. Collect, understand and use your data
3. Setup verification and troubleshooting
Did you know?
CloudMonix provides advanced monitoring metrics and features for API (XML) Endpoint resources. Noteworthy:
- CloudMonix receives data by directly connecting and querying API (XML) Endpoint resources
- pre-configured metrics: response code, response time, resource status, XML array, XML numeric value, XML string value
- alerts on slow responses and resource outages
- ability to run XML / Web requests on specified resources based on conditions or schedule
a. Add a new XML Endpoint resource:
Click the Add New button in the top right corner of your dashboard:
b. Firewall configuration:
CloudMonix monitoring services are hosted in Azure and use static IP addresses to perform monitoring. In certain circumstances user-defined firewall rules may prevent CloudMonix from accessing the monitored resources. Given this scenario, it is necessary to white-list CloudMonix IP addresses as described in this article.
c. Fill in required information in the Definition tab:
Definition tab provides settings for the resource name, URL, configuration template and categories:
Configuration Template setting provides pre-defined configuration templates available in CloudMonix by default as well as previously stored custom templates. See predefined template for API (XML) Endpoint for reference.
Definition tab for an existing resource can be accessed by clicking the resource's monitoring settings in the performance dashboard:
d. Advanced configuration:
Advanced configuration tab provides additional monitoring settings, which are already set as default for most use-cases.
Resource-specific tweaking may be required for Retries if Timed Out, Method, Content Type, User Agent, Credentials, Custom Headers and Ignore invalid SSL Certificate Errors.
Collect, understand and use your data
Specific Metrics, Templates, Alerts and Automation Actions for API (XML) Endpoint:
API (XML) Endpoint Settings
Diagnostic data points retrieved from the monitored resource are referred to as metrics . CloudMonix provides default templates for the metrics recommended for common configurations. Metrics can be further added, removed or customized in the Metrics tab of the API (XML) Endpoint resource configuration dialog:
CloudMonix features a sophisticated alert engine that allows alerts to be published for very particular conditions pre-defined by a template configuration or custom based on any of the available metrics. Alerts can be further added, removed or customized in the Alerts tab of the API (XML) Endpoint resource configuration dialog:
Actions are automation features that can be configured to fire based on specific conditions or schedule. Actions can be added and configured in the Actions tab of the API (XML) Endpoint resource configuration dialog:
Available actions include the ability to run XML / Web requests on specified resources based on conditions or schedule.
Setup verification and troubleshooting
a. Setup verification:
Successful resource setup can be verified by clicking Test button in the resource configuration dialog and visiting the Test Results tab:
b. Troubleshooting monitoring issues:
CloudMonix provides deep insights into resource monitoring issues via the Status Dashboard screen. The screen allows to overview resources that have raised alerts and troubleshoot them by diving into the monitoring logs.
Read the full article on how to use Status Dashboard to diagnose resource monitoring issues.