This package is a plugin for Express Gateway to easily add Moesif’s API analytics to your APIs served by Express Gateway.
How to install
- Install express-gateway-plugin-moesif:
Within the folder of the Gateway created by Express Gateway, type in:
npm install --save express-gateway-plugin-moesif
Add the moesif plugin to
plugins: # express-gateway-plugin-example: # param1: 'param from system.config' moesif: applicationId: your_moesif_application_id
your_moesif_application_idis obtained from your Moesif account and is required to authenticate your app with Moesif.
Other configuration options includes,
debug: turn on debug messages
sessionTokenHeader: Set the HTTP header key that contains your API’s Authorization token/API key. Moesif tries to detect sessions automatically. However, if we cannot detect it correctly, you can specify which header field to use.
Add moesif policy to whitelist of your
policies: - proxy # other policies. - moesif
- Add moesif policy to your pipelines.
pipelines: - name: getting-started apiEndpoints: - api policies: - moesif: - key-auth: - proxy: - action: serviceEndpoint: httpbin changeOrigin: true
To capture all data for a pipeline, please make sure to put Moesif at the top of the pipeline. If You have multiple pipelines, be sure to add the
moesif policy to each pipeline you want to capture data for.
This plugin is a simple wrapper around the moesif-express middleware.
Since Express Gateway’s configuration is designed to be declarative, some of the options from moesif-express that require a function are not ported over. We’ll do so at future.
If you need to use additional options, the easiest way is to fork this repo and add your required options to the