Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/toolsplus/stackdriver-logging-winston-koa
Koa middleware for Winston transport to Stackdriver Logging
https://github.com/toolsplus/stackdriver-logging-winston-koa
koa logging stackdriver winston
Last synced: 11 days ago
JSON representation
Koa middleware for Winston transport to Stackdriver Logging
- Host: GitHub
- URL: https://github.com/toolsplus/stackdriver-logging-winston-koa
- Owner: toolsplus
- Created: 2020-04-24T06:56:09.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T23:27:32.000Z (almost 2 years ago)
- Last Synced: 2024-11-24T16:22:35.204Z (2 months ago)
- Topics: koa, logging, stackdriver, winston
- Language: TypeScript
- Homepage:
- Size: 2.11 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# stackdriver-logging-winston-koa
[](https://badge.fury.io/js/stackdriver-logging-winston-koa)
[](https://codecov.io/gh/toolsplus/stackdriver-logging-winston-koa)
This module provides an [Koa](https://koajs.com) middleware for working with [Stackdriver Logging](https://cloud.google.com/logging/docs),
compatible with [Winston](https://www.npmjs.com/package/winston).
The implementation is adapted from the existing express middleware implementation
in [nodejs-logging-winston](https://github.com/googleapis/nodejs-logging-winston) module.
For general documentation on winston logging to Stackdriver please refer to the
[nodejs-logging-winston](https://github.com/googleapis/nodejs-logging-winston) module.
## Quickstart
### Installing the client library
```bash
npm install stackdriver-logging-winston-koa
```
### Using the koa middleware
We provide a middleware that can be used in an koa application. Apart from
being easy to use, this enables some more powerful features of Stackdriver
Logging: request bundling. Any application logs emitted on behalf of a specific
request will be shown nested inside the request log.
The middleware adds a `winston`-style log function to the `ctx` object. You
can use this wherever you have access to the `ctx` object. All log entries that
are made on behalf of a specific request are shown bundled together in the
Stackdriver Logging UI.
```javascript
const lw = require('stackdriver-logging-winston-koa');
const winston = require('winston');
// Import koa module and create an http server.
const koa = require('koa');
const logger = winston.createLogger();
async function startServer() {
// Create a middleware that will use the provided logger.
// A Stackdriver Logging transport will be created automatically
// and added onto the provided logger.
const mw = await lw.koa.makeMiddleware(logger);
// Alternatively, you can construct a LoggingWinston transport
// yourself and pass it int.
// const transport = new LoggingWinston({...});
// const mw = await lw.koa.makeMiddleware(logger, transport);
const app = koa();
// Install the logging middleware. This ensures that a Winston-style `log`
// function is available on the `context` object. Attach this as one of the
// earliest middleware to make sure that log function is available in all the
// subsequent middleware and routes.
app.use(mw);
// Setup an http route and a route handler.
app.use(async (ctx) => {
// `ctx.log` can be used as a winston style log method. All logs generated
// using `ctx.log` use the current request context. That is, all logs
// corresponding to a specific request will be bundled in the Stackdriver
// UI.
ctx.log.info('this is an info log message');
ctx.body = 'hello world';
});
// `logger` can be used as a global logger, one not correlated to any specific
// request.
logger.info('bonjour');
// Start listening on the http server.
app.listen(8080, () => {
console.log('http server listening on port 8080');
});
}
startServer();
```
## Contributing
Contributions welcome!
## License
Apache Version 2.0