National Public Mania

    strapi-plugin-moesif

    2.0.5 • Public • Published

    Strapi plugin moesif

    WARNING (Breaking Changes): ^2.0.0 only supports Strapi v4 and above. For Strapi v3 support, use ^1.0.5

    Plugin to add Moesif API Analytics and Monitoring to Strapi!

    Installation

    1. Install the plugin
    npm install --save strapi-plugin-moesif
    1. Enable the plugin ./config/plugins.js
    module.exports = {
      'strapi-plugin-moesif': {
        enabled: true,
        config: {
          moesif: {
            //custom config passed to moesif middleware goes here
          }
        },
      },
    }
    1. Add Moesif to your middleware array ./config/middleware.js
    module.exports = [
      'strapi::errors',
      'strapi::security',
      'strapi::cors',
      'strapi::poweredBy',
      'strapi::logger',
      'strapi::query',
      'strapi::body',
      'strapi::favicon',
      'strapi::public',
      'plugin::strapi-plugin-moesif.moesif'
    ];

    Add MOESIF_APPLICATION_ID to your environment variables 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.

    1. Run Strapi

    npm

    npm run develop

    yarn

    yarn develop

    Make a few API calls to your resources like so:

    curl `http://localhost:1337`

    Heroku

    If using Heroku, simply install the Moesif application as an add-on. The MOESIF_APPLICATION_ID environment variable will be automatically created and managed by Heroku.

    Configuration options

    Because this plugin uses moesif-nodejs under the hood, all of the configuration options for moesif-nodejs are supported by this plugin also.

    identifyUser

    To track Strapi users, we set the identifyUser function by default:

    identifyUser: function (req, res) {
      if (req.state && req.state.user) {
        return String(req.state.user.id);
      }
      return undefined;
    }

    skip

    Moesif can be setup to track all traffic in and out of your application, but usually the interest is in API metrics specifically. The default configuration of this plugin skips all non-JSON communication to avoid having tons of file requests in your Moesif dashboard.

    To override the skip function, simple include one in your config, or set to to send all communications:

    // return true if the data should be skipped
    skip: function (req, res) {
      // don't log non JSON types
      return (
        res.headers && !res.headers["Content-Type"].includes("application/json")
      );
    }
    
    //send all data regardless of type
    skip: null

    Credits

    This plugin was originally created by Bobby Glidwell

    Keywords

    none

    Install

    npm i strapi-plugin-moesif

    DownloadsWeekly Downloads

    19

    Version

    2.0.5

    License

    MIT

    Unpacked Size

    9.48 kB

    Total Files

    17

    Last publish

    Collaborators

    • sintex