Merge pull request #19 from mpchadwick/release/v0.4

Release v0.4.0 -> Master

Author: mpchadwick

README.md

@@ -8,24 +8,33 @@ All configuration is done through an XML file in the `/app/etc` directory. This
 
 - `Mpchadwick_PageCacheHitRate_Model_Processor` is added as a `<request_processor>`.
   - **Note:** `request_processor`s are loaded alphabetically based on the file name in `/app/etc`. It is important that `Mpchadwick_PageCacheHitRate_Model_Processor` be the final `request_processor` to know for sure if this is a full hit. By default the `Enterprise_PageCache_Model_Processor` is defined in `enterprise.xml` and will be loaded first, however if your are using something else to process the result of `Enterprise_PageCache_Model_Processor` you may need to change the file name in `/app/etc`.
-- A `<tracker>` can be configured your `<full_page_cache>` configuration. If this node is omitted, hit rate will not be tracked.
+- `<tracker>`s can be configured in your `<full_page_cache>` configuration under the `<mpchadwick_pagecachehitrate>` node. If no trackers are specified, hit rate will not be tracked.
 - There is a `<track_container_misses>` setting which can be used to track individual container misses in the case of partial page hits.
-- A `<metadata_source>` can be configured under the `<full_page_cache>` configuration in the case where Enterprise_PageCache_Model_Processor is not the correct class to provide metadata. This can happen if the `<ee>` request processor is changed, notably with `Elastera_EnterprisePageCache`.
+- A `<metadata_source>` can be configured under the `<full_page_cache>` configuration in the case where `Enterprise_PageCache_Model_Processor` is not the correct class to provide metadata. This can happen if the `<ee>` request processor is changed, notably with `Elastera_EnterprisePageCache`.
 
 ###Trackers
 
 The following trackers are available...
 
 - **`Mpchadwick_PageCacheHitRate_Model_Tracker_File`** A log file will be used for for tracking hit rate. A new file will be created each day.
-- **`Mpchadwick_PageCacheHitRate_Model_Tracker_NewRelic`** Hits and misses will be tracked as [New Relic custom events](https://docs.newrelic.com/docs/insights/new-relic-insights/adding-querying-data/inserting-custom-events-new-relic-apm-agents).
+- **`Mpchadwick_PageCacheHitRate_Model_Tracker_NewRelic`** [New Relic custom events](https://docs.newrelic.com/docs/insights/new-relic-insights/adding-querying-data/inserting-custom-events-new-relic-apm-agents) will be used for tracking hit rate.
+- **`Mpchadwick_PageCacheHitRate_Model_Tracker_Redis`** Hit rate will be tracked in Redis. The intention is to scrape this data periodically and store it in a tool such as [InfluxDb](https://docs.influxdata.com/influxdb/v0.13/) or [Prometheus](https://prometheus.io/).
 
 You can easily create your own tracker if you'd prefer a different means of tracking. Simply implement the `Mpchadwick_PageCacheHitRate_Model_TrackerInterface` interface and configure your class as the `<tracker>` in an xml file in `/app/etc`.
 
-###Metrics
+###Dimensions
 
 In addition to a full hit and a full miss, `Enterprise_PageCache` can also have partial hits. This happens if a cached response is found, but it has containers that need additional processing. The `type` metric is thus tracked as either a `hit`, a `miss`, or a `partial`.
 
-In addition to `type`, the following metrics are tracked for each response `route`, `url` and `ip` are also tracked for each request. For example, you may want to see your cache hit rate for a single route such as `/catalog/product/view` or know your cache hit rate for a single IP address if your are seeing crawling / bot activity creating performance impact on your site.
+In addition to `type`, the following dimensions are tracked...
+
+- `route`,
+- `url`
+- `ip`
+- `hostname`
+- `customerGroup`
+
+For example, you may want to see your cache hit rate for a single route such as `/catalog/product/view` or know your cache hit rate for a single IP address if your are seeing crawling / bot activity creating performance impact on your site.
 
 Here are some example entries using the `Mpchadwick_PageCacheHitRate_Model_Tracker_File` tracker...
 
@@ -40,3 +49,34 @@ Container misses will be recorded to a separate file (if enabled). The entries w
 ```
 2016-06-02T03:18:14+00:00 DEBUG (7): {"url":"http:\/\/magento-1_14_1_0.dev\/women\/women-new-arrivals.html","ip":"172.16.9.1","route":"catalog\/category\/view","container":"Enterprise_PageCache_Model_Container_Catalognavigation"}
 ```
+
+Also note that you can configure multiple trackers. You may want to store data in both New Relic and Redis, for example.
+
+###Cardinality
+
+By default, highly cardinal dimensions are tracked such as IP address and URL. For the `Mpchadwick_PageCacheHitRate_Model_Tracker_File` and `Mpchadwick_PageCacheHitRate_Model_Tracker_NewRelic` trackers this is probably fine. However if you are using `Mpchadwick_PageCacheHitRate_Model_Tracker_Redis` and sending the data to InfluxDb or Prometheus you'll probably want to decrease the cardinality of the data.
+
+You can specify dimensions to strip on a per tracker-basis. E.g...
+
+```xml
+<config>
+    <global>
+        <full_page_cache>
+            <mpchadwick_pagecachehitrate>
+                <trackers>
+                    <redis>
+                        <class>Mpchadwick_PageCacheHitRate_Model_Tracker_Redis</class>
+                        <server>127.0.0.1</server>
+                        <port>6379</port>
+                        <database>1</database>
+                        <strip>
+                            <ip />
+                            <url />
+                        </strip>
+                    </redis>
+                </trackers>
+            </mpchadwick_pagecachehitrate>
+        </full_page_cache>
+    </global>
+</config>
+```

app/code/community/Mpchadwick/PageCacheHitRate/Model/Observer.php

@@ -2,8 +2,6 @@
 
 class Mpchadwick_PageCacheHitRate_Model_Observer
 {
-    const XML_PATH_TRACK_CONTAINER_MISSES = 'global/full_page_cache/mpchadwick_pagecachehitrate/track_container_misses';
-
     /**
      * Handle the controller_front_send_response_before event.
      *
@@ -35,7 +33,7 @@ public function handleControllerFrontSendResponseBefore(Varien_Event_Observer $o
             $tracker->track('RequestResponse', $params, $alias);
 
             // Track any container misses for a partial cache response
-            $trackContainerMisses = (string)Mage::getConfig()->getNode(self::XML_PATH_TRACK_CONTAINER_MISSES);
+            $trackContainerMisses = (string)$config->get('track_container_misses');
             if ($type === 'partial' && $trackContainerMisses) {
                 unset($params['type']);
                 $tracker->trackContainerMisses($params);

app/code/community/Mpchadwick/PageCacheHitRate/Model/Tracker/Abstract.php

@@ -2,7 +2,17 @@
 
 abstract class Mpchadwick_PageCacheHitRate_Model_Tracker_Abstract
 {
-    abstract protected function _track($type, array $args, $alias);
+    /** @var Mpchadwick_PageCacheHitRate_Model_Config */
+    protected $config;
+
+    /** @var Mpchadwick_PageCacheHitRate_Model_SystemLog */
+    protected $logger;
+
+    public function __construct()
+    {
+        $this->config = new Mpchadwick_PageCacheHitRate_Model_Config;
+        $this->logger = new Mpchadwick_PageCacheHitRate_Model_SystemLog;
+    }
 
     public function track($type, array $args, $alias)
     {
@@ -27,4 +37,6 @@ public function trackContainerMisses($params)
             ));
         }
     }
+
+    abstract protected function _track($type, array $args, $alias);
 }

