https://github.com/pinojs/pino-caller

🌲 Include call site of pino log messages
https://github.com/pinojs/pino-caller

caller debug logger logging pino productivity utility

Last synced: 7 days ago
JSON representation

🌲 Include call site of pino log messages

• Host: GitHub
• URL: https://github.com/pinojs/pino-caller
• Owner: pinojs
• License: other
• Created: 2017-02-17T21:25:23.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-03-18T17:56:27.000Z (8 months ago)
• Last Synced: 2024-04-13T18:06:29.722Z (7 months ago)
• Topics: caller, debug, logger, logging, pino, productivity, utility
• Language: JavaScript
• Homepage:
• Size: 186 KB
• Stars: 52
• Watchers: 8
• Forks: 13
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## pino-caller

[![npm version](https://img.shields.io/npm/v/pino-caller)](https://www.npmjs.com/package/pino-caller)

[![Build Status](https://img.shields.io/github/actions/workflow/status/pinojs/pino-caller/ci.yml?branch=master)](https://github.com/pinojs/pino-caller/actions)

[![Coverage Status](https://coveralls.io/repos/github/pinojs/pino-caller/badge.svg?branch=master)](https://coveralls.io/github/pinojs/pino-caller?branch=master)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)

### Description

`pino-caller` is a wrapper for [pino](https://github.com/pinojs/pino) which adds the call site of each log message to the log output.

This can be useful when developing with large codebases in order to locate the exact point where pino is invoked.

### Install

For Pino v4 and below use the v2 line, which can be installed with the `@legacy` tag:

```sh

npm install pino-caller@legacy

``` 

For Pino v5 and above use the v3+ line, which will install using the usual command:

```

npm install pino-caller

```

**WARNING: THIS IS A DEVELOPMENT TOOL AVOID PRODUCTION USE!**

### Usage

#### Basic

```js

'use strict'

const pino = require('pino')() // it will print as usual

const pinoCaller = require('pino-caller')(pino) // it will print also the calling site

pinoCaller.info('info1')

pinoCaller.error('error1')

pinoCaller.debug('debug1')

```

#### Advanced

```js

'use strict'

// dynamically load the plugin if in development environment, output paths relative to __dirname

const pino = process.env.NODE_ENV === 'development' ? require('pino-caller')(require('pino')(), { relativeTo: __dirname }) : require('pino')()

pino.info('info1')

pino.error('error1')

pino.debug('debug1')

```

You can find also a working example in the `examples` directory and you can run it with `npm run example`

##### Options

- **relativeTo** - Remove path prefixes from log messages to make them easier to read.

- **stackAdjustment** - For those who've wrapped pino, make pino-caller move N stackframes up to get a meaningful message.

```js

'use strict'

const pino = require('pino')()

const pinoCaller = require('pino-caller')(pino, { relativeTo: __dirname, stackAdjustment: 1 })

// People who have wrapped pino like in the contrived example below 

// will want to use stackAdjustment.

// Most people will NOT need this.  See issue #90 for details.

const log = {

  info: function(message) { pinoCaller.info(message) }

}

```

### Example output

```

╭─phra at debian in /home/phra/git/pino-caller (master ✔)

╰─λ npm run example

> [email protected] example /home/phra/git/pino-caller

> env NODE_ENV=development node examples/index.js

{"pid":44837,"hostname":"debian","level":30,"time":1487873713227,"msg":"hello from the module!","caller":"Object. (/home/phra/git/pino-caller/examples/module.js:4:12)","v":1}

{"pid":44837,"hostname":"debian","level":30,"time":1487873713230,"msg":"info1","caller":"Object. (index.js:8:12)","v":1}

{"pid":44837,"hostname":"debian","level":50,"time":1487873713230,"msg":"error1","caller":"Object. (index.js:9:12)","v":1}

```