Ignoring apdex metrics

neeckeloo · Jan 24, 2014 · 72d5fc4 · 72d5fc4
1 parent a22dad0
commit 72d5fc4
Show file tree

Hide file tree

Showing 13 changed files with 174 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -127,15 +127,36 @@ return array(
 );
 ```
 
-#### Defines a background job manually
+#### Define a background job manually
 
-You can define a transaction as background job by calling ```backgroundJob()``` method of NewRelic client.
+You can define a transaction as background job manually by calling ```backgroundJob()``` method of NewRelic client.
 
 ```php
 $client = $this->getServiceLocator()->get('NewRelic\Client');
 $client->backgroundJob(true);
 ```
 
+### Ignore apdex metrics
+
+You can ignore apdex metrics like transaction metrics using the key ```ignored_apdex```.
+
+```php
+return array(
+    'newrelic' => array(
+        'ignored_apdex' => array(),
+    ),
+);
+```
+
+#### Ignore apdex metrics manually
+
+You can ignore apdex metrics manually by calling ```ignoreApdex()``` method of NewRelic client.
+
+```php
+$client = $this->getServiceLocator()->get('NewRelic\Client');
+$client->ignoreApdex(true);
+```
+
 ### Add custom metric
 
 ```php

diff --git a/config/module.config.php b/config/module.config.php
@@ -15,11 +15,12 @@
             'NewRelic\ResponseListener' => 'NewRelic\Listener\ResponseListener',
         ),
         'factories' => array(
-            'NewRelic\BackgroundJobListener'      => 'NewRelic\Service\BackgroundJobListenerFactory',
-            'NewRelic\ModuleOptions'              => 'NewRelic\Service\ModuleOptionsFactory',
-            'NewRelic\ErrorListener'              => 'NewRelic\Service\ErrorListenerFactory',
-            'NewRelic\Logger'                     => 'NewRelic\Service\LoggerFactory',
-            'NewRelic\IgnoredTransactionListener' => 'NewRelic\Service\IgnoredTransactionListenerFactory',
+            'NewRelic\BackgroundJobListener'     => 'NewRelic\Service\BackgroundJobListenerFactory',
+            'NewRelic\ModuleOptions'             => 'NewRelic\Service\ModuleOptionsFactory',
+            'NewRelic\ErrorListener'             => 'NewRelic\Service\ErrorListenerFactory',
+            'NewRelic\Logger'                    => 'NewRelic\Service\LoggerFactory',
+            'NewRelic\IgnoreApdexListener'       => 'NewRelic\Service\IgnoreApdexListenerFactory',
+            'NewRelic\IgnoreTransactionListener' => 'NewRelic\Service\IgnoreTransactionListenerFactory',
         ),
     ),
 );
diff --git a/config/newrelic.local.php.dist b/config/newrelic.local.php.dist
@@ -27,13 +27,18 @@ return array(
         // 'exceptions_logging_enabled' => false,
 
         /**
-         * Defines ignored transactions
+         * Defines transactions that does not generate metrics
          */
         'ignored_transactions' => array(),
 
         /**
          * Defines background job transactions
          */
         'background_jobs' => array(),
+
+        /**
+         * Defines transactions that does not generate apdex metrics
+         */
+        'ignored_apdex' => array(),
     ),
 );
diff --git a/src/NewRelic/Listener/IgnoreApdexListener.php b/src/NewRelic/Listener/IgnoreApdexListener.php
@@ -0,0 +1,30 @@
+<?php
+namespace NewRelic\Listener;
+
+use Zend\EventManager\EventManagerInterface as Events;
+use Zend\Mvc\MvcEvent;
+
+class IgnoreApdexListener extends AbstractTransactionListener
+{
+    /**
+     * @param  Events $events
+     * @return void
+     */
+    public function attach(Events $events)
+    {
+        $this->listeners[] = $events->attach(MvcEvent::EVENT_ROUTE, array($this, 'onRequest'), -99);
+    }
+
+    /**
+     * @param  MvcEvent $e
+     * @return void
+     */
+    public function onRequest(MvcEvent $e)
+    {
+        if (!$this->isMatchedRequest($e)) {
+            return;
+        }
+
+        $this->client->ignoreApdex();
+    }
+}
diff --git a/...c/Listener/IgnoredTransactionListener.php → ...ic/Listener/IgnoreTransactionListener.php b/...c/Listener/IgnoredTransactionListener.php → ...ic/Listener/IgnoreTransactionListener.php
@@ -4,7 +4,7 @@
 use Zend\EventManager\EventManagerInterface as Events;
 use Zend\Mvc\MvcEvent;
 
