Skip to content

Commit 50ac038

Browse files
committed
Updated readme
1 parent 12cf5c7 commit 50ac038

File tree

1 file changed

+57
-13
lines changed

1 file changed

+57
-13
lines changed

README.md

Lines changed: 57 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,77 @@
11
Integration library for ASP.NET applications
2-
==========================
2+
============================================
33

4-
This library will detect all unhandled exceptions in ASP.NET-based applications and report them to your OneTrueError server (or your account at https://onetrueerror.com).
4+
[![VSTS](https://1tcompany.visualstudio.com/_apis/public/build/definitions/75570083-b1ef-4e78-88e2-5db4982f756c/14/badge)]() [![NuGet](https://img.shields.io/nuget/dt/codeRR.Client.AspNet.svg?style=flat-square)]()
55

6-
If you want to get automated handling for one of the ASP.NET derivatives, use the following libraries:
6+
This library will detect all unhandled exceptions in ASP.NET-based applications and report them to your codeRR server (or your account at https://coderrapp.com).
77

8-
* [ASP.NET MVC5](https://github.com/onetrueerror/onetrueerror.client.aspnet.mvc5)
9-
* [ASP.NET WebApi2](https://github.com/onetrueerror/onetrueerror.client.aspnet.webapi2)
8+
If you want to get automated exception handling for one of the ASP.NET-based libraries, use the following packages:
109

10+
* [ASP.NET MVC5](https://github.com/coderrapp/coderr.client.aspnet.mvc5)
11+
* [ASP.NET WebApi2](https://github.com/coderrapp/coderr.client.aspnet.webapi2)
12+
* [ASP.NET Core MVC](https://www.nuget.org/packages/codeRR.Client.AspNetCore.Mvc/)
13+
14+
# Installation
15+
16+
1. Download and install the [codeRR server](https://github.com/coderrapp/coderr.server) or create an account at [coderrapp.com](https://coderrapp.com)
17+
2. Install this client library (using nuget `coderr.client.aspnet`)
18+
3. Configure the credentials from your codeRR account in your `global.asax`.
19+
20+
```csharp
21+
public class Global : System.Web.HttpApplication
22+
{
23+
24+
protected void Application_Start(object sender, EventArgs e)
25+
{
26+
//replace with your server URL and your appkey/SharedSecret.
27+
var uri = new Uri("https://report.coderrapp.com/");
28+
Err.Configuration.Credentials(uri,
29+
"yourAppKey",
30+
"yourSharedSecret");
31+
32+
33+
Err.Configuration.CatchAspNetExceptions();
34+
}
35+
}
36+
```
37+
38+
# Manually reporting exceptions
39+
40+
All unhandled exceptions are reported automatically by this library.
41+
But sometimes you need to deal with exceptions yourself.
42+
43+
```csharp
44+
public void UpdatePost(int uid, ForumPost post)
45+
{
46+
try
47+
{
48+
_service.Update(uid, post);
49+
}
50+
catch (Exception ex)
51+
{
52+
Err.Report(ex, new{ UserId = uid, ForumPost = post });
53+
}
54+
}
55+
```
1156

12-
To report exceptions manually in your controller, use `OneTrue.Report(exception)`, OneTrueError will include information about the HttpRequest, QueryString, Form, Session etc when your exception is reported.
1357

1458
# Context collections
1559

1660
This library includes the following context collections for every reported exceptions:
1761

18-
* All in the [core library](https://github.com/onetrueerror/onetrueerror.client)
62+
* All in the [core library](https://github.com/coderrapp/coderr.client)
1963
* Application collection
2064
* Form data
2165
* Http headers
2266
* Query string parameters
2367
* Session data
2468
* Uploaded files
2569

26-
# Getting started
70+
# Requirements
71+
72+
You need to either install [codeRR Community Server](https://github.com/coderrapp/coderr.server) or use [codeRR Live](https://coderrapp.com/live).
2773

28-
1. Download and install the [OneTrueError server](https://github.com/onetrueerror/onetrueerror.server) or create an account at [OneTrueError.com](https://onetrueerror.com)
29-
2. Install this client library (using nuget `onetrueerror.client.aspnet`)
30-
3. Configure the credentials from your OneTrueError account in your `Global.asax`
31-
4. Add `OneTrue.Configuration.CatchAspNetExceptions()` in your `Global.asax`
74+
# More information
3275

33-
Done.
76+
* [Questions/Help](http://discuss.coderrapp.com)
77+
* [Documentation](https://coderrapp.com/documentation/client/libraries/aspnet/)

0 commit comments

Comments
 (0)