Skip to content

Commit

Permalink
Merge branch 'js/documentation' of https://github.com/MindscapeHQ/ray…
Browse files Browse the repository at this point in the history
…gun4wordpress into js/documentation
  • Loading branch information
redJ4y committed Feb 13, 2023
2 parents 7cf0cce + 03297a9 commit 925aeb9
Showing 1 changed file with 22 additions and 31 deletions.
53 changes: 22 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,68 +7,59 @@ The WordPress plugin providing an easy integration of Raygun into WordPress webs

This provider uses the lower-level [Raygun4PHP](https://github.com/MindscapeHQ/raygun4php) provider for server-side crash reporting and [Raygun4JS](https://github.com/MindscapeHQ/raygun4js) for both client-side crash reporting and real user monitoring.

**Multisite support**: This plugin supports multisite installations, but a specific installation procedure should be followed. Read the instructions below for more information.
**Multisite support**: *This plugin is not guaranteed to work on multisite installations with certain environments.* A specific installation procedure should be followed. More information can be found [here](https://wordpress.org/plugins/raygun4wp/#multisite%20support).

## Installation

Ensure that your server is running PHP 7.4 or newer.
Ensure that your server is running at least WordPress 5.3 and PHP 7.4.

*Raygun4WP version 1.9.3 is recommended for use with older PHP versions >= 5.3.3.*

### From Wordpress Plugin Directory

Add it from the official repository using your admin panel - the plugin is available from [wordpress.org/plugins/raygun4wp/](http://wordpress.org/plugins/raygun4wp/).
Add it from the official *wordpress.org* repository using your admin panel - the plugin is available from [wordpress.org/plugins/raygun4wp](http://wordpress.org/plugins/raygun4wp).

### Manually with Git

Clone this repository into your WordPress installation's `/plugins` folder - e.g. `/wordpress/wp-content/plugins`.

```
git clone https://github.com/MindscapeHQ/raygun4wordpress
git clone https://github.com/MindscapeHQ/raygun4wordpress.git
```

## Usage

1. Navigate to your WordPress admin panel, click on Plugins, and then **Activate Raygun**
2. Go to the Raygun settings panel either by the sidebar or admin notification
3. Copy your application's API key from your [Raygun dashboard](https://app.raygun.com/dashboard/) and place it in the API key field
4. Enable `Error Tracking` (both server-side and client-side), `Real User Monitoring` and any other options
5. Save your changes
6. Done!
1. Navigate to your WordPress admin panel, click on Plugins, and then **Activate Raygun**.
2. Visit the Raygun plugin **About** page.
3. Follow the steps under *Get Started Today*.

## Real User Monitoring
## Crash Reporting

As of 1.8, you can enable [real user monitoring](https://raygun.com/platform/real-user-monitoring) by navigating to the Raygun settings page and checking the **Enable Real User Monitoring** checkbox.
[Raygun Crash Reporting](https://raygun.com/platform/crash-reporting) silently monitors your software and notifies you when users encounter errors. Crash Reporting also provides deep diagnostic information about the root cause of the error or crash, meaning your team won't be losing valuable time digging through log files.

User information will be sent along if you have the Customers feature enabled.
Using this plugin, you can enable crash reporting to track errors and exceptions generated by your WordPress site.

## Client-side error tracking
## Real User Monitoring

As of 1.4, this plugin now also includes [Raygun4JS](https://raygun.com/documentation/language-guides/javascript) so you can automatically track JavaScript errors that occur in your user's browser once your site's pages are loaded.
Ensure your website delivers a flawless user experience using [Raygun Real User Monitoring](https://raygun.com/platform/real-user-monitoring). Monitor the performance of every user session so you can make improvements. Measure how geographic location affects your user experience by viewing detailed breakdowns. Increase user retention by discovering the problematic pages your users get stuck on.

To activate this, turn on the JavaScript error tracking option in the Raygun settings page.
Using this plugin, you can enable real user monitoring to track individual user sessions, asset load times and more about your WordPress site.

## Customers

If you enable this feature in your Raygun Plugin settings, the currently logged in user's email address, first name and last name will be transmitted along with each error or session. This will be visible in the Raygun dashboard.

If they have associated a Gravatar with that address, you will see their picture.
Customers are why we create software. See them all, what they do, and how they're impacted by errors, crashes, and performance issues when using your software applications. Raygun Customers gives you complete clarity on who is using your application, alongside any problems they encountered that negatively impacted their end-user experience. Understand what actions led to an issue occurring and whether the overall experience was good or bad for individual users. Customers is included in all Raygun plans and can be set up quickly by enabling it in your plugin settings.

If this feature is not enabled, a random ID will be assigned to each user. Either way, you can view a count of the affected users for each error.
When enabled, the currently logged in user's email address, first name and last name will be transmitted with each error or session. This will be visible in the Raygun dashboard. If this feature is not enabled, a random ID will be assigned to each user.

## Tagging errors
## Tagging Errors

Since 1.8 both client-side and server-side errors can be tagged. Tags are custom test allowing you to easily identify errors.
As of 1.8.0, both client-side and server-side errors can be tagged. Tags are custom text transmitted with errors that allow for easy identification. For example, a developer might want to tag JavaScript errors with *client-side* and PHP errors with *server-side*.

JavaScript and PHP errors can be tagged independently through a comma-delimited list in the field on the settings page.
## Asynchronous Sending

For example: `Error, JavaScript` would add two tags. The first being `Error` second one being `JavaScript`
As of 2.0.0, asynchronous sending is avaliable on both Unix and Windows based systems. **Enabling async sending should yeild a significant performance increase.**

## Ignored domains

You can enter a comma-delimited list in the field on the settings page to prevent certain domains from sending errors and from being tracked with real user monitoring.

## Async sending

As of 2.0.0, async sending is avaliable on both Unix and Windows servers. Enabling async sending should yeild a performance increase.
---------

Changelog
---------
Expand Down

0 comments on commit 925aeb9

Please sign in to comment.