Associating an analytics service with a gateway service

To collect data about your API usage and other statistics, you must associate an analytics service with each gateway service. You can associate multiple gateway services with one analytics service, but each gateway can be associated with only one analytics service.

About this task

The associated analytics service receives API event data from the gateway service.

To associate an analytics service with a gateway, you must first configure at least one analytics service and one gateway service.

One of the following roles is required to associate an analytics service with a gateway service:

  • Administrator
  • Topology Administrator
  • Owner
  • A custom role with the Topology:Manage permission

Follow these steps to associate an analytics service with a gateway service:

Procedure

  1. In the Cloud Manager, click Topology Topology.
  2. In the section for the Availability Zone you want to work on, locate the gateway service that requires an analytics service in the SERVICE column.
  3. Locate the ASSOCIATED ANALYTICS SERVICE column.
  4. If an analytics service is configured, the Associate Analytics service link is enabled for each gateway service. Click Associate Analytics Service in the same row as the gateway service that requires an analytics service.
  5. In Associate Analytics Service, you see the name of the gateway service and a list of analytics services that have been configured in your cloud.
  6. Select the analytics service to associate with the gateway service by adding a checkmark next to the analytics services.
  7. If you specified in-cluster communication when you registered the analytics service, you can enable the gateway to send API event data to the internal analytics endpoint. Enable the Use internal endpoint for ingestion of analytics data from the gateway service switch. For more information about in-cluster communication, see Communication types.
  8. Click Associate.
  9. To remove the associated analytics service, select Unassociate analytics service from the actions menu. The gateway stops sending API event data to the analytics service.

Results

The analytics service is associated with a gateway service and starts to receive API event data from that gateway.