DockRay requires an account and a project at https:\/\/dockray.io (a free plan\nand paid service plans are available). The plugin itself is free.<\/p>\n\n
DockRay sends PHP errors and uncaught exceptions from your WordPress site to a\nDockRay project, together with the stack trace, the environment and \u2014 when you\nallow it \u2014 the logged-in user. It can also measure how long requests take.<\/p>\n\n
Features:<\/p>\n\n
wp-config.php<\/code> constants, per field or\nentirely, for teams that prefer to keep the private key out of the database<\/li>\n- English interface with Polish, German and Spanish translations included,\nand ready for more through translate.wordpress.org<\/li>\n<\/ul>\n\n
Fill in the token and the private key on Settings \u2192 DockRay<\/strong> and you are\ndone. If you would rather keep the private key out of the database \u2014 a\ndatabase dump travels between environments more often than a config file\ndoes \u2014 define it as a wp-config.php<\/code> constant instead; the settings screen\nshows exactly which fields are currently coming from a constant, and a\nConfiguration source<\/strong> switch lets you pin the plugin to constants only,\nto the database only, or let a defined constant win per field (the default,\nand how the plugin behaved before this screen existed).<\/p>\n\nConfiguration<\/h3>\n\n
Every setting below has a field on Settings \u2192 DockRay<\/strong> unless stated\notherwise. Each one can also be set as a wp-config.php<\/code> constant \u2014 add it\nabove the \/* That's all *\/<\/code> line \u2014 and the Configuration source<\/strong> switch\non the screen decides whether a constant is allowed to win, is required, or\nis ignored in favour of the database.<\/p>\n\nError types<\/strong> \u2014 which PHP errors become events. Defaults to everything except\ndeprecations and notices. This one is constant-only; there is no equivalent\nfield on the settings screen, since it is a bitmask rather than a value worth\ntyping into a text box.<\/p>\n\ndefine( 'DOCK_RAY_ERROR_TYPES', E_ALL & ~E_DEPRECATED & ~E_NOTICE );\n<\/code><\/pre>\n\nPersonal data<\/strong> \u2014 attaches the user id, e-mail, IP address and user agent.\nOff by default.<\/p>\n\ndefine( 'DOCK_RAY_SEND_DEFAULT_PII', true );\n<\/code><\/pre>\n\nRelease<\/strong> \u2014 the version of the site. Without it the active theme version is\nused.<\/p>\n\ndefine( 'DOCK_RAY_VERSION', 'v1.4.0' );\n<\/code><\/pre>\n\nEnvironment<\/strong> \u2014 defaults to WP_ENVIRONMENT_TYPE<\/code>.<\/p>\n\ndefine( 'DOCK_RAY_ENV', 'production' );\n<\/code><\/pre>\n\nRequest timing<\/strong> \u2014 the share of requests that are measured, from 0 to 1.\nZero, the default, disables it.<\/p>\n\ndefine( 'DOCK_RAY_TRACES_SAMPLE_RATE', 0.2 );<h3>Filters<\/h3>\ndock_ray_token, `dock_ray_private_key` \u2014 override the\n<\/code><\/pre>\n\ncredentials, for instance to read them from a secrets manager.<\/p>\n\n
dock_ray_user_context \u2014 change the user data attached to events.\n\nadd_filter( 'dock_ray_user_context', fn( array $user ) => array_merge( $user, [ 'plan' => 'pro' ] ) );\n\ndock_ray_scope \u2014 set tags and extra context before events are sent.\n\nadd_filter( 'dock_ray_scope', function ( $scope ) { $scope->setTag( 'tier', 'gold' ); return $scope; } );\n\ndock_ray_options \u2014 adjust SDK options after the client is built.\n\ndock_ray_client_builder \u2014 an action that receives the client builder before\n<\/code><\/pre>\n\nthe client is created.<\/p>\n\n
Reporting your own exceptions<\/h3>\n\nif ( function_exists( 'dock_ray_safe' ) ) {\n dock_ray_safe( fn( $hub ) => $hub->captureException( $exception ) );\n}\n<\/code><\/pre>\n\nThe callback runs only when the plugin is configured, so the calling code does\nnot have to check.<\/p>\n\n
External services<\/h3>\n\n
This plugin sends data to DockRay (https:\/\/dockray.io), the monitoring service\nit is a client for. Nothing is sent until you enter a project token and a\nprivate key on Settings \u2192 DockRay<\/strong> or configure those credentials through\n wp-config.php constants or plugin filters. Without credentials the plugin\nloads and stays silent.<\/p>\n\nWhat is sent, and when:<\/p>\n\n
\n- PHP errors and uncaught exceptions<\/strong>, as they happen \u2014 the message, the\nerror type, the stack trace with the surrounding source lines, the file and\nline, the site URL, the environment and release, the WordPress version and\nthe site language.<\/li>\n
- Request timings<\/strong>, when the transaction sample rate is above zero \u2014 the\nrequest path, the HTTP method and the response status. Off by default.<\/li>\n
- JavaScript errors<\/strong>, when that switch is on \u2014 the message, the script URL\nand the stack trace, forwarded by this site rather than sent from the\nbrowser. Off by default.<\/li>\n
- The logged-in user and the visitor IP address<\/strong>, only when Send user identity, IP\naddress and user agent<\/em> is on. Off by default.<\/li>\n
- A test event<\/strong>, when you click Send a test event<\/em> on the settings screen.<\/li>\n<\/ul>\n\n
Request bodies, cookies, request headers, URL query strings and fragments,\nand stack frame argument values are removed before delivery. Error messages,\nsource code context, file paths and custom context may still contain personal\nor sensitive information supplied by your application. Review what your\napplication logs and inform your visitors before enabling monitoring.<\/p>\n\n
Browser reports also include the page and referrer URLs without query strings\nor fragments. Normal reports are queued until shutdown; the manual test waits\nfor an acknowledgement. The service receives the IP of the sending server.<\/p>\n\n
Service terms: https:\/\/dockray.io\/pl\/regulamin\nPrivacy policy: https:\/\/dockray.io\/privacy-policy<\/p>\n\n\n
Requires PHP 8.2 or newer with the mbstring extension enabled.<\/p>\n\n
\n- Upload the plugin to
\/wp-content\/plugins\/dockray<\/code>, or install it from the\nplugins screen.<\/li>\n- Activate it through the Plugins<\/strong> menu \u2014 its row gets a Settings<\/strong>\nlink straight to the next step, so there is nothing to hunt for.<\/li>\n
- Open Settings \u2192 DockRay<\/strong>, paste in your project token and private key,\nand save.<\/li>\n
- Click Send a test event<\/strong> to confirm it reached the panel.<\/li>\n<\/ol>\n\n
Both values come from the project screen in the DockRay panel. The project\ntoken identifies the project, while the private key is a secret and should\nnever be exposed publicly.<\/p>\n\n
Prefer wp-config.php<\/code> instead? Add the constants below and the settings\nscreen will show the fields as coming from wp-config.php automatically \u2014\nnothing else to configure.<\/p>\n\ndefine( 'DOCK_RAY_TOKEN', 'YOUR_PROJECT_TOKEN' );\ndefine( 'DOCK_RAY_PRIVATE_KEY', 'YOUR_PRIVATE_KEY' );\n<\/code><\/pre>\n\n\n\nDoes the plugin have a settings screen?<\/h3><\/dt>\nYes \u2014 Settings \u2192 DockRay<\/strong>. It shows a live configuration status, the\nresult of the last test event, and lets you edit the available settings without\ntouching wp-config.php<\/code>. Anything already defined as a constant keeps\nworking; the screen shows exactly which fields that applies to.<\/p><\/dd>\nWill it slow down my site?<\/h3><\/dt>\nRequest timing is off by default. When it is on, the transaction is sent after\nthe response has been handed to the browser, so the visitor does not wait for\nit.<\/p><\/dd>\n
What happens if the site cannot reach DockRay?<\/h3><\/dt>\nNothing visible. The request continues; with WP_DEBUG<\/code> on, a failure to start\nis written to the PHP error log.<\/p><\/dd>\nWhich languages does it speak?<\/h3><\/dt>\nEnglish by default, with Polish, German and Spanish translations shipped\ninside the plugin. Further languages can be contributed through\nhttps:\/\/translate.wordpress.org\/projects\/wp-plugins\/dockray\/.<\/p><\/dd>\n\n<\/dl>\n\n\n
1.0.1<\/h4>\n\n\n- Improved namespace.<\/li>\n<\/ul>\n\n
1.0.0<\/h4>\n\n\n- Initial release.<\/li>\n<\/ul>","raw_excerpt":"Reports PHP errors, uncaught exceptions and request timings from WordPress to the DockRay monitoring panel.","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/lij.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin\/365747","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/lij.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin"}],"about":[{"href":"https:\/\/lij.wordpress.org\/plugins\/wp-json\/wp\/v2\/types\/plugin"}],"replies":[{"embeddable":true,"href":"https:\/\/lij.wordpress.org\/plugins\/wp-json\/wp\/v2\/comments?post=365747"}],"author":[{"embeddable":true,"href":"https:\/\/lij.wordpress.org\/plugins\/wp-json\/wporg\/v1\/users\/jacycha"}],"wp:attachment":[{"href":"https:\/\/lij.wordpress.org\/plugins\/wp-json\/wp\/v2\/media?parent=365747"}],"wp:term":[{"taxonomy":"plugin_section","embeddable":true,"href":"https:\/\/lij.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_section?post=365747"},{"taxonomy":"plugin_tags","embeddable":true,"href":"https:\/\/lij.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_tags?post=365747"},{"taxonomy":"plugin_category","embeddable":true,"href":"https:\/\/lij.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_category?post=365747"},{"taxonomy":"plugin_contributors","embeddable":true,"href":"https:\/\/lij.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_contributors?post=365747"},{"taxonomy":"plugin_business_model","embeddable":true,"href":"https:\/\/lij.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_business_model?post=365747"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}