Skip to content

Commit d101019

Browse files
committed
Improve documentation
1 parent 75666c9 commit d101019

File tree

1 file changed

+33
-25
lines changed

1 file changed

+33
-25
lines changed

README.md

Lines changed: 33 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -36,28 +36,33 @@ module.
3636
Default config:
3737

3838
```javascript
39-
title: 'Nest.js Status Monitor', // Default title
39+
pageTitle: 'Nest.js Monitoring Page',
40+
port: 3001,
4041
path: '/status',
41-
spans: [{
42-
interval: 1, // Every second
43-
retention: 60 // Keep 60 datapoints in memory
44-
}, {
45-
interval: 5, // Every 5 seconds
46-
retention: 60
47-
}, {
48-
interval: 15, // Every 15 seconds
49-
retention: 60
50-
}],
42+
ignoreStartsWith: '/healt/alive',
43+
spans: [
44+
{
45+
interval: 1, // Every second
46+
retention: 60, // Keep 60 datapoints in memory
47+
},
48+
{
49+
interval: 5, // Every 5 seconds
50+
retention: 60,
51+
},
52+
{
53+
interval: 15, // Every 15 seconds
54+
retention: 60,
55+
}
56+
],
5157
chartVisibility: {
5258
cpu: true,
5359
mem: true,
5460
load: true,
5561
responseTime: true,
5662
rps: true,
57-
statusCodes: true
63+
statusCodes: true,
5864
},
59-
healthChecks: [],
60-
ignoreStartsWith: '/admin'
65+
healthChecks: []
6166
```
6267

6368
## Health Checks
@@ -68,17 +73,20 @@ endpoint returns a 200 status code.
6873

6974
```javascript
7075
// config
71-
healthChecks: [{
72-
protocol: 'http',
73-
host: 'localhost'
74-
path: '/healt/alive',
75-
port: '3001'
76-
}, {
77-
protocol: 'http',
78-
host: 'localhost'
79-
path: '/healt/dead',
80-
port: '3001'
81-
}]
76+
healthChecks: [
77+
{
78+
protocol: 'http',
79+
host: 'localhost',
80+
path: '/health/alive',
81+
port: 3001,
82+
},
83+
{
84+
protocol: 'http',
85+
host: 'localhost',
86+
path: '/health/dead',
87+
port: 3001,
88+
},
89+
];
8290
```
8391

8492
## License

0 commit comments

Comments
 (0)