https://github.com/marvin-j97/skriva
Unopinionated logger, with 0 dependencies - tailored for Typescript usage.
https://github.com/marvin-j97/skriva
logger logging logging-library minimal typescript
Last synced: about 1 year ago
JSON representation
Unopinionated logger, with 0 dependencies - tailored for Typescript usage.
- Host: GitHub
- URL: https://github.com/marvin-j97/skriva
- Owner: marvin-j97
- Created: 2022-01-05T13:53:31.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-03T12:49:34.000Z (about 2 years ago)
- Last Synced: 2025-03-18T13:55:28.837Z (over 1 year ago)
- Topics: logger, logging, logging-library, minimal, typescript
- Language: TypeScript
- Homepage:
- Size: 179 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# skriva
[](https://github.com/marvin-j97/skriva/actions/workflows/node.js.yml)
From Old Norse _skrifa_, from Proto-Germanic _\*skrībaną_, a late borrowing from Latin _scrībō_ ("write")
## About
Super-unopinionated no-black-magic logger, with zero dependencies, tailored for Typescript usage.
Like other logging libraries, multiple transports with custom logging levels are supported.
## Install
```bash
npm i skriva
yarn add skriva
```
## Examples
### Define log levels
```typescript
// Lower value = more important
const logLevels = {
error: 0,
warn: 10,
info: 20,
debug: 30,
};
const logger = createLogger({
logLevels,
// Setting to 'info' will print everything up to info (error, warn, info in this case)
level: "info",
/* ... */
});
const logger1 = createLogger({
logLevels,
// Setting to an array works like a whitelist, so in this case ONLY info will be printed
level: ["info"],
/* ... */
});
```
### Basic console logger
```typescript
import { createLogger } from "skriva";
// Use prebuilt console transport
import { createConsoleTransport } from "skriva-transport-console";
const logLevels = {
error: 0,
warn: 10,
info: 20,
debug: 30,
};
// createLogger has 3 types that describe what types of logs are being used
// Type 1 is the message type, aka. the data that is being written
// Type 2 is the log level type
// Type 3 is the type of the base context
const logger = createLogger({
context: () => ({}),
logLevels,
level: "debug",
transports: [
// Transports receive an object (packet) containing:
// - the message
// - the log level
// - the base context (merged into the object)
{
handler: createConsoleTransport({
format: ({ message }) => message,
}),
},
],
});
// logger is fully type-safe, containing your custom log levels as functions
logger.info("This is a log");
// -> This is a log
```
### Base context
```typescript
const logger = createLogger({
// Adds timestamp to every log
// This alone won't make it show up in the message, you need to consume the context (see "More complex logger" or "Console logger with colours")
// The base context function is executed for every received log message
context: () => ({ timestamp: new Date() }),
/* ... */
});
```
### Basic JSON logger
```typescript
import { createLogger } from "skriva";
// Use prebuilt console transport
import { createConsoleTransport } from "skriva-transport-console";
const logLevels = {
error: 0,
warn: 10,
info: 20,
debug: 30,
};
const logger = createLogger({
context: () => ({ timestamp: new Date() }),
logLevels,
level: "debug",
transports: [
{
handler: createConsoleTransport({
format: (packet) => JSON.stringify(packet),
}),
},
],
});
logger.info("This is a log");
// -> {"timestamp":"2022-01-18T20:27:32.389Z","message":"This is a log","level":"info"}
```
### More complex logger
```typescript
import { createLogger } from "skriva";
// Use prebuilt console transport
import { createConsoleTransport } from "skriva-transport-console";
const logLevels = {
error: 0,
warn: 10,
info: 20,
debug: 30,
};
const logger = createLogger<
{ module: "orm" | "rest_api"; text: string },
typeof logLevels,
{ timestamp: Date }
>({
context: () => ({ timestamp: new Date() }),
logLevels,
level: "debug",
transports: [
{
handler: createConsoleTransport({
format: ({ message, ...rest }) => JSON.stringify({ ...message, ...rest }),
}),
},
],
});
logger.error({
module: "orm",
text: "i had an error",
});
// -> {"module":"orm","message":"i had an error","timestamp":"2022-01-18T20:31:10.553Z","level":"error"}
```
### Handle errors
```typescript
import { createLogger } from "skriva";
const logger = createLogger({
/* ... */
onError: (error) => {
console.error("Logging error");
sendMessageToSlack(error);
},
});
```
### Console logger with colours
```typescript
import { createLogger } from "skriva";
// Use prebuilt console transport
import { createConsoleTransport } from "skriva-transport-console";
import chalk from "chalk";
const logLevels = {
error: 0,
warn: 10,
info: 20,
debug: 30,
};
const colorize: Record = {
error: chalk.red,
warn: chalk.yellow,
info: chalk.green,
debug: chalk.magentaBright,
};
const logger = createLogger({
context: () => ({ timestamp: new Date() }),
logLevels,
level: "debug",
transports: [
{
handler: createConsoleTransport({
format: ({ timestamp, level, message }) =>
`${chalk.grey(timestamp.toISOString())} ${colorize[level](level)} ${message}`,
}),
},
],
});
logger.info("Hello world");
logger.debug("Another message");
logger.error("Oh no");
logger.warn("Warning");
```
## Transports
- [Console transport](./packages/transport-console) (recommended)
- [Rotating file transport](./packages/transport-rotate-file) (recommended)
- [Elasticsearch transport](./packages/transport-elasticsearch)
## Planned
- HTTP(s) transport
- Parseable transport
- DynamoDB transport
- Redis transport
- MongoDB transport
- SQS transport