https://github.com/statful/statful-middleware-koa

Middleware for Koa servers to gather and send metrics to Statful.
https://github.com/statful/statful-middleware-koa

koa metrics middleware nodejs performance statful

Last synced: 1 day ago
JSON representation

Middleware for Koa servers to gather and send metrics to Statful.

• Host: GitHub
• URL: https://github.com/statful/statful-middleware-koa
• Owner: statful
• License: mit
• Created: 2018-07-12T10:39:48.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T02:44:25.000Z (over 1 year ago)
• Last Synced: 2024-11-01T20:45:38.159Z (19 days ago)
• Topics: koa, metrics, middleware, nodejs, performance, statful
• Language: JavaScript
• Homepage: https://www.statful.com/
• Size: 1.1 MB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# 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](https://badge.fury.io/js/statful-middleware-koa.svg)](https://badge.fury.io/js/statful-middleware-koa) [![Build Status](https://travis-ci.org/statful/statful-middleware-koa.svg?branch=master)](https://travis-ci.org/statful/statful-middleware-koa)

## Installing

```shell

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

```

```shell

yarn add statful-middleware-koa statful-client

```

## Getting started

```js

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](https://github.com/statful/statful-client-nodejs#global-configuration).

## 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](https://github.com/Mindera)

## License

statful-middleware-koa is available under the MIT license. See the [LICENSE](https://raw.githubusercontent.com/statful/statful-middleware-koa/master/LICENSE.md) file for more information.