The Cloud API Trail

The Cloud API Trail is an activity log for all activity that uses the Cloud API and goes through the MID Server.

Cloud API Trail contents

The Cloud API Trail form
Field Description
Dynamic route ID An auto-generated ID number for the entry.
Mid name The name of the MID Server through which the discovery was performed.
Route status Whether or not the discovery operation run by the API was successful. Possible values are:
  • success
  • error
  • executing
Input parameters The input parameter that generated the API trail record. This value is usually the datacenter in which the discovery was run.
Interface name
Invoked by This value is always CMP when running cloud discovery.
Method name The interface operation from the Cloud API that processed this record.
Provider name The cloud provider.
Version The version specified in the Cloud API.

CAPI Trail Logs

The CAPI Trail Logs related list provides more details about Cloud API trail entry. The following types of log keys are available:

Log key Description
route_data Information about the Cloud API calls.
dynamic_route Information about the actual route the data took, including URIs.
route_result The payload received by the instance, or a description of the result of the data transfer. The payload
chunk_number The number of data chunks that the instance received.
route_status Whether or not the route connection and payload transfer was successful.
route_error The error that occurred. For example, the error Failed to list loadbalancer Failed : HTTP error code : 403 means that your credentials were incorrect and Discovery could not access the cloud resource.
error_detail More details about the error, including the Cloud Management API and connector that was used in the attempted discovery, and the errors that the cloud provider threw.
An example of a route_error is as follows:
Failed to list loadbalancer Failed : HTTP error code : 403

An example of the error_datail entry for the same error is as follows:

com.snc.cmp.connector.cloud.loadbalancer.component.LoadBalancerException: Failed to list loadbalancer Failed : HTTP error code : 403
       at com.snc.cmp.connector.cloud.loadbalancer.customizer.impl.AWSLoadBalancerCustomizer.listLoadBalancers(AWSLoadBalancerCustomizer.java:56)
	at com.snc.cmp.connector.cloud.loadbalancer.component.LoadBalancerProducer.process(LoadBalancerProducer.java:46)
	at org.apache.camel.util.AsyncProcessorConverterHelper$ProcessorToAsyncProcessorBridge.process(AsyncProcessorConverterHelper.java:61)
       at org.apache.camel.processor.SendProcessor.process(SendProcessor.java:145)
       ...

These two entries indicate that the credentials were incorrect, and Discovery could not access the cloud resource. The load balancer interface throws the first error because the load balancer device is the first device that allows access to the cloud resource. The org.apache.camel errors indicated routing errors on the Amazon Web Services side.

The corresponding error on the instance side is captured in the Cloud Orchestration Trail.

Open the Cloud API Trail

Open the Cloud API Trail to debug and troubleshoot issues like a failed policy or failed discovery of cloud resources.

Before you begin

Role required: sn_cmp.cloud_operator or sn_cmp.cloud_admin

Procedure

  1. Navigate to Cloud Management > Cloud Operations and Troubleshooting > Cloud API Trail..
  2. Filter and sort the list of Cloud API Trail records as needed. If you are looking for something like a failed discovery, filter the list so the Route Status column shows only entries with error.
  3. Click a link in the Created column to open the Cloud API Trail record.
  4. In the CAPI Trail Logs related list, open the log record that displays the information you want. For example, open route_error or error_detail to debug a failed operation.