https://github.com/luxchanlu/moleculer-sentry

Moleculer metrics service for Sentry (https://sentry.io/)
https://github.com/luxchanlu/moleculer-sentry

javascript moleculer moleculerjs sentry sentry-io

Last synced: about 1 month ago
JSON representation

Moleculer metrics service for Sentry (https://sentry.io/)

• Host: GitHub
• URL: https://github.com/luxchanlu/moleculer-sentry
• Owner: LuxChanLu
• License: mit
• Created: 2019-04-04T14:09:13.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-28T19:14:45.000Z (almost 2 years ago)
• Last Synced: 2024-05-22T07:52:52.980Z (7 months ago)
• Topics: javascript, moleculer, moleculerjs, sentry, sentry-io
• Language: JavaScript
• Homepage:
• Size: 242 KB
• Stars: 11
• Watchers: 2
• Forks: 11
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# moleculer-sentry

[![Build](https://github.com/LuxChanLu/moleculer-sentry/actions/workflows/test.yml/badge.svg)](https://github.com/LuxChanLu/moleculer-sentry/actions/workflows/test.yml)

[![Coverage Status](https://coveralls.io/repos/github/LuxChanLu/moleculer-sentry/badge.svg?branch=master)](https://coveralls.io/github/LuxChanLu/moleculer-sentry?branch=master)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/42a2b5016bde4f2197f28389e221c61d)](https://www.codacy.com/gh/LuxChanLu/moleculer-sentry/dashboard?utm_source=github.com&utm_medium=referral&utm_content=LuxChanLu/moleculer-sentry&utm_campaign=Badge_Grade)

[![Maintainability](https://api.codeclimate.com/v1/badges/8fbbbade0e11725f5c57/maintainability)](https://codeclimate.com/github/LuxChanLu/moleculer-sentry/maintainability)

![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/moleculer-sentry)

[![Known Vulnerabilities](https://snyk.io/test/github/LuxChanLu/moleculer-sentry/badge.svg)](https://snyk.io/test/github/LuxChanLu/moleculer-sentry)

[![Downloads](https://img.shields.io/npm/dm/moleculer-sentry.svg)](https://www.npmjs.com/package/moleculer-sentry)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FLuxChanLu%2Fmoleculer-sentry.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FLuxChanLu%2Fmoleculer-sentry?ref=badge_shield)

## Usage

This package uses Moleculer's tracing function to catch errors and send them to sentry. In order for it to function

properly, you need to enable tracing and use the "Event" exporter. To see how to set up tracing, please refer to

the [moleculer documentation](https://moleculer.services/docs/0.14/tracing.html#Event).

```js

const SentryMixin = require('moleculer-sentry')

module.exports = {

  mixins: [SentryMixin],

  settings: {

    /** @type {Object?} Sentry configuration wrapper. */

    sentry: {

      /** @type {String} DSN given by sentry. */

      dsn: null,

      /** @type {String} Name of event fired by "Event" exported in tracing. */

      tracingEventName: '$tracing.spans',

      /** @type {Object} Additional options for `Sentry.init`. */

      options: {},

      /** @type {String?} Name of the meta containing user infos. */

      userMetaKey: null,

    },

  }

}

```