Context

In order to report their usage API Gateway subscription customers can rely on existing documentation: Amplify subscription usage and reporting (axway.com) and Use Traceability Agent to report Gateway usage (axway.com)

This KB summarizes the above documents and guides customers through main actions needed in order to report their usage in the Platform.

Resolution

1. Identify your Organization on platform.axway.com
   An Organization on platform.axway.com is created by Axway upon the contract signature and at least one contact person from your company is assigned as Org Administrator and can provide more details. If you encounter difficulties obtaining these details, please don’t hesitate to contact your Customer Success Manager or Axway Support.
   
   
2. Check the rights you have within the Organization
   You should be a member of the Organization created for your company and must have “Administrator” and “Central Admin” role at Organization level before proceeding with next actions. To verify your assigned roles, you can navigate to Users, select your user and check the values of “Org Roles” field.
   
   
3. Install the Traceability Agent
   To do this you can:
   • Download the Traceability Agent (classic install, docker or helm) from repository.axway.com
     or
   • Use the binaries already provided with API Gateway 7.7 May 22 or newer (in “apigateway/agents/” folder)
     or
   • Use the Axway Central CLI: This option relies on “axway” CLI and “axway central” CLI to download the Traceability Agent binaries. More details are provided via Deploy your agents with Axway CLI and Use Traceability Agent to report Gateway usage (axway.com)
     or
   • Manually download the Traceability agent from axway.jfrog.io
   
   
4. Configure the Traceability Agent Through this step you are configuring the agent to communicate with both Amplify platform and with your API Gateway. You’ll need to configure one Traceability Agent per Gateway instance and to accomplish this, you can:
   • Use the Axway Central CLI
     When using the “axway central install agents” the needed objects are created in Amplify platform and the agent’s configuration file (.env) is adapted based on these.
     or
   • Configure the Traceability Agent manually:
     You can manually create the needed objects in the platform (Team, Environment, Service Account) and create/configure/adapt the Traceability Agent’s .env file.
     More details are available under Minimum recommended variables and Complete variable list for advanced features.
   
   
5. Report usage Traceability agent can be configured to report usage in 2 ways:
   • Online mode (connected) – when CENTRAL_USAGEREPORTING_OFFLINE is set to False (default value) the report is automatically sent to Amplify platform at regular, configurable intervals.
     Check Administer network traffic (axway.com) for more details on traffic, hosts and ports. When configured properly the Environment will appear as Connected under Amplify Central Topology and the Agent will appear as Running within the environment.
     or
   • Offline mode – when CENTRAL_USAGEREPORTING_OFFLINE is set to True the report is produced locally (each month) by the Traceability Agent and must be uploaded manually to Amplify platform -> Organization menu -> Usage -> Monthly/Report usage.
   
   
6. Check usage
   If configured in Online mode or after uploading the report created in Offline mode the usage reports will be available on Amplify Platform. You can check this via Monthly Usage or Report History.
   
   
7. Keep the Agent up to date
   See the Upgrade an agent (axway.com) documentation for the steps needed to update the agents.