@logtape/sentry/README.md

LogTape Sentry Sink

@logtape/sentry: LogTape Sentry Sink
====================================

[![JSR][JSR badge]][JSR]
[![npm][npm badge]][npm]
[![GitHub Actions][GitHub Actions badge]][GitHub Actions]

This package provides an [Sentry] sink for [LogTape]. It allows you to
capture your LogTape logs and send them to Sentry.

![LogTape messages show up in Sentry](./screenshot.png)

[JSR]: https://jsr.io/@logtape/sentry
[JSR badge]: https://jsr.io/badges/@logtape/sentry
[npm]: https://www.npmjs.com/package/@logtape/sentry
[npm badge]: https://img.shields.io/npm/v/@logtape/sentry?logo=npm
[GitHub Actions]: https://github.com/dahlia/logtape-sentry/actions/workflows/main.yaml
[GitHub Actions badge]: https://github.com/dahlia/logtape-sentry/actions/workflows/main.yaml/badge.svg
[Sentry]: https://sentry.io/
[LogTape]: https://logtape.org/


Installation
------------

The package is available on [JSR] and [npm].

~~~~ bash
deno add @logtape/sentry # for Deno
npm add @logtape/sentry  # for npm
pnpm add @logtape/sentry # for pnpm
yarn add @logtape/sentry # for Yarn
bun add @logtape/sentry  # for Bun
~~~~


Usage
-----

The quickest way to get started is to use the `getSentrySink()` function
without any arguments:

~~~~ typescript
import { configure } from "@logtape/logtape";
import { getSentrySink } from "@logtape/sentry";

await configure({
  sinks: {
    sentry: getSentrySink(),
  },
  filters: {},
  loggers: [
    { category: [], sinks: ["sentry"], level: "debug" },
  ],
});
~~~~

If you want to explicitly configure the Sentry client, you can pass the
`Client` instance to the `getSentrySink()` function:

~~~~ typescript
import { configure } from "@logtape/logtape";
import { init } from "@sentry/node";

const client = init({
  dsn: process.env.SENTRY_DSN,
});

await configure({
  sinks: {
    sentry: getSentrySink(client),
  },
  filters: {},
  loggers: [
    { category: [], sinks: ["sentry"], level: "debug" },
  ],
});
~~~~


Changelog
---------

### Version 0.1.0

Initial release.  Released on November 26, 2024.