uafrica/cakephp-newrelic

CakePHP <3 NewRelic

This package's canonical repository appears to be gone and the package has been frozen as a result.

1.0.0-beta2 2020-02-17 13:40 UTC

Requires

• php: >= 7.2.0
• cakephp/cakephp: ^4.0

Requires (Dev)

• cakephp/cakephp-codesniffer: ^4.0

MIT

• Christian Winther
• Walther Lalk

• plugin
• cakephp
• newrelic
• apm

README

You can modify your files like this to have full NewRelic support.

This is a fork of https://github.com/jippi/cakephp-newrelic

Things included

• NewRelic.NewRelic task
• NewRelic.NewRelic component
• NewRelicTrait trait
• NewRelic.NewRelic

Requirements

• New Relic PHP agent installed as a PHP module

Installation

First require the NewRelic plugin.

composer require uafrica/cakephp-newrelic

Then load the plugin

bin/cake plugin load NewRelic

Shell

Shells have been deprecated since CakePHP 3.6, but are still available for use. Include this snippet in src/Shell/AppShell.php and ensure all your shells extend it.

	public function startup() {
		$this->NewRelic = $this->Tasks->load('NewRelic.NewRelic');
		$this->NewRelic->setName($this);
		$this->NewRelic->start();
		$this->NewRelic->parameter('params', json_encode($this->params));
		$this->NewRelic->parameter('args', json_encode($this->args));

		parent::startup();
	}

Commands

Commands unfortunately do not offer a simple way to "inject" code into all commands. A trait is offered to handle the NewRelic injection.

Example usage:

<?php

namespace App\Command;

use Cake\Console\Arguments;
use Cake\Console\Command;
use Cake\Console\ConsoleIo;
use NewRelic\Traits\NewRelicTrait;

class ChannelsImportCommand extends Command
{
	use NewRelicTrait;

	public function execute(Arguments $args, ConsoleIo $io)
	{
		$this->setName($this);
		$this->setArguments($args);

		//Rest of your command code.
	}
}

Controller

Simply add NewRelic.NewRelic to your $components list

Middleware

You can use the supplied NewRelicErrorHandlerMiddleware placed in NewRelic\Middleware\NewRelicErrorHandlerMiddleware which extends the built in Cake\Error\Middleware\ErrorHandlerMiddleware. By using this you'll get the NewRelic working and have default CakePHP behavior.

Example:

<?php

namespace App;

use Cake\Http\BaseApplication;
use Cake\Routing\Middleware\AssetMiddleware;
use Cake\Routing\Middleware\RoutingMiddleware;

/**
 * Application setup class.
 *
 * This defines the bootstrapping logic and middleware layers you
 * want to use in your application.
 */
class Application extends BaseApplication
{
    /**
     * Setup the middleware your application will use.
     *
     * @param \Cake\Http\MiddlewareQueue $middleware The middleware queue to setup.
     * @return \Cake\Http\MiddlewareQueue The updated middleware.
     */
    public function middleware($middleware)
    {
        $middleware
            // Catch any exceptions in the lower layers,
            // and make an error page/response
            ->add(\NewRelic\Middleware\NewRelicErrorHandlerMiddleware::class)
            // Handle plugin/theme assets like CakePHP normally does.
            ->add(AssetMiddleware::class)
            // Apply routing
            ->add(RoutingMiddleware::class);

        return $middleware;
    }
}

?>