-class IgnoredTransactionListener extends AbstractTransactionListener
+class IgnoreTransactionListener extends AbstractTransactionListener
 {
     /**
      * @param  Events $events

diff --git a/src/NewRelic/Module.php b/src/NewRelic/Module.php
@@ -17,7 +17,8 @@ class Module implements
     protected $listeners = array(
         'NewRelic\BackgroundJobListener',
         'NewRelic\ErrorListener',
-        'NewRelic\IgnoredTransactionListener',
+        'NewRelic\IgnoreApdexListener',
+        'NewRelic\IgnoreTransactionListener',
         'NewRelic\RequestListener',
         'NewRelic\ResponseListener',
     );
@@ -48,7 +49,7 @@ public function getServiceConfig()
                         $service->setClient($client);
                     }
                 },
-                'options' => function($service, $sm) {
+                'module_options' => function($service, $sm) {
                     if ($service instanceof ModuleOptionsAwareInterface) {
                         $moduleOptions = $sm->get('NewRelic\ModuleOptions');
                         $service->setModuleOptions($moduleOptions);

diff --git a/src/NewRelic/ModuleOptions.php b/src/NewRelic/ModuleOptions.php
@@ -40,6 +40,11 @@ class ModuleOptions extends AbstractOptions implements ModuleOptionsInterface
      */
     protected $backgroundJobs = array();
 
+    /**
+     * @var array
+     */
+    protected $ignoredApdex = array();
+
     /**
      * {@inheritdoc}
      */
@@ -161,4 +166,20 @@ public function getBackgroundJobs()
     {
         return $this->backgroundJobs;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setIgnoredApdex(array $transactions)
+    {
+        $this->ignoredApdex = $transactions;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getIgnoredApdex()
+    {
+        return $this->ignoredApdex;
+    }
 }
diff --git a/src/NewRelic/ModuleOptionsInterface.php b/src/NewRelic/ModuleOptionsInterface.php
@@ -79,4 +79,15 @@ public function setBackgroundJobs(array $transactions);
      * @return array
      */
     public function getBackgroundJobs();
+
+    /**
+     * @param  array $transactions
+     * @return self
+     */
+    public function setIgnoredApdex(array $transactions);
+
+    /**
+     * @return array
+     */
+    public function getIgnoredApdex();
 }
diff --git a/...ice/IgnoredTransactionListenerFactory.php → ...ic/Service/IgnoreApdexListenerFactory.php b/...ice/IgnoredTransactionListenerFactory.php → ...ic/Service/IgnoreApdexListenerFactory.php
@@ -1,23 +1,23 @@
 <?php
 namespace NewRelic\Service;
 
-use NewRelic\Listener\IgnoredTransactionListener;
+use NewRelic\Listener\IgnoreApdexListener;
 use Zend\ServiceManager\FactoryInterface;
 use Zend\ServiceManager\ServiceLocatorInterface;
 
 /**
- * NewRelic ignored transaction listener factory
+ * NewRelic ignore apdex listener factory
  */
-class IgnoredTransactionListenerFactory implements FactoryInterface
+class IgnoreApdexListenerFactory implements FactoryInterface
 {
     /**
      * @param  ServiceLocatorInterface $serviceLocator
-     * @return IgnoredTransactionListener
+     * @return IgnoreApdexListener
      */
     public function createService(ServiceLocatorInterface $serviceLocator)
     {
         $moduleOptions = $serviceLocator->get('NewRelic\ModuleOptions');
 
-        return new IgnoredTransactionListener($moduleOptions->getIgnoredTransactions());
+        return new IgnoreApdexListener($moduleOptions->getIgnoredApdex());
     }
 }
diff --git a/src/NewRelic/Service/IgnoreTransactionListenerFactory.php b/src/NewRelic/Service/IgnoreTransactionListenerFactory.php
@@ -0,0 +1,23 @@
+<?php
+namespace NewRelic\Service;
+
+use NewRelic\Listener\IgnoreTransactionListener;
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+
+/**
+ * NewRelic ignore transaction listener factory
+ */
+class IgnoreTransactionListenerFactory implements FactoryInterface
+{
+    /**
+     * @param  ServiceLocatorInterface $serviceLocator
+     * @return IgnoreTransactionListener
+     */
+    public function createService(ServiceLocatorInterface $serviceLocator)
+    {
+        $moduleOptions = $serviceLocator->get('NewRelic\ModuleOptions');
+
+        return new IgnoreTransactionListener($moduleOptions->getIgnoredTransactions());
+    }
+}
diff --git a/...stener/IgnoredTransactionListenerTest.php → ...istener/IgnoreTransactionListenerTest.php b/...stener/IgnoredTransactionListenerTest.php → ...istener/IgnoreTransactionListenerTest.php
@@ -4,7 +4,7 @@
 use NewRelic\ClientInterface;
 use Zend\Mvc\MvcEvent;
 
-class IgnoredTransactionListenerTest extends \PHPUnit_Framework_TestCase
+class IgnoreTransactionListenerTest extends \PHPUnit_Framework_TestCase
 {
     /**
      * @var ClientInterface 
@@ -40,7 +40,7 @@ public function setUp()
      */
     protected function getListener($transactions)
     {
-        $listener = new IgnoredTransactionListener($transactions);
+        $listener = new IgnoreTransactionListener($transactions);
         $listener->setClient($this->client);
 
         return $listener;

diff --git a/tests/NewRelic/Service/IgnoreApdexListenerFactoryTest.php b/tests/NewRelic/Service/IgnoreApdexListenerFactoryTest.php
@@ -0,0 +1,37 @@
+<?php
+namespace NewRelic\Service;
+
+class IgnoreApdexListenerFactoryTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @var IgnoreApdexListenerFactory
+     */
+    protected $ignoreApdexListenerFactory;
+
+    public function setUp()
+    {
+        $this->ignoreApdexListenerFactory = new IgnoreApdexListenerFactory();
+    }
+
+    public function testCreateService()
+    {
+        $moduleOptions = $this->getMock('NewRelic\ModuleOptions');
+        $moduleOptions
+            ->expects($this->once())
+            ->method('getIgnoredApdex')
+            ->will($this->returnValue(array()));
+
+        $serviceManager = $this->getMockBuilder('Zend\ServiceManager\ServiceManager')
+            ->disableOriginalConstructor()
+            ->setMethods(array('get'))
+            ->getMock();
+
+        $serviceManager->expects($this->once())
+            ->method('get')
+            ->will($this->returnValue($moduleOptions));
+
+        $listener = $this->ignoreApdexListenerFactory->createService($serviceManager);
+
+        $this->assertInstanceOf('NewRelic\Listener\IgnoreApdexListener', $listener);
+    }
+}
diff --git a/...IgnoredTransactionListenerFactoryTest.php → .../IgnoreTransactionListenerFactoryTest.php b/...IgnoredTransactionListenerFactoryTest.php → .../IgnoreTransactionListenerFactoryTest.php
@@ -1,16 +1,16 @@
 <?php
 namespace NewRelic\Service;
 
-class IgnoredTransactionListenerFactoryTest extends \PHPUnit_Framework_TestCase
+class IgnoreTransactionListenerFactoryTest extends \PHPUnit_Framework_TestCase
 {
     /**
-     * @var IgnoredTransactionListenerFactory
+     * @var IgnoreTransactionListenerFactory
      */
-    protected $ignoredTransactionListenerFactory;
+    protected $ignoreTransactionListenerFactory;
 
     public function setUp()
     {
-        $this->ignoredTransactionListenerFactory = new IgnoredTransactionListenerFactory();
+        $this->ignoreTransactionListenerFactory = new IgnoreTransactionListenerFactory();
     }
 
     public function testCreateService()
@@ -30,8 +30,8 @@ public function testCreateService()
             ->method('get')
             ->will($this->returnValue($moduleOptions));
 
-        $listener = $this->ignoredTransactionListenerFactory->createService($serviceManager);
+        $listener = $this->ignoreTransactionListenerFactory->createService($serviceManager);
 
-        $this->assertInstanceOf('NewRelic\Listener\IgnoredTransactionListener', $listener);
+        $this->assertInstanceOf('NewRelic\Listener\IgnoreTransactionListener', $listener);
     }
 }