Git Product home page Git Product logo

statful-middleware-koa's Introduction

statful-middleware-koa

A common pattern in koa applications it to gather response times from all received requests, this middleware takes care of collecting common useful metrics automatically.

npm version Build Status

Installing

npm install --save statful-middleware-koa statful-client
yarn add statful-middleware-koa statful-client

Getting started

const Koa = require("koa");
const app = new Koa();
const Statful = require("statful-client");
const statfulMiddleware = require("statful-middleware-koa");

const statful = new Statful({
  /* statful configuration */
});

app.use(statfulMiddleware(statful));
app.listen(3000);

Configuration

Most of the configuration is done directly in the statful instance. You can read more about the available options directly from the Statful repository.

Default Metrics

By default, the follow metrics are collected, with the corresponding tags:

  • response_time
    • hostname
    • method: GET, POST, PUT ...
    • statusCode: 200, 400, 404 ...
    • statusCodeCategory
      • informational
      • success
      • redirection
      • client_error
      • server_error
    • route: Either the route handler's name, the route path or unknown_route. e.g.: /users/:id?

Authors

Mindera - Software Craft

License

statful-middleware-koa is available under the MIT license. See the LICENSE file for more information.

statful-middleware-koa's People

Contributors

dependabot[bot] avatar jmtavares avatar maloky avatar sujatharamanmindera avatar

Stargazers

 avatar  avatar  avatar

Watchers

 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.