Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/igrek8/gc-json-logger
Log JSON entries to stdout/stderr to be queried in Google Cloud Monitoring
https://github.com/igrek8/gc-json-logger
google-cloud logger logging logging-library
Last synced: about 2 months ago
JSON representation
Log JSON entries to stdout/stderr to be queried in Google Cloud Monitoring
- Host: GitHub
- URL: https://github.com/igrek8/gc-json-logger
- Owner: igrek8
- License: mit
- Created: 2022-10-02T11:01:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-05T05:41:51.000Z (3 months ago)
- Last Synced: 2024-11-09T12:08:41.560Z (3 months ago)
- Topics: google-cloud, logger, logging, logging-library
- Language: TypeScript
- Homepage:
- Size: 1.64 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
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)
Allows printing logs to `stdout`, `stderr` for further action in Google Cloud platform. Given that log agent ingests logs from `stdout` streams when running in GKE.
[](https://www.npmjs.com/gc-json-logger)
[](https://codecov.io/gh/igrek8/gc-json-logger)
[](https://npm.runkit.com/gc-json-logger)
## Installation
```bash
npm install --save gc-json-logger
yarn add gc-json-logger
```
## View in Google Cloud Logging
## Integration
```js
const { Logger } = require('gc-json-logger');
const { createServer } = require('http');
let job = 0;
function scheduleJob() {
/**
* 4) Retrieving a context logger
*/
const logger = Logger.getLogger();
/**
* 5) Logs with job id from the parent
*/
logger.info('scheduling job');
setTimeout(() => {
/**
* 6) Logs with job id from the parent
*/
logger.info('job done');
}, 3000);
}
const server = createServer((_, res) => {
job++;
/**
* 1) Setting a context logger using job id
*/
const logger = new Logger(job);
Logger.runWith(logger, () => {
/**
* 2) Logs with with job id
*/
logger.info('creating a new job');
/**
* 3) Calls another function that uses the context
*/
scheduleJob();
res.setHeader('content-type', 'application/json');
res.end(JSON.stringify({ id: job, status: 'scheduled' }));
});
});
server.listen(8080);
```
```jsonc
{
"severity": "INFO",
"time": "2022-12-03T10:00:00.000Z",
"message": "creating a new job",
"logging.googleapis.com/operation": { "id": 1 } // <- always includes context id
}
{
"severity": "INFO",
"time": "2022-12-03T10:00:00.398Z",
"message": "scheduling job",
"logging.googleapis.com/operation": { "id": 1 } // <- always includes context id
}
{
"severity": "INFO",
"time": "2022-12-03T10:00:01.000Z",
"message": "job done",
"logging.googleapis.com/operation": { "id": 1 } // <- always includes context id
}
```
## Usage
The various logging methods (`debug`, `info`, `notice`, etc.) require two parameters. The first parameter is intended for a human-readable string, while the second parameter captures context (such as JSON objects with circular references).
Example of **incorrect** use: :x:
```ts
this.logger.log(Severity.DEBUG, JSON.stringify(someObject));
```
Example of **correct** use: :white_check_mark:
```ts
this.logger.debug('received tickets', someObject);
```