Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Customers Product]: Change references from 'Users' to 'Customers' within documentation 👥 #445

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[Customers Product]: Change references from 'Users' to 'Customers' within documentation 👥 #445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions Mindscape.Raygun4Net.AspNetCore/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ The AddRaygun method has an overload that takes a RaygunMiddlewareSettings objec
These settings control the middleware (not to be confused with RaygunSettings which are the common settings we use across all of our .NET providers).
Currently there's just one property on it, ClientProvider. This gives you a hook into the loading of RaygunSettings and the construction of the RaygunAspNetCoreClient used to send errors.

For example, say you want to set user details on your error reports. You'd create a custom client provider like this:
For example, say you want to set customer details on your error reports. You'd create a custom client provider like this:

```csharp
public class ExampleRaygunAspNetCoreClientProvider : DefaultRaygunAspNetCoreClientProvider
Expand Down Expand Up @@ -254,12 +254,12 @@ In this case, if a TargetInvocationException occurs, it will be removed and repl
Note that TargetInvocationException is already added to the wrapper exception list; you do not have to add this manually.
This method is useful if you have your own custom wrapper exceptions, or a framework is throwing exceptions using its own wrapper.

Unique (affected) user tracking
Customers
-------------------------------

There are properties named *User* and *UserInfo* on RaygunClient which you can set to provide user info such as ID and email address
This allows you to see the count of affected users for each error in the Raygun dashboard.
If you provide an email address, and the user has an associated Gravatar, you will see their avatar in the error instance page.
There are properties named *User* and *UserInfo* on RaygunClient which you can set to provide customer info such as ID and email address
This allows you to see the count of affected customers for each error in the Raygun dashboard.
If you provide an email address, and the customer has an associated Gravatar, you will see their avatar in the error instance page.

Make sure to abide by any privacy policies that your company follows when using this feature.

Expand Down
8 changes: 4 additions & 4 deletions Mindscape.Raygun4Net.Azure.WebJob/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,12 @@ In this case, if a TargetInvocationException occurs, it will be removed and repl
Note that HttpUnhandledException and TargetInvocationException are already added to the wrapper exception list; you do not have to add these manually.
This method is useful if you have your own custom wrapper exceptions, or a framework is throwing exceptions using its own wrapper.

Unique (affected) user tracking
Customers
-------------------------------

There is a property named *User* on RaygunClient which you can set to be the current user's ID or email address.
This allows you to see the count of affected users for each error in the Raygun dashboard.
If you provide an email address, and the user has an associated Gravatar, you will see their avatar in the error instance page.
There is a property named *User* on RaygunClient which you can set to be the current customers's ID or email address.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: customers's

This allows you to see the count of affected customers for each error in the Raygun dashboard.
If you provide an email address, and the customer has an associated Gravatar, you will see their avatar in the error instance page.

Make sure to abide by any privacy policies that your company follows when using this feature.

Expand Down
8 changes: 4 additions & 4 deletions Mindscape.Raygun4Net.Mvc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,12 +126,12 @@ In this case, if a TargetInvocationException occurs, it will be removed and repl
Note that HttpUnhandledException and TargetInvocationException are already added to the wrapper exception list; you do not have to add these manually.
This method is useful if you have your own custom wrapper exceptions, or a framework is throwing exceptions using its own wrapper.

Unique (affected) user tracking
Customers
-------------------------------

There is a property named *User* on RaygunClient which you can set to be the current user's ID or email address.
This allows you to see the count of affected users for each error in the Raygun dashboard.
If you provide an email address, and the user has an associated Gravatar, you will see their avatar in the error instance page.
There is a property named *User* on RaygunClient which you can set to be the current customer's ID or email address.
This allows you to see the count of affected customers for each error in the Raygun dashboard.
If you provide an email address, and the customer has an associated Gravatar, you will see their avatar in the error instance page.

Make sure to abide by any privacy policies that your company follows when using this feature.

Expand Down
8 changes: 4 additions & 4 deletions Mindscape.Raygun4Net.NetCore/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,12 @@ In this case, if a TargetInvocationException occurs, it will be removed and repl
Note that TargetInvocationException is already added to the wrapper exception list; you do not have to add this manually.
This method is useful if you have your own custom wrapper exceptions, or a framework is throwing exceptions using its own wrapper.

Unique (affected) user tracking
Customers
-------------------------------

There are properties named *User* and *UserInfo* on RaygunClient which you can set to provide user info such as ID and email address
This allows you to see the count of affected users for each error in the Raygun dashboard.
If you provide an email address, and the user has an associated Gravatar, you will see their avatar in the error instance page.
There are properties named *User* and *UserInfo* on RaygunClient which you can set to provide customer info such as ID and email address
This allows you to see the count of affected customers for each error in the Raygun dashboard.
If you provide an email address, and the customer has an associated Gravatar, you will see their avatar in the error instance page.

Make sure to abide by any privacy policies that your company follows when using this feature.

Expand Down
8 changes: 4 additions & 4 deletions Mindscape.Raygun4Net.WebApi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,12 +128,12 @@ In this case, if a TargetInvocationException occurs, it will be removed and repl
Note that TargetInvocationException is already added to the wrapper exception list; you do not have to add this manually.
This method is useful if you have your own custom wrapper exceptions, or a framework is throwing exceptions using its own wrapper.

Unique (affected) user tracking
Customers
-------------------------------

There are properties named *User* and *UserInfo* on RaygunWebApiClient which you can set to provide user info such as ID and email address
This allows you to see the count of affected users for each error in the Raygun dashboard.
If you provide an email address, and the user has an associated Gravatar, you will see their avatar in the error instance page.
There are properties named *User* and *UserInfo* on RaygunWebApiClient which you can set to provide customer info such as ID and email address
This allows you to see the count of affected customers for each error in the Raygun dashboard.
If you provide an email address, and the customer has an associated Gravatar, you will see their avatar in the error instance page.

Make sure to abide by any privacy policies that your company follows when using this feature.

Expand Down
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ At any point after calling the Attach method, you can use RaygunClient.Current t
### Xamarin for Android

In the main/entry Activity of your application, use the static RaygunClient.Attach method using your app API key.
There is also an overload for the Attach method that lets you pass in a user-identity string which is useful for tracking affected users in your Raygun dashboard.
There is also an overload for the Attach method that lets you pass in a user-identity string which is useful for tracking affected customers in your Raygun dashboard.

```csharp
RaygunClient.Attach("YOUR_APP_API_KEY");
Expand Down Expand Up @@ -383,34 +383,34 @@ In this case, if a TargetInvocationException occurs, it will be removed and repl
Note that HttpUnhandledException and TargetInvocationException are already added to the wrapper exception list; you do not have to add these manually.
This method is useful if you have your own custom wrapper exceptions, or a framework is throwing exceptions using its own wrapper.

