README.md

Moesif Plugin for Express Gateway

Express Gateway is an open-source API Gateway/API Management application built on the Node.js express framework.

Moesif is an API analytics, monitoring and log analysis platform.

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

• Follow instructions for setting up Express Gateway

• 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 system.config.yml

  plugins:
    # express-gateway-plugin-example:
    #   param1: 'param from system.config'
    moesif:
      applicationId: 'Your Moesif Application Id'

Your Moesif Application Id can be found in the Moesif Portal. After signing up for a Moesif account, your Moesif Application Id will be displayed during the onboarding steps.

You can always find your Moesif Application Id at any time by logging into the Moesif Portal, click on the top right menu, and then clicking Installation.

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 gateway.config.yml

  policies:
    - proxy
    # other policies.
    - moesif

• Add moesif policy to your pipelines also in the gateway.config.yml.

  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.

Additional Info:

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 in the future.

In the mean time, if you need to use additional options, the easiest way is to fork this repo and add your required options to the middlewareCreator.js file.