Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/igrek8/gc-json-logger-express
Structured logging for express.js app in GKE
https://github.com/igrek8/gc-json-logger-express
express-js google-cloud logger logging
Last synced: about 2 months ago
JSON representation
Structured logging for express.js app in GKE
- Host: GitHub
- URL: https://github.com/igrek8/gc-json-logger-express
- Owner: igrek8
- License: mit
- Created: 2022-10-03T09:11:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-08T19:22:42.000Z (9 months ago)
- Last Synced: 2024-11-15T05:56:57.782Z (2 months ago)
- Topics: express-js, google-cloud, logger, logging
- Language: TypeScript
- Homepage:
- Size: 1.63 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Logger for [Structured Logging](https://cloud.google.com/logging/docs/structured-logging) with [Asynchronous Context Tracking](https://nodejs.org/api/async_context.html#class-asynclocalstorage) (Stability: 2 - Stable) to log HTTP traffic in Express.JS in GKE
[](https://www.npmjs.com/gc-json-logger-express)
[](https://codecov.io/gh/igrek8/gc-json-logger-express)
[](https://npm.runkit.com/gc-json-logger-express)
## Installation
```bash
npm install --save gc-json-logger gc-json-logger-express
yarn add gc-json-logger gc-json-logger-express
```
## View in Google Cloud Logging
## Integration
```js
const { Logger, Severity } = require('gc-json-logger');
const { log } = require('gc-json-logger-express');
const express = require('express');
const app = express();
/* Set desired application log level */
Logger.setLevel(Severity.DEBUG);
/* Filter sensitive data or transform log entry */
app.use(
log((_req, _res, entry) => {
const severity = entry.meta.httpRequest?.status >= 500 ? Severity.ERROR : entry.severity;
return { ...entry, severity };
})
);
app.use(express.text());
app.use(express.json());
app.use((req, res) => res.status(500).send(req.body));
app.listen(3000);
```
### Mock Request
```bash
curl -X POST "http://localhost:3000/echo" \
-H "Content-Type: text/plain" \
-d 'Hello world!'
```
### Logged Request
```json
{
"severity": "INFO",
"timestamp": "2022-01-01T00:00:00.000Z",
"message": "200 POST /echo",
"httpRequest": {
"protocol": "HTTP/1.1",
"requestSize": "141",
"remoteIp": "::ffff:127.0.0.1",
"requestUrl": "http://localhost:3000/echo",
"requestMethod": "POST",
"userAgent": "curl/7.79.1",
"serverIp": "::ffff:127.0.0.1:3000"
},
"logging.googleapis.com/operation": {
"id": "Application"
}
}
```
### Logged Request and Response
```json
{
"severity": "ERROR",
"timestamp": "2022-01-01T00:00:00.000Z",
"message": "500 POST /echo (13ms)",
"httpRequest": {
"latency": "13ms",
"responseSize": "258",
"status": 500
},
"logging.googleapis.com/operation": {
"id": "Application"
},
"meta": {
"request": {
"headers": {
"host": "localhost:3000",
"user-agent": "curl/7.79.1",
"accept": "*/*",
"content-type": "text/plain",
"content-length": "12"
},
"body": "Hello world!"
},
"response": {
"headers": {
"x-powered-by": "Express",
"content-type": "text/html; charset=utf-8",
"content-length": "12",
"etag": "W/\"c-00hq6RNueFa8QiEjhep5cJRHWAI\""
},
"body": "Hello world!"
}
}
}
```