跳到主要内容

init

2024年06月17日
柏拉文
越努力，越幸运

一、认识​

Sentry.init({})

二、配置项​

2.1 dsn​

dsn(Data Source Name): 是连接到 Sentry 服务的唯一密钥，指示错误报告应该发送到哪里。

2.2 sampleRate​

sampleRate: （浮点数，取值范围为 0 到 1）用来指定应该抽取多少比例的事务来发送给 Sentry。例如，0.1 意味着发送 10% 的事件。

2.3 tracesSampleRate​

tracesSampleRate:（浮点数，取值范围为 0 到 1）用于设置应该记录和发送多少比例的性能跟踪数据。

2.4 environment​

environment: （字符串）指定正在报告的事件的环境，如 production、staging 等，帮助在不同的部署环境中区分事件。

2.5 release​

release: （字符串）指定当前发布版本的标识符。这有助于在 Sentry 中跟踪错误发生的代码版本。

2.6 maxBreadcrumbs​

maxBreadcrumbs: （数字）设定最大的面包屑数量，面包屑代表导致错误或事件发生前的一系列事件（如用户操作、日志消息等）。超出这个限制的旧面包屑会被丢弃。

2.7 attachStacktrace​

attachStacktrace: （布尔值）是否自动将堆栈跟踪信息附加到消息上。即使消息没有异常对象，也会尝试捕获堆栈。

2.8 beforeSend​

beforeSend: （函数）在事件发送到 Sentry 之前，可以对其进行修改或剔除（返回 null 即剔除）。此函数接受两个参数，事件和提示。

2.9 beforeBreadcrumb​

beforeBreadcrumb: （函数）在面包屑被附加到事件之前被调用，可以用于修改或过滤面包屑。

2.10 ignoreErrors​

ignoreErrors: （字符串数组）指定应该被忽略不报告的错误消息列表。通常包括一些你已知并不需要上报的错误。

2.11 integrations​

integrations: （数组）允许配置 Sentry 的集成模块，例如自动报告的第三方库集成。可以用来添加、移除或修改默认集成。

2.12 serverName​

serverName: （字符串）自定义服务器名称。

2.13 tags​

tags: （对象）设置一些标签，这些标签会附加到所有通过 Sentry 客户端发送的事件中。

2.14 debug​

debug: （（布尔值）启用调试模式，在控制台记录有关 Sentry 客户端行为的详细信息，有助于调试。

2.15 transport​

transport: （函数）允许自定义如何通过网络发送事件到 Sentry。可以用于覆盖或拓展事件发送的行为。

2.16 replaysSessionSampleRate​

replaysSessionSampleRate: 是 Sentry 配置项中用于控制会话重放采样率的设置。重放功能，也就是会话重放，允许开发者回放用户遇到错误时的操作，这有助于更好地理解错误发生的上下文和原因。具体到 replaysSessionSampleRate，这个配置项决定了多少百分比的会话将被随机选中进行重放记录。值的范围从 0 到 1，其中 0 表示不记录任何会话的重放，1 表示记录所有会话的重放。例如，如果设置为 0.1，则平均每10个会话中就有1个会话会被记录下来用于重放。正确设置这个值是重要的，因为会话重放会增加网络带宽和存储的使用。如果你的应用有大量用户，记录所有用户的会话可能会引起不必要的资源消耗。通过调整 replaysSessionSampleRate，你可以平衡想要获得的重放覆盖率和可接受的资源使用。

2.17 replaysOnErrorSampleRate​

replaysOnErrorSampleRate: 是 Sentry 配置中的一个选项，它的含义是设置在发生错误时，捕获和重放用户会话的比例。这个配置项是 Sentry 用来控制进行会话重放的频率的，其值的范围从 0 到 1，其中 0 表示禁用会话重放，而 1 表示每次错误都会尝试进行会话重放。会话重放功能允许开发人员查看错误发生前后用户与应用交互的细节，这对于诊断问题和理解用户遇到的具体情况非常有帮助。例如，你可以看到用户点击了哪些按钮，填写了哪些表单，以及应用的响应等等。这些信息有助于快速定位和解决问题，改善用户体验。将 replaysOnErrorSampleRate 设置为一个低值（如 0.1）意味着大约有 10% 的错误会触发会话重放。这可以帮助平衡负载和隐私考虑，同时获得有价值的洞察。重要的是要注意，根据你的隐私政策和相关法律，可能需要获得用户同意才能进行此类重放。

2.18 tracePropagationTargets​

tracePropagationTargets: 用来定义跨服务跟踪（Cross-service tracing）中，你希望 Sentry 跟踪请求链路中涉及的特定外部服务和域名的列表。简而言之，这个配置帮助你指定那些外部服务或 API``，当发出请求到这些服务时，Sentry 将尝试捕获这些请求的跟踪信息，以便更好地理解服务间如何交互，以及潜在的问题如何跨越服务边界。使用 tracePropagationTargets，你可以包含或排除特定的服务或域名，从而细化分布式跟踪的范围和细节。这对于调试和监控在一个复杂系统中发生的交互特别有用，尤其是当涉及到微服务架构时，这个架构通常包括多个小型、独立的服务相互通讯。