https://github.com/uphold/debino
A logging library that combines the simplicity and convenience of debug with the power of pino.
https://github.com/uphold/debino
Last synced: 18 days ago
JSON representation
A logging library that combines the simplicity and convenience of debug with the power of pino.
- Host: GitHub
- URL: https://github.com/uphold/debino
- Owner: uphold
- License: mit
- Created: 2024-12-20T15:21:55.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2025-01-22T05:09:22.000Z (4 months ago)
- Last Synced: 2025-04-28T11:21:31.681Z (28 days ago)
- Language: JavaScript
- Homepage:
- Size: 261 KB
- Stars: 0
- Watchers: 30
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# debino
[](https://github.com/uphold/debino/actions/workflows/tests.yaml)
[](https://github.com/uphold/debino/actions/workflows/release.yaml)
A logging library that combines the simplicity and convenience of [debug](https://github.com/debug-js/debug) with the power of [pino](https://github.com/pinojs/pino).
## Installation
```bash
npm install @uphold/debino
```
## Usage
By default, similarly to `debug`'s behavior, loggers do not output any content. Each logger output can be selectively activated by using the `DEBUG` environment variable. Pattern matching is based on the logger's name and it can optionally contain colons (`:`) to create (sub)-components properties on the logger instance.
A logger named `foo:bar:biz` creates a `pino` child logger with `name` equal to `foo`, property `component` equal to `bar` and `subcomponent` equal to `biz`.
Considering the following example:
```js
// example.js
import { debino } from '@uphold/debino';
const child1 = debino('foo');
const child2 = debino('foo:bar');
child1.debug('net');
child2.debug('qux');
```
*Example output with `DEBUG=foo*`*:
```bash
DEBUG=foo* node example.js
{"level":20,"time":1734717092221,"pid":99831,"hostname":"Andr-Cruz-0688L","name":"foo","msg":"net"}
{"level":20,"time":1734717092221,"pid":99831,"hostname":"Andr-Cruz-0688L","name":"foo","component":"bar","msg":"qux"}
```
*Example output with `DEBUG=foo:bar`*:
```bash
DEBUG=foo:bar node example.js
{"level":20,"time":1734717270874,"pid":1035,"hostname":"Andr-Cruz-0688L","name":"foo","component":"bar","msg":"qux"}
```
The `prefix` and `suffix` for each component is also customizable:
```js
const child = debino('foo', { suffix: 'module' });
```
When creating a child logger, you may also pass any options accepted by `pino.child()` method:
```js
const child = debino('foo', { redact: ['foo']});
```
### Log level
The `level` pino option is respected if the logger output is active.
```js
const logger = debino('root')('foo', { level: 'info' });
```
You may also set the log level via the `LOG_LEVEL` environment variable. However, the `level` option will always take precedence over it.
If both `level` and `LOG_LEVEL` are not set, it will use the value from
the root logger (See the [Root Logger](#root-logger) section below for more information).
### Root logger
Every call to `debino` creates a child logger based on a root logger. The default root logger is an instance returned by `pino({ level: 'debug' })`. You may set your own root logger by calling `setRootLogger()`:
```js
import { debino, pino, setRootLogger } from '@uphold/debino';
// Call this as soon as possible in your application.
setRootLogger(pino({ redact: ['foo'] }));
const logger = debino('foo');
```
## License
[MIT](./LICENSE)
## Contributing
### Development
Install dependencies:
```bash
npm i
```
Run tests:
```bash
npm run test
```
### Cutting a release
The release process is automated via the [release](https://github.com/uphold/debino/actions/workflows/release.yaml) GitHub workflow. Run it by clicking the "Run workflow" button.