rstream-log-file

This project is part of the @thi.ng/umbrella monorepo.

• About
  • Status
• Installation
• Dependencies
• API
• Authors
• License

About

File output handler for structured, multilevel & hierarchical loggers based on @thi.ng/rstream. This is a support package for @thi.ng/rstream-log.

Status

STABLE - used in production

Search or submit any issues for this package

Installation

yarn add @thi.ng/rstream-log-file

ES module import:

<script type="module" src="https://cdn.skypack.dev/@thi.ng/rstream-log-file"></script>

Skypack documentation

For Node.js REPL:

# with flag only for < v16
node --experimental-repl-await

> const rstreamLogFile = await import("@thi.ng/rstream-log-file");

Package sizes (gzipped, pre-treeshake): ESM: 130 bytes

Dependencies

• @thi.ng/rstream

API

Generated API docs

import * as log from "@thi.ng/rstream-log";
import { writeFile } from "@thi.ng/rstream-log-file";

const logger = new log.Logger("main");

// add file output w/ post-filtering (only WARN or ERROR levels)
// and formatted as JSON
const writer = logger
    .transform(log.minLevel(log.Level.WARN), log.formatJSON())
    .subscribe(writeFile("main.log"));

logger.warn("eek!");

// appended to file:
// {"level":"WARN","id":"main","time":"2018-01-23T09:05:55.647Z","body":["eek!"]}

// optionally, cancel file writer
writer.done();

Authors

Karsten Schmidt

If this project contributes to an academic publication, please cite it as:

@misc{thing-rstream-log-file,
  title = "@thi.ng/rstream-log-file",
  author = "Karsten Schmidt",
  note = "https://thi.ng/rstream-log-file",
  year = 2017
}

License

© 2017 - 2021 Karsten Schmidt // Apache Software License 2.0