# @sap-ux/logger

> A simple logging module

Latest version **1.0.3** (published 2026-07-07) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @sap-ux/logger
pnpm add @sap-ux/logger
yarn add @sap-ux/logger
bun add @sap-ux/logger
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2026-07-07 |
| First published | 2022-01-18 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=22.x |
| Dependencies | 4 |
| Unpacked size | 44.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 159 |
| Maintainers | tqueck, kranthie.sap, sap_extncrepos, sap-ospo-admin, devinea |

## Links

- npm: https://www.npmjs.com/package/@sap-ux/logger
- Repository: https://github.com/SAP/open-ux-tools
- Issues: https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Alogger
- npm.io page: https://npm.io/package/@sap-ux/logger

## Dependencies (4)

- [chalk](https://npm.io/package/chalk.md) 5.6.2
- [lodash](https://npm.io/package/lodash.md) 4.18.1
- [winston](https://npm.io/package/winston.md) 3.19.0
- [winston-transport](https://npm.io/package/winston-transport.md) 4.9.0

## Recent versions

- 1.0.3 (latest) — 2026-07-07
- 1.0.2 — 2026-07-03
- 1.0.1 — 2026-06-04
- 1.0.0 — 2026-05-30
- 0.9.0 — 2026-05-15
- 0.8.5 — 2026-04-08
- 0.8.4 — 2026-03-30
- 0.8.3 — 2026-03-26
- 0.8.2 — 2026-03-05
- 0.8.1 — 2026-01-30
- 0.8.0 — 2025-12-19
- 0.7.3 — 2025-12-18
- 0.7.2 — 2025-12-15
- 0.7.1 — 2025-11-05
- 0.7.0 — 2025-05-14
- … 23 more at https://npm.io/package/@sap-ux/logger/versions

## README

[![Changelog](https://img.shields.io/badge/changelog-8A2BE2)](https://github.com/SAP/open-ux-tools/blob/main/packages/logger/CHANGELOG.md) [![Github repo](https://img.shields.io/badge/github-repo-blue)](https://github.com/SAP/open-ux-tools/tree/main/packages/logger)

# [`@sap-ux/logger`](https://github.com/SAP/open-ux-tools/tree/main/packages/logger)

This is a simple logging library. It uses [Winston](https://github.com/winstonjs/winston) underneath to do the heavy-lifting. The API is agnostic to any particular logging library. Don't depend on any Winston-specific implemenation as the underlying library may change in the future.

### Quick Usage
Add the package `@sap-ux/logger` to your project using your preferred package manager.

In Typescript/ES6, import the logger and instantiate it. By default the log level is `info` and the logs are sent to the console.

```typescript
import { ToolsLogger } from '@sap-ux/logger';
...

const logger = new ToolsLogger();
...
logger.info('This is an information message');
...
logger.warn('This is a warning');
...
logger.error('This is an error!');
// Can also log objects
logger.debug({a: 42, b: 'some value'});
```

### Logger Options
| Option | Default Value | Description |
| ------ | ------------- | ----------- |
| `logLevel` | LogLevel.Info | Log only if equal to or more severe than this level ([supported levels](#log-levels)) |
| `transports` | [`ConsoleTransport`](#consoletransport) | An array of [transports](#transports) |

### Log Levels
Log levels are exposed an as enumeration.
The following levels are available, in decreasing order of severity:
* Error
* Warn
* Info
* Verbose
* Debug
* Silly

### Transports
These are the targets of the log messages. You can have multiple targets for a single logger. The targets can be added and removed dynamically, if required.

The following transports are currently supported:
#### `ConsoleTransport`
This is used to write to the `console`.
#### `FileTransport`
This is used to write to files. Logs are appended to files. Currently there's no support to rotate logs.

#### `VSCodeTransport`
This is used to write to an [output channel](https://code.visualstudio.com/api/extension-capabilities/common-capabilities#output-channel) in VS Code.
#### `NullTransport`
This is the equivalent of writing to `/dev/null`. If an API needs a logger and you really don't want to capture logs, you can use `NullTransport` to use completely ignore the logs.

### Logger API

#### Logging methods
`error()`, `warn()`, `info()` and `debug()` methods can be used to either print log a string or an object.

#### Transport management
You can `add()`, `remove()` transport dynamically. `transports()` returns a list of the current transports of the logger.

### Examples
The unit test file can be used as an example to explore the logger's API: [./test/unit/wiston-logger/logger.test.ts](./test/unit/wiston-logger/logger.test.ts)

Please refer to the debugging section in the project root [README](../../README.md) for help debugging the test.
### Not supported
The following options are not supported yet. There are no definite plans to add them in the future. They will be considered on a need-basis.

* Custom formatters
    - `VSCodeTransport` logs timestamped lines
    -  `FileTransport` logs in JSON
    -  `ConsoleTransport` logs colored and timestamped lines (piping will remove color encoding though)
* File rotation - the file transport appends to an existing file or creates a new one if missing

---
_Source: https://npm.io/package/@sap-ux/logger · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._