API-Connect Analytics Offload allows payload capturing of API-Connect APIs.
Once configured, API-Connect Analytics will send payloads, request headers, response headers and more data about invoked APIs to DPOD.
This data will be available in the transactions pages, as well as in Expert Mode dashboards.

The API-C Analytics page allows you to choose an agent or a Cloud Agent service so you can use its URL to configure the API-Connect Analytics Offload.

Configuring Analytics Offload to DPOD

• API-Connect v10

  • Open an SSH session to a server that can execute kubectl commands against the Analytics subsystem.

  • Edit the AnalyticsCluster CR and add the following content under spec -> external -> offload:

    kubectl edit analyticscluster spec: external: offload: enabled: true output: | http { url => "http://<DPOD_IP_ADDRESS>:60020/apicanalytics" http_method => "post" codec => "json" content_type => "application/json" id => "offload_http" }

• API-Connect v2018

  • Log in to the API-Connect Cloud Manager.

  • Navigate to Configure Topology → Analytics Service → Click on the 3-dots icon and choose Edit → Advanced Analytics Configuration → Ingestion.

  • Edit the Outputs.yml, enable the offload and save it.

    offload_output_enabled: true

  • Edit the Offload_output.conf and add the following content:

    output { if "apicapievent" in [tags] { http { url => "http://<DPOD_IP_ADDRESS>:60020/apicanalytics" http_method => "post" codec => "json" content_type => "application/json" id => "offload_http" } } }

  • Save the changes on the Edit Analytics Service page.

Troubleshooting

• Offloading is processed by the *-ingestion-* pods.

• Sometimes the ingestion of pods fail to reload the configuration if they are still retrying to send old messages to an old endpoint. In such a case, delete the pods to make sure they pick up the new configuration:

• Use the following command to view the pods logs:

Associating/unassociating DataPower API Gateways to Analytics Service

• Log in to the API-Connect Cloud Manager.

• Navigate to Configure Topology → Click on the 3-dots icon of one of the DataPower API Gateways → Select “Associate” or “Unassociate”.