fastify-status

Returns common info about fastify server. Could be used for healthchecks and status monitoring.

ToC

• fastify-status
  • ToC
  • Installation
  • Usage
  • Format
  • Changelog
  • See also
  • License

Installation

npm i fastify-status --save

_{Back to top}

Usage

Example with default plugin options.

const fastify = require('fastify');
const statusPlugin = require('fastify-status');

const app = fastify();
app.register(statusPlugin, {
  info: '/__info__',
  alive: '/__alive__',
});

Use alive for healthchecks and info to get information and some stats of your server.

If info or alive is not present in config, then apropriate route will not be added.

_{Back to top}

Format

{
  uptime: '0d 0h 0m 10s',
  memory: {
    rss: '50Mb',
    external: '40Mb',
    heapTotal: '30Mb',
    heapUsed: '20Mb',
  },
  start: '2020-05-10T07:41:20.389Z',
  env: 'test',
  name: 'my-server',
  version: '1.0.0',
  node: 'v14.0.0'
}

_{Back to top}

Changelog

See changelog.

_{Back to top}

See also

• under-pressure - more advanced healthcheck.

License

Licensed under MIT.

_{Back to top}

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

2.2.1 (2020-05-24)

Bug Fixes

• clean package from junk (d7b12fd)

2.2.0 (2020-05-24)

Features

• tests, actions, logo linting (40cd26d)

Misc

• clean package.json (4fe4923)
• deps fix (6c213cb)

2.1.0 (2020-05-14)

Features

• don't add route if parameter missing (5ebafa5)

2.0.1 (2020-05-10)

Bug Fixes

• stats: stats calc fix (a2bd1e8)

2.0.0 (2020-05-10)

⚠ BREAKING CHANGES

• new output format | drop old node version support

Features

• new output format (adda8c6)

1.1.2 (2019-12-14)

Chores

• deps: update (4e1728b7)

1.1.1 (2018-09-20)

Bug Fixes

• env: place env to runtime (5abb2e8c)

1.1.0 (2018-09-20)

Chores

• deps: update eslint (34b03c36)

New Features

• deps: update deps (b9cceccc)

1.0.6 (2018-08-17)

Continuous Integration

• revert token (9b88945e)

1.0.5 (2018-08-17)

Continuous Integration

• export token (bc55492c)

1.0.4 (2018-08-17)

Continuous Integration

• remove npmrc (69d7afa6)

1.0.3 (2018-08-17)

Bug Fixes

• options: fix options defaults (4a7a5693)

1.0.2 (2018-08-16)

Chores

• docs: add description (40a7e068)

1.0.1 (2018-08-16)

Chores

• license: add license text (ebfc0140)

1.0.0 (2018-08-16)

New Features

• initial commit (133a58e3)