[{"_1":2,"_161":-5,"_162":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_140":141},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_129":-5,"_130":11,"_131":21,"_132":11,"_133":-5,"_134":11,"_135":-5,"_136":137,"_138":91,"_139":-7},"canonicalUrl","https://hub.docker.com/r/lbrenman/shieldstest/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","lbrenman","reponame","shieldstest","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2021-05-13T19:55:28.531397Z","description","Service to add API Transaction shields to an Amplify Central API Service","is_private","last_updated","2021-12-11T15:18:30.445509Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",1024,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","![](https://img.shields.io/docker/pulls/lbrenman/shieldstest)\n\n# Dockerhub Description\n\nService to add API Transaction [**shields**](https://shields.io/) to an Amplify Central API Service Description and/or an Amplify Central Environment. This service is a Dockerized Axway [**API Builder**](https://docs.axway.com/bundle/API_Builder_4x_allOS_en/page/api_builder.html) project.\n\n* API Service Description:\n\n ![](https://i.imgur.com/2liSk8q.png)\n\n\n* Environment Description\n\n ![](https://i.imgur.com/JIcV7Vl.png)\n\nRefer to these blog posts for more details:\n\n* [Amplify Central: Add API Traffic Badges to your API Service Description](https://gist.github.com/lbrenman/37eec4598cfc6b5ee780b2d09ffc79a6)\n* [Amplify Central - Add API Traffic Badges to your Environment Description](https://gist.github.com/lbrenman/a87a4f7465953bb5b3def2397d6c7570)\n\nThis API Builder project exposes three API's:\n* */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\n* */metrics* - called by the API Service Metrics shields to retrieve total number of api calls, error rate and average response time\n* */envmetrics* - called by the Environment Metrics shields to retrieve api calls and average response time per environment\n\n> 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](https://docs.axway.com/bundle/Axway_CLI_allOS_en/page/axway_cli.html) or Axway Central API's.\n\nThe API Builder project can be found on [**Github**](https://github.com/lbrenman/shieldstest).\n\n## Installation\n\n* Pull image\n\n ```\n docker pull lbrenman/shieldstest\n ```\n\n* Run locally\n\n ```\n docker run --rm -e AC_SA_CLIENTID= -e AC_SA_CLIENTSECRET= -e AC_BASEURL=https://apicentral.axway.com -e APIB_HOST=23cfbb7e5354.ngrok.io -e PORT=8080 -p 8080:8080 --name shieldstest lbrenman/shieldstest\n ```\n\n > Note that you'll need [**ngrok**](https://ngrok.com/) or something similar so that your local machine will be accessible to Amplify Central. Replace APIB_HOST value with your ngrok URL. Refer to this [**post**](https://devblog.axway.com/apis/amplify-central-connected-gateway-custom-api-subscription-flow-basics/) for details on Amplify Central Service accounts, Client ID and Client Secrets.\n\nIf everything is running properly, then you should see something similar to the following:\n\n```\n1620948998709 INFO API Builder/Lyon (4.63.0) shieldstest/0.0.2\n1620948998719 WARN Your server has no authentication, accessControl.apiPrefixSecurity is unset.\n1620948999154 INFO Registered plugin: @axway/api-builder-plugin-fn-base64\n1620948999235 INFO Registered plugin: @axway/api-builder-plugin-fn-javascript\n1620948999273 INFO Registered plugin: @axway/api-builder-plugin-fn-json\n1620948999306 INFO Registered plugin: @axway/api-builder-plugin-fn-mustache\n1620948999328 INFO Registered plugin: @axway/api-builder-plugin-fn-restclient\n1620948999570 INFO Registered plugin: @axway/api-builder-plugin-fn-swagger\n1620948999573 INFO Starting connector/memory@built-in\n1620948999575 INFO Started connector/memory@built-in\n(node:1) [D034] DeprecationWarning: Using the 'optional' property in API parameters and Model fields has been deprecated. Use 'required' instead. See https://docs.axway.com/bundle/API_Builder_4x_allOS_en/page/api_builder_deprecations.html#APIBuilderDeprecations-D034\n1620948999739 INFO Access the swagger API documentation at http://localhost:8080/apidoc/swagger.json\n1620949000068 WARN Unrestricted access to API Builder Console\n1620949000098 INFO Access API Builder Console at http://localhost:8080/console (This will only be available on your dev environment)\n1620949000102 INFO server started on port 8080\n```\n\n## API Calls\n\n### Total Number of API Calls for an API:\n\n ```\n curl --location -g --request GET '{{apib_baseaddress}}/api/metrics?eid=8a2e862d779860e20177a6888d450233&pid=remoteApiId_o18il3ymuh&metrictype=totalnumcalls'\n ```\n\n Response:\n\n ```\n {\n \"schemaVersion\": 1,\n \"label\": \"Total # Calls\",\n \"message\": \"185\",\n \"color\": \"green\"\n }\n ```\n\n### Average Response Time for an API:\n\n ```\n curl --location --request GET '{{apib_baseaddress}}/api/metrics?eid=8a2e862d779860e20177a6888d450233&pid=remoteApiId_o18il3ymuh&metrictype=avgresptime'\n ```\n\n Response:\n\n ```\n {\n \"schemaVersion\": 1,\n \"label\": \"Avg Resp Time\",\n \"message\": \"10.8ms\",\n \"color\": \"blue\"\n }\n ```\n\n### Error Rate for an API:\n\n ```\n curl --location --request GET '{{apib_baseaddress}}/api/metrics?eid=8a2e862d779860e20177a6888d450233&pid=remoteApiId_o18il3ymuh&metrictype=errorrate'\n ```\n\n Response:\n\n ```\n {\n \"schemaVersion\": 1,\n \"label\": \"Err Rate\",\n \"message\": \"50.8%\",\n \"color\": \"red\"\n }\n ```\n\n### API Calls for an Environment:\n\n ```\n curl --location --request GET '{{apib_baseaddress}}/api/envmetrics?eid=8a2e862d779860e20177a6888d450233&metrictype=envcallmetrics'\n ```\n\n Response:\n\n ```\n {\n \"schemaVersion\": 1,\n \"label\": \"API Calls\",\n \"message\": \"Success: 119, Client Errors: 100, Server Errors: 0\",\n \"color\": \"red\"\n }\n ```\n\n### API Average Response Time for an Environment:\n\n ```\n curl --location --request GET '{{apib_baseaddress}}/api/envmetrics?eid=8a2e862d779860e20177a6888d450233&metrictype=envavgresptime'\n ```\n\n Response:\n\n ```\n {\n \"schemaVersion\": 1,\n \"label\": \"Avg Resp Time\",\n \"message\": \"16.2ms\",\n \"color\": \"blue\"\n }\n ```\n\n## Setup Amplify Central Integration Webhooks\n\nIn 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.\n\nYou can do this using the [**Axway CLI**](https://docs.axway.com/bundle/axway-open-docs/page/docs/central/cli_central/cli_install/index.html#install-axway-cli-and-axway-central-cli) as follows:\n\n1. Create a YAML file, *resources.yaml*, as follows:\n\n ```\n name: apiscintegration\n kind: Integration\n apiVersion: v1alpha1\n title: API Service Created Integration\n tags:\n - cloud\n spec:\n description: This is an Integration for when an API Service is created.\n ---\n name: apiscwebhook\n kind: Webhook\n apiVersion: v1alpha1\n title: API Service Created Webhook to invoke an API Builder API\n metadata:\n scope:\n kind: Integration\n name: apiscintegration\n spec:\n enabled: true\n url: https://23cfbb7e5354.ngrok.io/api/intwebhook\n ---\n group: management\n apiVersion: v1alpha1\n kind: ResourceHook\n name: apisc-hook\n title: Resource Hook to monitor environment aws and new API Service created\n metadata:\n scope:\n kind: Integration\n name: apiscintegration\n spec:\n triggers:\n - group: management\n kind: APIService\n name: '*'\n type:\n - created\n scope:\n kind: Environment\n name: aws\n webhooks:\n - apiscwebhook\n ```\n\n > 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.\n\n > 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\n\n2. Run the following Axway CLI commands to authenticate using your platform credentials and to create the Integration Webhook resources:\n\n ```\n axway auth login\n axway central create -f resources.yaml\n ```\n\n The response will be something like this:\n\n ```\n ⠋ Creating resource(s)(node:96292) ExperimentalWarning: The fs.promises API is experimental\n ✔ \"integration/apiscintegration\" has successfully been created.\n ✔ \"webhook/apiscwebhook\" has successfully been created.\n ✔ \"resourcehook/apisc-hook\" has successfully been created.\n ```\n\n 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:\n\n ```\n axway central apply -f resources.yaml\n ```\n\n## Publish\n\nOnce everything is working, you can publish this docker image to the hosting service of your choice. Then you need to update the Integration Webhook URL to point to the URL of your published service by editing your YAML file and issuing the `axway central apply` command above. If this URL is different, then you will need to remove and \"re-discover\" the API's since any shields will be pointing to the prior address.\n\n### Publish to Axway ARS\n\n[**Axway ARS**](https://docs.axway.com/bundle/AMPLIFY_Runtime_Services_2_0_allOS_en/page/amplify_runtime_services.html) can be used to host your docker image. Below are instructions for deploying your docker image:\n\n* ARS App Setup\n\n ```\n axway acs login\n axway acs new --force\n axway acs list \n ```\n\n > Note that at this point you can see your app's base URL. You will need this for setting the APIB_HOST environment variable below.\n\n The response will be similar to the following:\n\n ```\n AXWAY CLI, version 2.1.0\n Copyright (c) 2018-2021, Axway, Inc. All Rights Reserved.\n\n ACS: Axway AMPLIFY Runtime Services Services Command-Line Interface, version 2.1.10\n Copyright (c) 2012-2021, Axway, Inc. All Rights Reserved.\n\n Organization: Axway Appcelerator SE (100000142)\n ============\n Points:\n -- Quota: 1000\n -- Used: 258\n\n App name: shieldstest2\n -- Created by: lbrenman@appcelerator.com\n -- URL: https://843d2294c82c93c09ad737049b30298fa16ceabc.cloudapp-enterprise.appcelerator.com\n -- Created at: 2021-05-18T11:28:14-04:00\n -- Status: To be published\n ```\n\n Continue to setup the app by setting environment variables:\n\n ```\n axway acs config --set PORT=8080 \n axway acs config --set AC_SA_CLIENTID= \n axway acs config --set AC_SA_CLIENTSECRET= \n axway acs config --set AC_BASEURL=https://apicentral.axway.com \n axway acs config --set APIB_HOST= \n axway acs server --set Medium \n ```\n\n Check your environment variables:\n\n ```\n axway acs config --env \n ```\n\n* Publish Docker Image to ARS\n\n ```\n axway acs publish --delete_oldest --force --image lbrenman/shieldstest --app_version 0.1\n ```","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",219841294,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},"content_type","creator",2290213,"full_size",70004164,"id",149679725,"images",[101],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},"architecture","amd64","digest","sha256:e701281da97a33a35de2717525f9c9e1e8b3afacc747d61f657c9d69b10ef50d","features","","last_pulled","2026-10-01T05:36:32.33939897Z","last_pushed","2021-12-11T15:18:31Z","os","linux","os_features","os_version","size","variant","2021-12-11T15:18:30.070273Z","last_updater","last_updater_username","media_type","latest","repository",13480967,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":142,"_149":150,"_136":159,"_160":11},{"_40":143,"_42":144,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":145,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":146,"_79":11,"_80":148,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":147},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_151":64,"_152":-5,"_153":-5,"_154":155},"count","next","previous","results",[156],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":157,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},[158],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},[],"canDeleteTags","actionData","errors"]

lbrenman/shieldstest

Tags for lbrenman/shieldstest