Sentry 開發者貢獻指南 - JavaScript SDK Minimal

作者：為少 2022-01-21 21:33:03

它允許庫作者添加對 Sentry SDK 的支持，而無需捆綁整個 SDK 或依賴于特定平臺。簡單來說，它是 @sentry/node 或 @sentry/browser 等特定于平臺的 SDK 庫的公共基礎部分。

簡介

嵌入到應用程序中時使用配置 ??client??? 的最小 ??Sentry SDK???。它允許??庫作者???添加對 ??Sentry SDK?? 的支持，而無需捆綁整個 ??SDK??? 或依賴于特定平臺。簡單來說，它是 ??@sentry/node??? 或 ??@sentry/browser?? 等特定于平臺的 SDK 庫的公共基礎部分。

Sentry JavaScript SDK Minimal

??https://github.com/getsentry/sentry-javascript/tree/master/packages/minimal??

用法

要使用 ??minimal???，您不必初始化 ??SDK???。這應該由您庫的用戶處理。而是直接使用 ??@sentry/minimal?? 的導出函數添加面包屑或捕獲事件：

import * as Sentry from '@sentry/minimal';

// 為未來的事件添加面包屑
Sentry.addBreadcrumb({
  message: 'My Breadcrumb',
  // ...
});

// 捕獲異常、消息或手動事件
Sentry.captureMessage('Hello, world!');
Sentry.captureException(new Error('Good bye'));
Sentry.captureEvent({
  message: 'Manual',
  stacktrace: [
    // ...
  ],
});

請注意，雖然嚴格可行，但不鼓勵干擾事件上下文。如果由于某種原因您的庫需要注入上下文信息，請注意這可能會覆蓋用戶的上下文值：

// 設置用戶信息、標簽和其他附加信息
Sentry.configureScope(scope => {
  scope.setExtra('battery', 0.7);
  scope.setTag('user_mode', 'admin');
  scope.setUser({ id: '4711' });
  // scope.clear();
});

測試用例

PASS  test/lib/minimal.test.ts
  Minimal
    ? Clear Scope (1ms)
    ? returns undefined before binding a client (1ms)
    ? returns the bound client (1ms)
    ? Calls function on the client (1ms)
    ? does not throw an error when pushing different clients (1ms)
    ? does not throw an error when pushing same clients
    ? custom carrier (1ms)
    ? withScope (2ms)
    ? setExtras (1ms)
    ? setTags (1ms)
    ? setExtra (1ms)
    ? setTag
    ? setUser (1ms)
    ? setContext (1ms)
    Capture
      ? Return an event_id (4ms)
      ? Exception (1ms)
      ? Exception with explicit scope (1ms)
      ? Message (1ms)
      ? Message with explicit scope (1ms)
      ? Message with custom level (2ms)
      ? Event (1ms)
    configureScope
      ? User Context (2ms)
      ? Extra Context (1ms)
      ? Tags Context (1ms)
      ? Fingerprint
      ? Level (1ms)

責任編輯：武曉燕來源：黑客下午茶

開發 JavaScript 應用