APIIDA API Control Plane

Activate and display Metrics for WSO2

Owned by Marilena Müller
Last updated: Mar 14, 2024 by Matthias Senker
2 min read

For WSO2, metrics must first be enabled via the Choreo cloud service in order to use and display them.

To make them usable in the API Control Plane , four variables must be inserted into the configuration file. These four values are optional. If they are not provided, the agent will not be able to obtain any metrics.

Note: Your agent may not actually be using a config file. In that case, pass the extra parameters as environment variables, along with the others, prefixed with gateway., e.g. gateway.orgId.

type: WSO2 url: https://host:port user: yourUser password: yourPassword consumerKey: yourConsumerKey consumerSecret: yourConsumerSecret orgId: yourOrgId environmentId: yourEnvironmentId

consumerKey, consumerSecret, orgId and environmentId are all related to Choreo, the web platform where WSO2 optionally stores metrics, and need to be added manually to the configuration file.

See here, how to get startet with Choreo: https://apim.docs.wso2.com/en/latest/api-analytics/getting-started-guide/

See here, how to obtain consumerKey and consumerSecret: https://wso2.com/choreo/docs/insights/programmatic-access-choreo-insights-api/

orgId

To get the orgId, click on your Profile in the top right and select Settings:

You should see the settings page for your organization, where you can click “Copy ID” to obtain the orgId:

environmentId

When looking at the metrics in Choreo, you can see the environmentId as env parameter in the URL: