TL;DR - Use Axway's API Builder to add shields to your Amplify Central API Service Description and Environment as follows:
Refer to these blog posts for more details:
- Amplify Central: Add API Traffic Badges to your API Service Description
- Amplify Central - Add API Traffic Badges to your Environment Description
This API Builder project exposes three API's:
- /intwebhook - triggered by Amplify Central Integration Webhook for when a new API Service is discovered by a discovery agent. This webhook automatically adds three shields to the description. Each shield points to the /metrics webhook below
- /metrics - called by the API Service Metrics shields to retrieve total number of api calls, error rate and average response time
- /envmetrics - called by the Environment Metrics shields to retrieve api calls and average response time per environment
Note that if you have previously discovered API Services, you can manually add the shields URLs to your API Service description using the Axway CLI or Axway Central API's.
If you want to try this out without building the API Builder project, you can pull a docker image from Dockerhub.
This project uses 3 external node modules as follows:
- For HTTP API Calls to Central:
- npm install --save axios
- npm install --save qs
- To format total number of API Calls (using K, M, ...)
- npm install --save short-number
Set the following environment variable to run the API Builder project:
- AC_SA_CLIENTID - Amplify Central Service Account Client ID for Central API calls
- AC_SA_CLIENTSECRET - Amplify Central Service Account Client Secret for Central API calls
- AC_BASEURL - Amplify Central Base URL (e.g. https://apicentral.axway.com)
- APIB_HOST - host address of API Builder (e.g. 75dd...b22e1f2fa08d9cb6084a9.cloudapp-enterprise.appcelerator.com)
curl --location -g --request GET '{{apib_baseaddress}}/api/metrics?eid=8a2e862d779860e20177a6888d450233&pid=remoteApiId_o18il3ymuh&metrictype=totalnumcalls'
Response:
{
"schemaVersion": 1,
"label": "Total # Calls",
"message": "185",
"color": "green"
}
curl --location --request GET '{{apib_baseaddress}}/api/metrics?eid=8a2e862d779860e20177a6888d450233&pid=remoteApiId_o18il3ymuh&metrictype=avgresptime'
Response:
{
"schemaVersion": 1,
"label": "Avg Resp Time",
"message": "10.8ms",
"color": "blue"
}
curl --location --request GET '{{apib_baseaddress}}/api/metrics?eid=8a2e862d779860e20177a6888d450233&pid=remoteApiId_o18il3ymuh&metrictype=errorrate'
Response:
{
"schemaVersion": 1,
"label": "Err Rate",
"message": "50.8%",
"color": "red"
}
curl --location --request GET '{{apib_baseaddress}}/api/envmetrics?eid=8a2e862d779860e20177a6888d450233&metrictype=envcallmetrics'
Response:
{
"schemaVersion": 1,
"label": "API Calls",
"message": "Success: 119, Client Errors: 100, Server Errors: 0",
"color": "red"
}
curl --location --request GET '{{apib_baseaddress}}/api/envmetrics?eid=8a2e862d779860e20177a6888d450233&metrictype=envavgresptime'
Response:
{
"schemaVersion": 1,
"label": "Avg Resp Time",
"message": "16.2ms",
"color": "blue"
}
Use the following command to create a docker image of your API Builder project:
docker build --tag shieldstest ./
Note that I had to change the first line of the Dockerfile from
FROM node:12-alpinetoFROM --platform=linux/x86-64 node:12-alpinesince I was creating on an M1 Macbook. Also, my image is called shieldstest
AC_SA_CLIENTID=<YOUR CLIENT ID> AC_SA_CLIENTSECRET=<YOUR CLIENT SECRET> AC_BASEURL=https://apicentral.axway.com APIB_HOST=23cfbb7e5354.ngrok.io npm start
Or, if you create a docker image:
docker run --rm -e AC_SA_CLIENTID=<YOUR CLIENT ID> -e AC_SA_CLIENTSECRET=<YOUR CLIENT SECRET> AC_BASEURL=https://apicentral.axway.com -e APIB_HOST=23cfbb7e5354.ngrok.io -e PORT=8080 -p 8080:8080 --name shieldstest shieldstest
Note: the Amplify Central Client ID and Client Secret referenced above are described here
Note that I am using ngrok so that my API Builder project is accessible remotely
You can deploy this docker container anywhere that you'd like.
Amplify ARS provides a URL for your API Builder app as soon as you create the ARS app (before you publish) so we will create the app and grab the URL so we can set the APIB_HOST environment variable before publishing.
Note that my ARS app is called shieldstest. Also, you need to install the acs package in your Axway CLI
- If you have not already done so, use the following command to create a docker image of your API Builder project:
docker build --tag shieldstest ./
-
Use the following Axway CLI commands to create your ARS app:
axway acs login axway acs new shieldstest --force -
Check the URL
axway acs list shieldstestThe response will be similar to the following:
AXWAY CLI, version 2.1.0 Copyright (c) 2018-2021, Axway, Inc. All Rights Reserved. ACS: Axway AMPLIFY Runtime Services Services Command-Line Interface, version 2.1.10 Copyright (c) 2012-2021, Axway, Inc. All Rights Reserved. Organization: Axway Appcelerator SE (100000142) ============ Points: -- Quota: 1000 -- Used: 258 App name: shieldstest -- Created by: [email protected] -- URL: https://843d22.....fa16ceabc.cloudapp-enterprise.appcelerator.com -- Created at: 2021-05-18T11:28:14-04:00 -- Status: To be published -
Continue to setup the app by setting environment variables:
axway acs config --set PORT=8080 shieldstest axway acs config --set AC_SA_CLIENTID=<YOUR CLIENT ID> shieldstest axway acs config --set AC_SA_CLIENTSECRET=<YOUR CLIENT SECRET> shieldstest axway acs config --set AC_BASEURL=https://apicentral.axway.com shieldstest axway acs config --set APIB_HOST=<Your ARS App URL> shieldstest -
Check your environment variables:
axway acs config --env shieldstest axway acs server --set Medium shieldstest -
Publish your API Builder Docker image:
axway acs publish shieldstest --delete_oldest --force --image shieldstest --app_version 0.1
In order for this app to work, it needs to be triggered by an Amplify Central Integration Webhook when a new API Service is discovered by the Discovery Agent.
You can do this using the Axway CLI as follows:
- Create a YAML file, resources.yaml, as follows:
name: apiscintegration
kind: Integration
apiVersion: v1alpha1
title: API Service Created Integration
tags:
- cloud
spec:
description: This is an Integration for when an API Service is created.
---
name: apiscwebhook
kind: Webhook
apiVersion: v1alpha1
title: API Service Created Webhook to invoke an API Builder API
metadata:
scope:
kind: Integration
name: apiscintegration
spec:
enabled: true
url: https://23cfbb7e5354.ngrok.io/api/intwebhook
---
group: management
apiVersion: v1alpha1
kind: ResourceHook
name: apisc-hook
title: Resource Hook to monitor environment aws and new API Service created
metadata:
scope:
kind: Integration
name: apiscintegration
spec:
triggers:
- group: management
kind: APIService
name: '*'
type:
- created
scope:
kind: Environment
name: aws
webhooks:
- apiscwebhook
Note that the url above is the URL of the API Builder API so the API Builder project must be deployed/running before setting up the Integration. Replace with the URL of your container.
Note that the scope for the resource hook is my aws environment. You can replace with your environment name or use an asterisk '*' for all environments
- Run the following Axway CLI commands to authenticate using your platform credentials and to create the Integration Webhook resources:
axway auth login
axway central create -f resources.yaml
The response will be something like this:
⠋ Creating resource(s)(node:96292) ExperimentalWarning: The fs.promises API is experimental
✔ "integration/apiscintegration" has successfully been created.
✔ "webhook/apiscwebhook" has successfully been created.
✔ "resourcehook/apisc-hook" has successfully been created.
If you need to make a change to your YAML file, say to update the URL of the webhook, for example, you can use the following command to update the resources:
axway central apply -f resources.yaml