app/code/community/Mpchadwick/PageCacheHitRate/Model/Tracker/NewRelic.php

@@ -7,7 +7,8 @@ class Mpchadwick_PageCacheHitRate_Model_Tracker_NewRelic
     protected function _track($type, array $args, $alias)
     {
         if (!function_exists('newrelic_record_custom_event')) {
-            Mage::logException(new Exception('You are using the New Relic tracker, but don\'t have the agent set up properly'));
+            $msg = 'You are using the New Relic tracker, but don\'t have the agent set up properly';
+            $this->logger->log($msg);
             return;
         }
 

app/code/community/Mpchadwick/PageCacheHitRate/Model/Tracker/Redis.php

@@ -9,13 +9,10 @@ class Mpchadwick_PageCacheHitRate_Model_Tracker_Redis
     /** @var Credis_Client */
     protected $redis;
 
-    /** @var Mpchadwick_PageCacheHitRate_Model_Config */
-    protected $config;
-
-    public function __construct()
+    public function connection()
     {
-        $this->config = new Mpchadwick_PageCacheHitRate_Model_Config;
-        $this->logger = new Mpchadwick_PageCacheHitRate_Model_SystemLog;
+        $this->setupConnection();
+        return $this->redis;
     }
 
     protected function _track($type, array $args, $alias)
@@ -36,7 +33,7 @@ protected function _track($type, array $args, $alias)
     protected function setupConnection($alias)
     {
         if (!is_null($this->redis)) {
-            return;
+            return true;
         }
 
         $prefix = 'trackers/' . $alias . '/';
@@ -57,7 +54,7 @@ protected function setupConnection($alias)
             $this->redis->connect();
             $this->redis->select($this->config->get($prefix . 'database'));
         } catch (Exception $e) {
-            $this->logger->log('Could not establish Redis connection', Zend_Log::ERR);
+            $this->logger->log($e->getMessage(), Zend_Log::ERR);
             return false;
         }
 

app/code/community/Mpchadwick/PageCacheHitRate/etc/config.xml

@@ -2,7 +2,7 @@
 <config>
     <modules>
         <Mpchadwick_PageCacheHitRate>
-            <version>0.3.0</version>
+            <version>0.4.0</version>
         </Mpchadwick_PageCacheHitRate>
     </modules>
     <global>