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 so you can use its URL to configure the API-Connect Analytics Offload.

Configuring Analytics Offload to DPOD

• API-C v10

  • Login to the analytics VM:

    ssh <user>@<ANALYTICS_SERVER_IP_ADDRESS>
    sudo su -
    

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

    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-C 2018

  • Log in to the API-C Cloud Manager

  • Go to Topology → Analytics Service → Click on 3-dots icon and choose Edit → Advanced Analytics Configuration → Ingestion

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

    offload_output_enabled: true

  • Edit the Offload_output.conf with the wanted offload type and save it.

    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.

  • Login to the analytics VM:

    ssh <user>@<ANALYTICS_SERVER_IP_ADDRESS>
    sudo su -
    

• Offloading is processed by the *-ingestion-* pod

• Delete the pod to make sure it picks up the new configuration (sometimes it fails to reload the configuration if it is still retrying to send old messages to an old endpoint):

  kubectl get pods --all-namespaces
  kubectl delete pod *-ingestion-<ID>
  

• [Optional] To troubleshoot, look at the pod logs:

  kubectl logs *-ingestion-<ID>

Associating/unassociating DataPower API Gateways to Analytics Service

1. Log in to the Cloud Manager

2. Go to Configure topology → Click on 3-dots icon of one of the DataPower API Gateways → Select “Associate” or “Unassociate”.

3. This will determine whether this DataPower Gateway will send Analytics data to the Analytics subsystem or not.