Socket
Socket
Sign inDemoInstall

@sentry/types

Package Overview
Dependencies
0
Maintainers
11
Versions
436
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @sentry/types

Types for all Sentry JavaScript SDKs


Version published
Maintainers
11
Install size
260 kB
Created

Package description

What is @sentry/types?

The @sentry/types package provides TypeScript definitions for Sentry's JavaScript SDK. It includes types for Sentry's configuration options, event objects, and various interfaces used within Sentry's SDKs. This package is primarily used by developers to ensure type safety and autocompletion when working with Sentry in a TypeScript environment.

What are @sentry/types's main functionalities?

Event Interface

Defines the structure of an event that can be sent to Sentry. This includes the event's ID, level, timestamp, platform, and SDK information.

{
  event_id: string;
  level: 'error' | 'warning' | 'info' | 'debug';
  timestamp: number;
  platform: string;
  sdk: {
    name: string;
    version: string;
  };
}

Options Interface

Specifies the options for configuring the Sentry SDK. This includes the DSN (Data Source Name), breadcrumb limits, debug mode, integrations, and a beforeSend hook for event manipulation.

{
  dsn: string;
  maxBreadcrumbs: number;
  debug: boolean;
  integrations: Integration[];
  beforeSend: (event: Event) => Event | null;
}

Breadcrumb Interface

Describes a breadcrumb, which is a snapshot of data that describes what happened before an event. This includes the timestamp, message, category, level, and any additional data.

{
  timestamp: number;
  message: string;
  category: string;
  level: 'critical' | 'error' | 'warning' | 'info' | 'debug';
  data: Record<string, any>;
}

Other packages similar to @sentry/types

Changelog

Source

7.92.0

Important Changes

Deprecations
  • feat(core): Add span.updateName() and deprecate span.setName() (#10018)
  • feat(core): Deprecate span.getTraceContext() (#10032)
  • feat(core): Deprecate span.toTraceparent() in favor of spanToTraceHeader() util (#10031)
  • feat(core): Deprecate trace in favor of startSpan (#10012)
  • feat(core): Deprecate span toContext() and updateWithContext() (#10030)
  • ref: Deprecate deepReadDirSync (#10016)
  • ref: Deprecate lastEventId() (#10043)

Please take a look at the Migration docs for more details. These methods will be removed in the upcoming v8 major release.

Cron Monitoring Support for cron and node-cron libraries
  • feat(node): Instrumentation for cron library (#9999)
  • feat(node): Instrumentation for node-cron library (#9904)

This release adds instrumentation for the cron and node-cron libraries. This allows you to monitor your cron jobs with Sentry cron monitors.

For cron:

import * as Sentry from '@sentry/node';
import { CronJob } from 'cron';

const CronJobWithCheckIn = Sentry.cron.instrumentCron(CronJob, 'my-cron-job');

// use the constructor
const job = new CronJobWithCheckIn('* * * * *', () => {
  console.log('You will see this message every minute');
});

// or from
const job = CronJobWithCheckIn.from({
  cronTime: '* * * * *',
  onTick: () => {
    console.log('You will see this message every minute');
  },
});

For node-cron:

import * as Sentry from '@sentry/node';
import cron from 'node-cron';

const cronWithCheckIn = Sentry.cron.instrumentNodeCron(cron);

cronWithCheckIn.schedule(
  '* * * * *',
  () => {
    console.log('running a task every minute');
  },
  { name: 'my-cron-job' },
);

Other Changes

  • feat(astro): Add enabled option to Astro integration options (#10007)
  • feat(core): Add attributes to Span (#10008)
  • feat(core): Add setClient() and getClient() to Scope (#10055)
  • feat(integrations): Capture error cause with captureErrorCause in ExtraErrorData integration (#9914)
  • feat(node-experimental): Allow to pass base span options to trace methods (#10006)
  • feat(node): Local variables via async inspector in node 19+ (#9962)
  • fix(astro): handle commonjs related issues (#10042)
  • fix(astro): Handle non-utf8 encoded streams in middleware (#9989)
  • fix(astro): prevent sentry from externalized (#9994)
  • fix(core): Ensure withScope sets current scope correctly with async callbacks (#9974)
  • fix(node): ANR fixes and additions (#9998)
  • fix(node): Anr should not block exit (#10035)
  • fix(node): Correctly resolve module name (#10001)
  • fix(node): Handle inspector already open (#10025)
  • fix(node): Make NODE_VERSION properties required (#9964)
  • fix(node): Anr doesn't block exit (#10064)
  • fix(utils): use correct typeof URL validation (#10028)
  • perf(astro): reduce unnecessary path resolutions (#10021)
  • ref(astro): Use astro logger instead of console (#9995)
  • ref(remix): Isolate Express instrumentation from server auto-instrumentation. (#9966)

Work in this release contributed by @joshkel. Thank you for your contribution!

Readme

Source

Sentry

Sentry JavaScript SDK Types

npm version npm dm npm dt

General

Common types used by the Sentry JavaScript SDKs.

FAQs

Last updated on 04 Jan 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc