Git Product home page Git Product logo

sails-hook-apianalytics's Introduction

APIAnalytics

A Sails hook for logging detailed request metadata and monitoring your API.

Install

From your sails app:

$ npm install sails-hook-apianalytics

Set Up

This hook is configured under the apianalytics key.

For instance, you might create config/apianalytics.js:

module.exports = {
  apianalytics: {
    /**
     * The types of requests to log
     * (e.g. ["get /foo/bar", "post /foo", "/*"])
     * Defaults to all routes.
     */
    routesToLog: [
      '/*'
    ],
    
    /**
     * Parameters which should NEVER be logged
     * (e.g. "password")
     * If seen, they will be replaced with "*PROTECTED*"
     */
    dontLogParams: ['password', 'token'],
    
    // When request starts
    onRequest: function onRequest(log, req, res) {
      // Defaults to doing nothing
    },
    
    // When request is done
    onResponse: function onResponse(log, req, res) {
      // Defaults to logging request metadata to the console in a vaguely attractive way
    }
  }
};

License

MIT

© 2013 Mike McNeil

sails-hook-apianalytics's People

Contributors

tarlepp avatar mikermcneil avatar

Watchers

James Cloos avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.