Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luckydye/log
Practical logging for JavaScript applications.
https://github.com/luckydye/log
Last synced: 25 days ago
JSON representation
Practical logging for JavaScript applications.
- Host: GitHub
- URL: https://github.com/luckydye/log
- Owner: luckydye
- License: mit
- Created: 2024-02-04T12:58:01.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-12-28T14:34:31.000Z (28 days ago)
- Last Synced: 2024-12-28T15:26:06.419Z (28 days ago)
- Language: JavaScript
- Homepage:
- Size: 70.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# log
A small (<2KB gzipped minified) JavaScript logging library inspired by charmbracelet/log and docs.rs/env_logger.
## Usage
```bash
npm i @luckydye/log
```
## Examples
### Log levels
```javascript
import logger from '@luckydye/log';
const log = logger().prefix("Test").trace();
log.info("Log info");
log.error("This is an error!");
```
```bash
02/06/2024 00:38:05 INFO Test: Hello, world!!
02/05/2024 13:32:53 ERROR Test: This is an error!
03/01/2024 22:41:53 ERROR testing err=Test error
SyntaxError: Test error
at (:0)
at (/Users/tihav/source/log/log.spec.ts:82:1)
```
### Log images to supporting terminals
```javascript
log.img(path.resolve("./success.png"));
```
### Formatted arguments
```javascript
log.warn('An Object', 'obj', { one: 2 });
```
```bash
02/06/2024 00:38:05 WARN Text here obj=Object{"one":2}
```
### JSON output
```javascript
const logJson = logger().prefix('Json').trace().json();
logJson.info('Hello, world!');
```
```bash
{"ts":"2024-02-05T13:33:05.270Z","level":"info","prefix":"Json","location":"log.spec.ts:9:48","msg":"Hello, world!","args":["Hello, world!"]}
```
### Deno
```javascript
import logger from "npm:@luckydye/log";
const log = logger().prefix("Deno");
log.error("Test error");
```
### InfluxDB
Send logs to a InfluxDB (v2).
```javascript
import logger from "@luckydye/log";
import { InfluxWriteStream } from '@luckydye/log/influx';
const log = logger()
.prefix('Influx')
.pipeTo(
new InfluxWriteStream({
org: 'organisation',
bucket: 'bucket_name',
db: 'database_name',
url: 'https://influxdb.example.com',
token: 'ACCESS_TOKEN',
})
);
// JS_LOG filtering applies here as well
log.info('Hello, world!');
```
## Environment variables
### JS_LOG
Set the log level. Default is `info`.
#### Set log level for specific prefixes.
```bash
JS_LOG=[prefix][=][level][,...]
```
```bash
JS_LOG = "error,Test=debug"
```
## Configuration
### Prefix
```javascript
const log = logger().prefix("Topic");
```
### Enable stack trace
Display last frame of stack trace in the output.
```javascript
const log = logger().trace();
```
### Set time format
Set the time format. Default is `local`.
Set to `false` to disable time.
```javascript
const log = logger().time("local" | "kitchen" | "iso" | "utc");
// disable time
const log = logger().time(false);
```
### Enable json output
```javascript
const log = logger().json();
```
### Pipe log messages to arbitrary stream
```javascript
const log = logger().pipeTo(WriteableStream);
```