Skip to content

Commit

Permalink
Update readme.txt, add assets, change name to Raygun
Browse files Browse the repository at this point in the history
  • Loading branch information
redJ4y committed Feb 13, 2023
1 parent 47e309f commit 9a0abc9
Show file tree
Hide file tree
Showing 10 changed files with 58 additions and 68 deletions.
2 changes: 1 addition & 1 deletion about.php
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
<ol>
<li><a href="https://app.raygun.com/signup?utm_source=link&amp;utm_medium=text&amp;utm_campaign=wp-plugin-setup" target="_blank">Create a Raygun account</a>.</li>
<li>Go to the <a href="https://app.raygun.com" target="_blank">Raygun dashboard</a> and create a new application. <span class="rg4wp-helptip">This represents your website.</span></li>
<li>Go to the <a href="<?php menu_page_url('rg4wp-settings', true); ?>">Raygun4WP settings page.</a></li>
<li>Go to the <a href="<?php menu_page_url('rg4wp-settings', true); ?>">Raygun settings page.</a></li>
<li>Paste your API key into the API key field.</li>
<li>Enable Crash Reporting and Real User Monitoring.</li>
<li>Click Save Changes.</li>
Expand Down
Binary file added assets/banner-1544x500.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/banner-772x250.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/icon-128x128.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/icon-256x256.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions main.php
Original file line number Diff line number Diff line change
Expand Up @@ -215,8 +215,8 @@ function rg4wp_dash() {

function rg4wp_admin() {
$logourl = plugins_url('img/logo.png', __FILE__);
add_menu_page('Raygun4WP', 'Raygun4WP', 'administrator', 'rg4wp', 'rg4wp_about', $logourl);
add_submenu_page('rg4wp', 'About Raygun4WP', 'About', 'administrator', 'rg4wp', 'rg4wp_about');
add_menu_page('Raygun', 'Raygun', 'administrator', 'rg4wp', 'rg4wp_about', $logourl);
add_submenu_page('rg4wp', 'About Raygun', 'About', 'administrator', 'rg4wp', 'rg4wp_about');
add_submenu_page('rg4wp', 'Settings', 'Settings', 'administrator', 'rg4wp-settings', 'rg4wp_settings');
add_submenu_page('rg4wp', 'Dashboard', 'Dashboard', 'administrator', 'rg4wp-dash', 'rg4wp_dash');
}
Expand Down
6 changes: 4 additions & 2 deletions raygun4wp.php
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
<?php
/*
Plugin Name: Raygun4WP
Plugin Name: Raygun
Plugin URI: http://github.com/mindscapehq/raygun4wordpress
Description: Exceptional error, performance, user tracking and more with Raygun.com. This service integrates Raygun Crash Reporting which lets you monitor your site's health with beautiful graphs and comprehensive reports, so you are always aware of any points of failure. With Raygun's Real User Monitoring you can monitor the performance of every individual user session, so you can discover and fix fundamental bottlenecks that affect your end user experience. This plugin has a simple one-minute, no-code-required installation.
Version: 2.0.0.0
Author: Mindscape
Requires at least: 5.3
Requires PHP: 7.4
Author: Raygun
Author URI: http://raygun.com
License: MIT
*/
Expand Down
108 changes: 48 additions & 60 deletions readme.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
=== Raygun4WP ===
=== Raygun ===
Contributors: mindscapehq
Donate link: http://raygun.com
Tags: error reporting, raygun, exception, 404, crash reporting, JavaScript, PHP, error monitoring, error tracking, bug tracking, real user monitoring
Requires at least: 3.4
Tested up to: 4.9.4
Stable tag: 1.9.3.0
Tags: crash reporting, error monitoring, user experience monitoring, core web vitals, raygun, error reporting, error tracking, bug tracking, real user monitoring, exception, JavaScript, PHP
Requires at least: 5.3
Tested up to: 6.1.1
Stable tag: 2.0.0.0
Requires PHP: 7.4
License: MIT
License URI: http://opensource.org/licenses/MIT

Expand All @@ -16,13 +16,13 @@ Raygun keeps a watchful eye on your website and notifies you of problems as they

**Crash Reporting**

[Raygun Crash Reporting](https://raygun.com/products/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.
[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.

Using this plugin you can enable crash reporting to track errors and exceptions generated by your WordPress site.

**Real User Monitoring**

Ensure your website delivers a flawless user experience using [Raygun Real User Monitoring](https://raygun.com/products/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.
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.

Using this plugin you can enable real user monitoring to track individual user sessions, asset load times and more about your WordPress site.

Expand All @@ -34,86 +34,91 @@ Customers are why we create software. See them all, what they do, and how they'r

== Installation ==

1. Download and enable the Raygun4WP Plugin
2. Activate it
3. Paste in your Raygun API Key _(Found in Application Settings)_
1. Download and activate the Raygun Plugin
2. Visit the Raygun Plugin settings page. Here you can configure and enable Raygun features. Remember to paste in your Raygun API Key _(found in your Application Settings)_

Done!
**Done!**

== Frequently Asked Questions ==

= How do I enable Real User Monitoring =

As of 1.8, you can enable [real user monitoring](https://raygun.com/products/real-user-monitoring) by navigating to the Raygun4WP settings page and checking the **Enable Real User Monitoring** checkbox.
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.

User information will be sent along if you have the Customers feature enabled.

= Client-side JavaScript error tracking =

As of 1.4, this plugin now also includes [Raygun4JS](https://raygun.com/docs/languages/javascript) so you can automatically track JavaScript errors that occur in your user's browser once your site's pages are loaded.
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.

To activate this, turn on the JavaScript error tracking option in the Raygun4WP settings page.
To activate this, turn on the JavaScript error tracking option in the Raygun settings page.

= What does my WordPress site require to use this plugin? =

This plugin automates the installation of [Raygun4PHP](https://raygun.com/docs/languages/php), the PHP 5 provider for Raygun. As a result it requires the dependencies that Raygun4PHP needs.
This plugin automates the installation of [Raygun4PHP](https://raygun.com/documentation/language-guides/php), the PHP provider for Raygun.

Specifically, the server that your WordPress site runs on requires a **PHP 5.3** environment with the **curl** library and dependencies. Please ask your administrator if this is not enabled. You can see your PHP information with `phpinfo()``.

When activating the plugin, if you receive a PHP error message stating that there is an 'Unexpected T_STRING', you may be running a PHP 5.2 or below installation. Raygun4WP currently only supports PHP 5.3, a version compatible with 5.2 may be available - please [contact us](https://raygun.com/about/contact) if you require this.
The server that your WordPress site runs on requires a **PHP 7.4** or newer environment.

= Multisite Support =

It is recommended to use the most recent version WordPress and PHP possible. This procedure should be first followed on a staging server that matches your production environment as closely as possible, then replicated live.
It is recommended to use the most recent version WordPress and PHP possible. This procedure should first be followed on a staging server that matches your production environment as closely as possible **before** being replicated live.

1. On your root network site, install the plugin using the Admin dashboard's Plugin page as standard, but do not activate it.

2. FTP in and modify wp-content/plugins/raygun4wp/raygun4wp.php - change the value on line 12 to true.
2. FTP in and modify wp-content/plugins/raygun4wp/raygun4wp.php - change the value on line 14 to true.

3. Visit the Admin dashboard of a child site (not the root network site). Go to its Plugin page, and you should see Raygun4WP ready to be activated - do so.
3. Visit the Admin dashboard of a child site (not the root network site). Go to its Plugin page, and you should see Raygun ready to be activated - do so.

4. A new Raygun4WP submenu will be added to the left sidebar. In there click on Configuration, paste in your API key, change the top dropdown to Enabled then click Save Changes. You can now click Send Test Error and one will appear in your Raygun dashboard.
4. A new Raygun submenu will be added to the left sidebar. In there, click on Configuration, paste in your API key, change the top dropdown to Enabled then click Save Changes. You can now click Send Test Error and one will appear in your Raygun dashboard.

5. Repeat the above process for any other child sites - you can use different API keys (to send to different Raygun applications) or the same one.

Finally, if you so desire you should be able to visit the root network site, activate it there and configure it. You must however activate it on at least one child site first.
Finally, if you so desire, you should be able to visit the root network site, activate it there and configure it. You must, however, activate it on at least one child site first.

= How do I use Customers? =

If you enable this feature in your Raygun4WP 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. 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.
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. 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.

== Changelog ==

= 1.9.3 =
= 2.0.0.0 =
* Switch to Composer for dependency management
* Bump Raygun4PHP dependency to v2.3.0
* Use new async sending guzzle (adds support for async on Windows)
* Switch Raygun4JS dependency to grab latest CDN distribution
* Add error type tagging
* Log errors that fail to send to Raygun
* Add setting to disable tracking on admin pages
* Rename Mindscape namespace to Raygun (src)
* Improve RaygunClientManager such that setting changes take effect immediately
* Correct relationship between error handler and shutdown handler
* Miscellaneous bug fixes, code improvements, UI and documentation updates

= 1.9.3.0 =
* Updated User Tracking to Customers

= 1.9.2 =
= 1.9.2.0 =
* Update Pulse to Real User Monitoring (RUM)

= 1.9.1 =
= 1.9.1.0 =
* Don't set user cookie when user tracking is disabled

= 1.9.0 =

= 1.9.0.0 =
* Add async sending option to dashboard
* Bump Raygun4PHP dependency to v1.8.2
* Bump Raygun4JS dependency to v2.8.5

= 1.8.3 =

= 1.8.3.0 =
* Fix XSS vulnerability in settings
* Replace the iframe with a link to the Raygun dashboard

= 1.8.2 =

= 1.8.2.0 =
* Bump Raygun4JS version to v2.6.2

= 1.8.1 =

= 1.8.1.0 =
* XSS bug fix

= 1.8.0 =

= 1.8.0.0 =
* Bump Raygun4JS dependency to v2.4.0
* Bump Raygun4PHP dependency to v1.7.0
* Pulse support added
Expand All @@ -127,78 +132,61 @@ If you enable this feature in your Raygun4WP Plugin settings, the currently logg
* Raygun4JS tracks the version Wordpress being used
* Unique user tracking also tracks the users first & last names

= 1.7.3 =

= 1.7.3.0 =
* Fixed issue with WP 4.5.2 plugin api

= 1.7.2 =

= 1.7.2.0 =
* Fixed redundant cURL check when running in socket mode

= 1.7.1 =

= 1.7.1.0 =
* Fix issue with tags not being provided for caught exceptions

= 1.7.0 =

= 1.7.0.0 =
* Bump Raygun4JS dependency to v1.18.4

= 1.6.0.0 =

* Bump Raygun4php dependency to v1.6.1

= 1.4.1.0 =

* Admin warning notice fix

= 1.4.0.0 =

* Added auto client-side JavaScript error tracking

= 1.3.0.0 =

* Ignored Domains setting added
* Bump RG4PHP to v1.3.5

= 1.2.1.0 =

* Updated admin message

= 1.2.0.0 =

* Now requires PHP 5.3.3 or newer
* Default to using socket sending method; bump Raygun4PHP to 1.3.3

= 1.1.4.0 =

* Bump underlying Raygun4PHP to latest version with minor bugfixes and improvements

= 1.1.3.0 =

* Update Raygun4PHP to use async cURL sending. This should be very fast on linux environments

= 1.1.1.0 =

* WordPress version tracking enabled
* Updated Raygun4PHP. There were two bugs in 1.1 with nested request data and user tracking, updating is recommended.

= 1.1.0.0 =

* Added Unique User tracking support to Settings page
* Updated internal Raygun4PHP to use latest v1.1

= 1.0.3.0 =

* Added button to test setup on config page
* Added status indicator, improved handling when API key missing or invalid
* Fixed a major bug where the provider would attempt to send errors, even if the status was 'disabled', cURL was missing, or an invalid API key was provided. Because of these changes, we strongly recommend you upgrade from any earlier releases to 1.0.3.0 or greater.

= 1.0.1.0 =

* Added 404 error handling
* Enabled tag support
* Misc UX improvements

= 1.0 =

= 1.0.0.0 =
* Initial release.
4 changes: 2 additions & 2 deletions sendtesterror.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<!DOCTYPE html>
<html>
<head>
<title>Raygun4WP test error</title>
<title>Raygun4WP Test Error</title>
<link rel="stylesheet" type="text/css" href="./css/style.css"/>
<style>
body {
Expand Down Expand Up @@ -38,7 +38,7 @@
$client->SetUser($_GET['user']);
}

$result = trim($client->SendError(404, 'Congratulations, Raygun4WP is working correctly!', '0', '0'));
$result = trim($client->SendError(404, 'Congratulations, Raygun is working correctly!', '0', '0'));

if ($result == 'HTTP/1.1 403 Forbidden') {
echo 'The Raygun service did not accept your API key. Please ensure that you have a entered a valid API key for an application and then save your changes.';
Expand Down
2 changes: 1 addition & 1 deletion settings.php
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<input type="checkbox" name="rg4wp_usertracking"
id="rg4wp_usertracking"<?php echo get_option('rg4wp_usertracking') ? ' checked="checked"' : ''; ?>
value="1"/>
<?php _e("Track user information"); ?>
<?php _e("Track customer information"); ?>
</label>
</fieldset>
</td>
Expand Down

0 comments on commit 9a0abc9

Please sign in to comment.