Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/glebec/volleyball
🏐 Tiny HTTP logger for Express showing asynchronous requests and responses
https://github.com/glebec/volleyball
async express-middleware http http-logs logger logger-middleware logging
Last synced: 18 days ago
JSON representation
🏐 Tiny HTTP logger for Express showing asynchronous requests and responses
- Host: GitHub
- URL: https://github.com/glebec/volleyball
- Owner: glebec
- License: mit
- Created: 2016-08-13T20:06:24.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-09-27T00:52:51.000Z (about 4 years ago)
- Last Synced: 2024-10-12T17:44:26.466Z (about 1 month ago)
- Topics: async, express-middleware, http, http-logs, logger, logger-middleware, logging
- Language: JavaScript
- Homepage:
- Size: 1.95 MB
- Stars: 45
- Watchers: 2
- Forks: 19
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 🏐 Volleyball
[](https://www.npmjs.com/package/volleyball)
[](https://travis-ci.org/glebec/volleyball)
[](https://greenkeeper.io/)
[](https://github.com/prettier/prettier)
### Small Express HTTP logger for debugging asynchronous requests and responses
```js
const app = require('express')()
const volleyball = require('volleyball')
app.use(volleyball)
```
Volleyball is a minimal Connect-style middleware function which logs incoming requests and outgoing responses as separate events. It optionally supports the [`debug`](https://github.com/visionmedia/debug#readme) module.
## Motivation
Logging HTTP cycles can be approached in several ways, each with its own drawbacks:
* Log only upon **request**. Drawback: we cannot log the corresponding response, which happens later (if at all).
* Log only upon **response**, attaching the request. Drawback A: if the server never sends a response, e.g. due to a bug, the request will not be logged either. Drawback B: two temporally distinct events are conflated, misleadingly.
* Log both upon **request** and **response**. Drawback: it is not necessarily clear which responses are for which requests.
Volleyball takes the last approach, and assigns randomly-generated ids to label request-response pairs. It is designed for student project development, teaching beginning programmers how HTTP servers and asynchronicity work. It may also be useful as a low-configuration debug tool.
## Usage
### `volleyball`
The `volleyball` module can be used directly as demonstrated in the first example. The module defaults to using `process.stdout` for output.
### `volleyball.custom(config)`
A customized logging middleware can be generated by calling `custom` with a configuration object:
```js
const logger = volleyball.custom({ debug: true }) // default namespace 'http'
// const logger = volleyball.custom({ debug: 'custom-namespace' })
// const logger = volleyball.custom({ debug: debugInstance })
app.use(logger)
```
The `debug` property logs using the [`debug`](https://github.com/visionmedia/debug#readme) module. It supports the following values:
| value | result |
| -------- | ------------------------------------------------------------------------------------------------------------------------ |
| `true` | uses a new debug instance with a default namespace of `'http'` |
| string | uses a new debug instance with a custom namespace |
| function | uses any function, such as a pre-generated debug instance. Note that the function will be called with colorized strings. |
## Related and Alternatives
For more powerful, configurable, and compatible logging needs, check out:
* [debug](https://github.com/visionmedia/debug#readme)
* [morgan](https://github.com/expressjs/morgan#readme)
* [morgan-debug](https://github.com/ChiperSoft/morgan-debug#readme)
* [winston](https://github.com/winstonjs/winston#readme)
* [express-winston](https://github.com/bithavoc/express-winston#readme)
* [node-bunyan](https://github.com/trentm/node-bunyan/#readme)