## Affected user tracking
## Customers

There is a property named ```User``` on RaygunClient which you can set to be the current user's ID. This allows you to see the count of affected users for each error in the Raygun dashboard.
There is a property named ```User``` on RaygunClient which you can set to be the current cusrtomer's ID. This allows you to see the count of affected customers for each error in the Raygun dashboard.

If you want more detailed information about users (and the ability to use the new Affected User reporting feature when it is released), you can set the ```UserInfo``` property on the RaygunClient to a new RaygunIdentifierMessage object. [This class](https://github.com/MindscapeHQ/raygun4net/blob/master/Mindscape.Raygun4Net/Messages/RaygunIdentifierMessage.cs) has a number of properties on it to help identifier the user who experienced a crash.
If you want more detailed information about customers (and the ability to use the new Customers feature when it is released), you can set the ```UserInfo``` property on the RaygunClient to a new RaygunIdentifierMessage object. [This class](https://github.com/MindscapeHQ/raygun4net/blob/master/Mindscape.Raygun4Net/Messages/RaygunIdentifierMessage.cs) has a number of properties on it to help identifier the customer who experienced a crash.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need to mention "(and the ability to use the new Customers feature when it is released)" anymore


Make sure to abide by any privacy policies that your company follows when using this feature.

### Properties
The only required field is Identifier.

```Identifier``` is the unique identifier from your system for this user.
```Identifier``` is the unique identifier from your system for this customer.

```IsAnonymous``` is a flag indicating whether the user is logged in (or identifiable) or if they are anonymous. An anonymous user can still have a unique identifier.
```IsAnonymous``` is a flag indicating whether the customer is logged in (or identifiable) or if they are anonymous. An anonymous user can still have a unique identifier.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it intentional the "user" is still mentioned on this line?


```Email``` The user's email address. If you use email addresses to identify your users, feel free to set the identifier to their email and leave this blank, as we will use the identifier as the email address if it looks like one, and no email address is not specified.
```Email``` The customer's email address. If you use email addresses to identify your customer, feel free to set the identifier to their email and leave this blank, as we will use the identifier as the email address if it looks like one, and no email address is not specified.

```FullName``` The user's full name.
```FullName``` The customer's full name.

```FirstName``` The user's first (or preferred) name.
```FirstName``` The customer's first (or preferred) name.

```UUID``` A device identifier. Could be used to identify users across devices, or machines that are breaking for many users.
```UUID``` A device identifier. Could be used to identify customers across devices, or machines that are breaking for many customers.

### Usage
```csharp
raygunClient.User = "user@email.com";
raygunClient.User = "customer@email.com";
// OR
raygunClient.UserInfo = new RaygunIdentifierMessage("user@email.com")
raygunClient.UserInfo = new RaygunIdentifierMessage("customer@email.com")
{
IsAnonymous = false,
FullName = "Robbie Raygun",
Expand Down
10 changes: 5 additions & 5 deletions readme.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ At any point after calling the Attach method, you can use RaygunClient.Current t
Xamarin for Android
====================
In the main/entry Activity of your application, use the static RaygunClient.Attach method using your app API key.
There is also an overload for the Attach method that lets you pass in a user-identity string which is useful for tracking affected users in your Raygun dashboard.
There is also an overload for the Attach method that lets you pass in a user-identity string which is useful for tracking affected customers in your Raygun dashboard.

RaygunClient.Attach("YOUR_APP_API_KEY");

Expand Down Expand Up @@ -324,12 +324,12 @@ In this case, if a TargetInvocationException occurs, it will be removed and repl
Note that HttpUnhandledException and TargetInvocationException are already added to the wrapper exception list; you do not have to add these manually.
This method is useful if you have your own custom wrapper exceptions, or a framework is throwing exceptions using its own wrapper.

Unique (affected) user tracking
Customers
-------------------------------

There is a property named *User* on RaygunClient which you can set to be the current user's ID or email address.
This allows you to see the count of affected users for each error in the Raygun dashboard.
If you provide an email address, and the user has an associated Gravatar, you will see their avatar in the error instance page.
There is a property named *User* on RaygunClient which you can set to be the current customer's ID or email address.
This allows you to see the count of affected customers for each error in the Raygun dashboard.
If you provide an email address, and the customer has an associated Gravatar, you will see their avatar in the error instance page.

Make sure to abide by any privacy policies that your company follows when using this feature.

Expand Down