https://github.com/fastify/fastify-diagnostics-channel
Plugin to deal with diagnostics_channel on Fastify
https://github.com/fastify/fastify-diagnostics-channel
fastify fastify-plugin
Last synced: 3 months ago
JSON representation
Plugin to deal with diagnostics_channel on Fastify
- Host: GitHub
- URL: https://github.com/fastify/fastify-diagnostics-channel
- Owner: fastify
- License: other
- Created: 2020-11-23T16:58:36.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-01T16:05:45.000Z (8 months ago)
- Last Synced: 2024-10-03T02:33:47.399Z (8 months ago)
- Topics: fastify, fastify-plugin
- Language: JavaScript
- Size: 89.8 KB
- Stars: 17
- Watchers: 18
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @fastify/diagnostics-channel
[](https://www.npmjs.com/package/@fastify/diagnostics-channel)
[](https://standardjs.com/)
## Install
```sh
npm i @fastify/diagnostics-channel
```
## Usage
Register as a plugin. This will add some hooks that provide information through [`diagnostics_channel`](https://nodejs.org/api/diagnostics_channel.html)
```js
const fastify = require('fastify')()
fastify.register(require('@fastify/diagnostics-channel'), {})
```
_**Note**: check [examples/](./examples/index.js) to further information_
## What information is provided?
1. [onRoute Channel](#onroute-channel)
2. [onResponse Channel](#onresponse-channel)
3. [onError Channel](#onerror-channel)
4. [onTimeout Channel](#ontimeout-channel)
4. [onRequest Channel](#onrequest-channel)
The channels are prefixed by: `fastify.{HOOK_NAME}`
### onRoute Channel
**Channel**: `fastify.onRoute`
This event is sent at every route registered passing a `routeOptions` object
```js
const dc = require('node:diagnostics_channel')
const onRoute = dc.channel('fastify.onRoute')
onRoute.subscribe((routeOptions) => {
routeOptions.method
routeOptions.schema
routeOptions.url // the complete URL of the route, it will inclued the prefix if any
routeOptions.path // `url` alias
routeOptions.routePath // the URL of the route without the prefix
routeOptions.bodyLimit
routeOptions.logLevel
routeOptions.logSerializers
routeOptions.prefix
})
```
### onResponse Channel
**Channel**: `fastify.onResponse`
This event is sent at every response sent by server, it propagates an object containing: [`request` object](https://fastify.dev/docs/latest/Reference/Request) and [`reply` object](https://fastify.dev/docs/latest/Reference/Reply)
```js
const dc = require('node:diagnostics_channel')
const onResponse = dc.channel('fastify.onResponse')
onResponse.subscribe((data) => {
data.request
data.reply
})
```
### onError Channel
**Channel**: `fastify.onError`
This event is sent when some error is throw on the [lifecycle](https://fastify.dev/docs/latest/Reference/Lifecycle/) of Fastify.
The message data is an object containing a [`request` object](https://fastify.dev/docs/latest/Reference/Request), [`reply` object](https://fastify.dev/docs/latest/Reference/Reply), and Error object
```js
const dc = require('node:diagnostics_channel')
const onError = dc.channel('fastify.onError')
onError.subscribe((data) => {
data.request
data.reply
data.error // error object throwed
})
```
### onTimeout Channel
**Channel**: `fastify.onTimeout`
This event is sent when a request spent more time than [`connectionTimeout`](https://fastify.dev/docs/latest/Reference/Server/#connectiontimeout) specifies. For further information about `connectionTimeout` check the Fastify documentation.
The message data is an object containing a [`request` object](https://fastify.dev/docs/latest/Reference/Request), [`reply` object](https://fastify.dev/docs/latest/Reference/Reply), and `connectionTimeout` value
Note: by default the Fastify does not limit the request time.
```js
const dc = require('node:diagnostics_channel')
const onTimeout = dc.channel('fastify.onTimeout')
onTimeout.subscribe((data) => {
data.connectionTimeout
data.reply
data.request
})
```
### onRequest Channel
**Channel**: `fastify.onRequest`
This event is sent when a request is received; the message data is an object containing a [`request` object](https://fastify.dev/docs/latest/Reference/Request) and [`reply` object](https://fastify.dev/docs/latest/Reference/Reply)
```js
const dc = require('node:diagnostics_channel')
const onRequest = dc.channel('fastify.onRequest')
onRequest.subscribe((data) => {
data.request
data.reply
})
```
## License
Licensed under [MIT](./LICENSE).