Monitoring IBM API Connect for provider organization metrics
IBM API Connect is an integrated API Management that offers capabilities and tools for all phases of the API lifecycle. In an IBM Cloud environment, the IBM team deploys and manages the API Connect
infrastructure. You can also deploy and manage the API Connect infrastructure in your dedicated environment or third-party cloud. Instana monitors provider organizations for catalog, space, and other metrics.
Supported information
Supported OS
The IBM API Connect Instana sensor is automatically installed after the host agent is installed on supported operating systems. For more information, see the Supported operating systems section for host agents, such as Supported operating systems for UNIX.
Supported versions
Instana supports metrics and configuration data for IBM API Connect 10 and later.
Configuring
Only remote monitoring is supported for the IBM API Connect Instana sensor.
To connect the Instana agent to IBM API Connect, configure the following properties in the Instana agent configuration file <agent_install_dir>/etc/instana/configuration.yaml:
com.instana.plugin.ibmapiconnect:
remote: # Multiple configurations can be specified
- host: '' # hostname or IP of API-Connect manager
port: '443' # port of API-Connect manager
username: '' # username of API-Connect manager. User can connect either through 'username & password' or 'apikey'.
password: '' # password of API-Connect manager. 'username & password' are optional if 'apikey' is provided.
api_key: '' # api-key of API-Connect manager. 'apikey' is optional if 'username & password' are provided.
realm: '' # realm of API-Connect manager
clientId: '' # downloaded clientId from tool-kit
clientSecret: '' # downloaded clientSecret from tool-kit
availabilityZone: 'API-Connect' # default is 'API-Connect'
poll_rate: 10 # Poll rate in seconds.
Viewing metrics
After the agent is configured and deployed on a remote host for collecting IBM API Connect metrics, you can view metrics for the provider organization in the Instana UI.
Infrastructure view
To view the metrics, complete the following steps:
- In the sidebar of the Instana UI, select Infrastructure. You can view the map of the API Connect entities in the Map tab.
- On the Map tab, click a tower specific to the API Connect system.
- To view all the collected metrics for the API Connect system, click Open Dashboard.
Provider organization metrics
The following table lists the metrics that are displayed for a provider organization:
| Metric | Description | Granularity |
|---|---|---|
| Number of catalogs | Total number of catalogs in the provider organization. | 10 seconds |
| Total number of Products | Total number of products. | 10 seconds |
| Total API Calls | Total number of API calls that the catalog makes. | 10 seconds |
| Total Errors | Total number of errors that the catalog encounters. | 10 seconds |
| Catalogs | List of catalogs | 10 seconds |
Catalog metrics
The following table lists the metrics that are displayed for a catalog:
| Metric | Description | Granularity |
|---|---|---|
| Catalog Name | Name of the catalog that the provider organization supports. | 10 seconds |
| Total API Calls | Total number of API calls that the catalog makes. | 10 seconds |
| Total Errors | Total number of errors that the catalog encounters. | 10 seconds |
| Max API Response | Maximum response time of the APIs in milliseconds. | 10 seconds |
| Min API Response | Minimum response time of the APIs in milliseconds. | 10 seconds |
| Avg API Response | Average response time of the APIs in milliseconds. | 10 seconds |
| 2xx Status Code | The number of 2xx status codes that are captured in a period. | 10 seconds |
| 4xx Status Code | The number of 4xx status codes that are captured in a period. | 10 seconds |
| 5xx Status Code | The number of 5xx status codes that are captured in a period. | 10 seconds |
| Time to serve request(all success 2xx,3xx) | Total time taken to complete all the success (2xx and 3xx) requests. | 10 seconds |
| Time to serve request(all errors 4xx,5xx) | Total time taken to complete all the errors (4xx and 5xx) requests. | 10 seconds |
| Spaces | List of spaces | 10 seconds |
Space metrics
The following table lists the metrics that are displayed for a space:
| Metric | Description | Granularity |
|---|---|---|
| Space Name | Name of the space that the provider organization supports. | 10 seconds |
| Total API Calls | Total number of API calls that the space makes. | 10 seconds |
| Total Errors | Total number of errors that the space encounters. | 10 seconds |
| Max API Response | Maximum response time of the APIs in milliseconds. | 10 seconds |
| Min API Response | Minimum response time of the APIs in milliseconds. | 10 seconds |
| Avg API Response | Average response time of the APIs in milliseconds. | 10 seconds |
| 2xx Status Code | The number of 2xx status codes that are captured in a period. | 10 seconds |
| 4xx Status Code | The number of 4xx status codes that are captured in a period. | 10 seconds |
| 5xx Status Code | The number of 5xx status codes that are captured in a period. | 10 seconds |
| Time to serve request(all success 2xx,3xx) | Total time taken to complete all the success (2xx and 3xx) requests. | 10 seconds |
| Time to serve request(all errors 4xx,5xx) | Total time taken to complete all the errors (4xx and 5xx) requests. | 10 seconds |
Troubleshoot
-
Import self-signed certificate that are used by APIC manager server If APIC manager server uses a self-signed certificate, make sure that it is imported into the jvm's cacert.
Also, if you see following exception in the log, it indicates that APIC manager server uses a self-signed certificate, and it needs to be imported into the jvm's cacert.
sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target. PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target.Solution: Import a self-signed certificate by following the instructions from Self-Signed Certificate.