# tachyon-logger

> Tachyon logger provides an opinionated wrapper over Sentry.

Latest version **32.0.0** (published 2024-02-21) · UNLICENSED license · 0 weekly downloads

## Install

```sh
npm install tachyon-logger
pnpm add tachyon-logger
yarn add tachyon-logger
bun add tachyon-logger
```

## Health

**Score 30/100 (F)** — status: abandoned.

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 32.0.0 |
| Published | 2024-02-21 |
| First published | 2024-02-21 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 10 |
| Unpacked size | 26.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Emerging Platforms Engineering |
| Maintainers | frgjdhskxjogu |

## Links

- npm: https://www.npmjs.com/package/tachyon-logger
- Homepage: https://git.xarth.tv/pages/emerging-platforms/tachyon/
- npm.io page: https://npm.io/package/tachyon-logger

## Dependencies (10)

- [tsc](https://npm.io/package/tsc.md) ^2.0.4
- [type-fest](https://npm.io/package/type-fest.md) ^2.3.4
- [typescript](https://npm.io/package/typescript.md) ^4.1.5
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.15.0
- [@sentry/browser](https://npm.io/package/@sentry/browser.md) ^6.19.7
- [tachyon-utils-ts](https://npm.io/package/tachyon-utils-ts.md) ^32.0.0
- [tachyon-environment](https://npm.io/package/tachyon-environment.md) ^32.0.0
- [tachyon-utils-crypto](https://npm.io/package/tachyon-utils-crypto.md) ^32.0.0
- [tachyon-utils-stdlib](https://npm.io/package/tachyon-utils-stdlib.md) ^32.0.0
- [tachyon-utils-twitch](https://npm.io/package/tachyon-utils-twitch.md) https://registry.npmjs.org/tachyon-utils-twitch1/-/tachyon-utils-twitch1-32.0.0.tgz

## Recent versions

- 32.0.0 (latest) — 2024-02-21

## README

# Tachyon Logger

The tachyon logger provides the ability to log to both the local console and to
Sentry. Error messages are sent to Sentry for monitoring, and all other log
entries are collected as breadcrumbs to aid debugging.

## Installation

```sh
$ yarn add tachyon-logger
```

## Usage

The primary usage is via the exported `logger` instance, which exposes all of
the `console` methods (`log`, `error`, etc) and is intended to be used in place
of `console`. `logger`'s method are more opinionated about having a specific
shape in order to enforce more useful data collection for reporting to Sentry.

```ts
import { logger } from 'tachyon-logger';

logger.log({
  category: 'some grouping info',
  message: 'something happened',
  package: 'top-level grouping',
});
```

## Sentry Integration

### Configuration

Without configuration, `logger` will only report to the local console. The
package exports `configureClientLogging` which allows you to pass in your app's
Sentry DSN (among other values which are noted in the TypeDocs). After
successful configuration, `logger` will also report data to Sentry as well.

Currently, the sentry integration is only tested for use in the browser, but
aliasing `@sentry/browser` to `@sentry/node` should make things work server-side
as well.

### log/debug/info/warning

For normal log statements, `logger` will capture them as a breadcrumb for any
errors that arise in the future. This allows you to naturally develop an event
trail in the case that an error occurs. For any given log entry, you can disable
this auto-breadcrumbing with the `localOnly` option. These entries also have an
optional `context` key which accepts a flat object with primitive-only values
for enhanced data collection.

### error

For `console.error` logs, these are reported to Sentry as errors (triggering the
collection of the preceding breadcrumbs). In addition to an error message, error
logs can also have an optional `error` key for accepting an `Error` object and
an optional `level` key for modulating the level of the error. If an `error` is
not passed, the `message` is used as the error text.

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