Configure usage tracking

Enable usage tracking for on-premise API management products purchased on a subscription basis.

3 minute read

Usage tracking is how Axway measures the subscription services you use on a monthly basis. Axway measures your usage to make sure it is within the prescribed thresholds specified in your subscription, and to determine whether overages require billing adjustments. For more information, see About subscription usage tracking.

You can log in to the AMPLIFY Platform and look up information about your subscriptions and service entitlements. If you are unsure whether usage tracking applies to you, contact your Axway representative or Axway Support.

The AMPLIFY Edge Agent collects data from your on-premise API management products and uploads usage reports to the AMPLIFY Platform. You must connect your API Gateway to the Edge Agent to enable automatic upload of usage reports to the AMPLIFY Platform.

Configure API Gateway to connect with the Edge Agent

Before you start, see Deploy the agent.

Upload the following two configuration files to the Edge Agent to enable API Gateway to send usage data to the Edge Agent:

API Gateway communicates with the agent over Lumberjack protocol using Filebeat.

Start an Admin Node Manager container with topology logging enabled

Topology logging contains usage statistics that can be used for billing. It records the number of API Gateways that are running and the number of transactions (for example: HTTP, JMS, FTP, and directory scanner) processed by each. This can be useful for tracking the distribution of API Gateways across hosts.

The Admin Node Manager is responsible for writing the topology log, which is configured by way of environment variables. Topology logging is disabled by default.

The following example shows how to start an Admin Node Manager container with topology logging enabled:

docker run -d -p 8090:8090 --name=anm --network=api-gateway-domain -v /tmp/events:/opt/Axway/apigateway/events -e METRICS_DB_URL=jdbc:mysql://metricsdb:3306/metrics?useSSL=false -e METRICS_DB_USERNAME=db_user1 -e METRICS_DB_PASS=my_db_pwd -e EMT_TRACE_LEVEL=DEBUG -e EMT_TOPOLOGY_LOG_ENABLED=true -e EMT_TOPOLOGY_LOG_INTERVAL=30 -e EMT_TOPOLOGY_LOG_DEST=3 -e EMT_TOPOLOGY_LOG_DIR=/tmp/topology-logs admin-node-manager:1.0

This example uses the following topology logging environment variables:

EMT_TOPOLOGY_LOG_ENABLED
Starts an Admin Node Manager with topology logging enabled
EMT_TOPOLOGY_LOG_INTERVAL
Sets the time interval to write log records
EMT_TOPOLOGY_LOG_DEST
Sets the destination of the log records
EMT_TOPOLOGY_LOG_DIR
Specifies a directory to write log records

For information on the other options used in this example, see Start the Admin Node Manager container.

Start an API Gateway container with topology logging enabled

If you have started an Admin Node Manager with topology logging enabled, you must specify the API Gateway host identity in the EMT_PARENT_HOST environment variable to identify the host of the log records, and restart the host.

The following example shows how to start an API Gateway container and set the parent host in the topology log records.

docker run -d --name=apimgr --network=api-gateway-domain -p 8075:8075 -p 8065:8065 -p 8080:8080 -v /tmp/events:/opt/Axway/apigateway/events -e EMT_ANM_HOSTS=anm:8090 -e CASS_HOST=casshost1 -e METRICS_DB_URL=jdbc:mysql://metricsdb:3306/metrics?useSSL=false -e METRICS_DB_USERNAME=root -e METRICS_DB_PASS=my_db_pwd -e EMT_TRACE_LEVEL=DEBUG -e EMT_PARENT_HOST=acme-DC1-server2 api-gateway-my-group:1.0

This example uses the following topology logging environment variables:

EMT_PARENT_HOST
Sets the name of the parent host for the API Gateway

For information on the other options used in this example, see Start the API Gateway container.

Review subscriptions and usages on the platform

After you have completed the configuration and have enabled uploads of usage reports, you can log in to the AMPLIFY Platform and access and review your subscriptions and usage data. For more information, see Review subscriptions and usages on the platform.