SharpRaven 项目技术文档

1. 安装指南

NuGet 包安装

推荐使用 NuGet 包管理器来安装 SharpRaven。您可以在 Visual Studio 中使用 NuGet 包管理器，或者使用以下命令：

Install-Package SharpRaven

如果您正在使用 Nancy 框架，您也可以安装 SharpRaven.Nancy 包：

Install-Package SharpRaven.Nancy

手动安装

1. 下载 SharpRaven 的源代码或预编译的二进制文件。
2. 将相关 DLL 文件添加到您的项目引用中。

2. 项目使用说明

SharpRaven 是一个用于 .NET 的 Sentry 客户端，可以捕获异常并将它们发送到 Sentry。

初始化客户端

使用您的 '数据源名称' (DSN) 实例化客户端：

var ravenClient = new RavenClient("https://[e-mail]/project-id");

捕获异常

在您的 catch 块中调用客户端：

try
{
    int i2 = 0;
    int i = 10 / i2;
}
catch (Exception exception)
{
    ravenClient.Capture(new SentryEvent(exception));
}

记录非异常信息

您也可以在不捕获异常的情况下记录消息：

ravenClient.Capture(new SentryEvent("Hello World!"));

添加额外数据

您可以在抛出异常的解决方案中添加额外数据到 Exception.Data 属性：

try
{
    // ...
}
catch (Exception exception)
{
    exception.Data.Add("SomeKey", "SomeValue");
    throw;
}

异步支持

在 .NET 4.5 或更高版本的 SharpRaven 中，有一个 async 版本的 Capture 方法：

async Task<string> CaptureAsync(SentryEvent @event);

Nancy 支持

您可以通过安装 SharpRaven.Nancy 包来在 Nancy 应用程序中捕获 HTTP 上下文。它会自动注册到 IPipelines.OnError 事件，以便将所有未处理的异常发送到 Sentry。

您可以通过在容器中注册 Dsn 类的实例来提供 DSN：

protected override void ApplicationStartup(TinyIoCContainer container, IPipelines pipelines)
{
    container.Register(new Dsn("https://[e-mail]/project-id"));
}

或者通过配置：

<configuration>
  <configSections>
    <section name="sharpRaven" type="SharpRaven.Nancy.NancyConfiguration, SharpRaven.Nancy" />
  </configSections>
  <sharpRaven>
    <dsn value="https://[e-mail]/project-id" />
  </sharpRaven>
</configuration>

3. 项目API使用文档

以下是 SharpRaven 的一些关键 API：

• RavenClient: Sentry 客户端的主要类。
• SentryEvent: 用于表示要发送到 Sentry 的异常事件的类。
• Exception.Data: 用于添加额外数据的异常属性。

RavenClient 类

• RavenClient(string dsn): 使用指定的 DSN 初始化客户端。
• Capture(SentryEvent @event): 捕获并发送一个异常事件到 Sentry。
• CaptureAsync(SentryEvent @event): 异步捕获并发送一个异常事件到 Sentry。

SentryEvent 类

• SentryEvent(Exception exception): 使用指定的异常初始化事件。
• SentryEvent(string message): 使用指定的消息初始化事件。
• ErrorLevel: 设置错误级别。
• Fingerprint: 设置指纹。
• Message: 设置自定义消息。
• Tags: 设置标签。

4. 项目安装方式

请参考上述的安装指南，您可以通过 NuGet 包管理器或手动方式安装 SharpRaven。