koa1-server-timing

0.2.4 • Public • Published

koa1-server-timing

Koa1 Server-Timing header middleware.

Installation

$ npm install koa1-server-timing

API

const Koa = require('koa');
const app = new Koa();
app.use(require('koa-server-timing')({ total: true /* default to NODE_ENV !== 'production' */ }));

this.state.timings.startSpan('A Task description', 'taskSlug' /* optional, will be created a-task-description, if missed */)

/* ... do some long task to measure here */
this.state.timings.stopSpan('A Task description' /* or 'taskSlug' or return from startSpan */);

Options

  • total where do you want to see total processing time in Server-Timings

Example

const timings = require('koa1-server-timing');
const koa = require('koa');
const db = require('./mongoose');
const app = koa();

app.use(timings());

app.listen(3000);

console.log('listening on port 3000');

app.use(function * () {
    this.state.timings.startSpan('Query DB for User object');
    const user = await db.User.findOne({ email: 'test@test.com' }).exec();
    this.state.timings.stopSpan('Query DB for User object'); // or just pass return of startSpan (it will be a slug)
})

Dependents (0)

Package Sidebar

Install

npm i koa1-server-timing

Weekly Downloads

4

Version

0.2.4

License

MIT

Unpacked Size

6.4 kB

Total Files

4

Last publish

Collaborators

  • sharkseven