Make DB connection name configurable #14

docs/Configuration.md

@@ -4,7 +4,7 @@ Configuration
 General
 -------
 
-The configuration can be set in `App.Heartbeat`.  
+The configuration can be set in `App.Heartbeat`.
 It takes the following subkeys:
 - `name` The name of your application (will be used for the title of the hearbeat status page)
 - `layout` To override the layout (see below)
@@ -26,6 +26,9 @@ $config['App']['Heartbeat'] = [
             'severity' => 3,
             'class' => OrcaServices\Heartbeat\Heartbeat\Sensor\DBConnection::class,
             'cached' => true,
+            'settings' => [
+                'connection_name' => 'default',
+            ],
         ],
         'DB up to date' => [
             'enabled' => false,
@@ -41,7 +44,7 @@ $config['App']['Heartbeat'] = [
 Sensors
 -------
 
-You can add your own sensor to your heartbeat status. See [How to write a Sensor](Sensors.md) for details.  
+You can add your own sensor to your heartbeat status. See [How to write a Sensor](Sensors.md) for details. 
 To add your sensor to your status page, you have to add it to your configuration array.
 The sensor array takes the names of your registered sensors as subkeys, which in turn contain configuration arrays.
 
@@ -56,6 +59,7 @@ Those take the following subkeys:
 	 - If set to false, the value will not be cached.
 	 - If set to true, the value will be cached for 30 seconds (by default).
 	 - Can be set to a relative time string e.g. '+10 minutes' to cache the value for 10 minutes.
+- `settings` Additional settings for the sensor. e.g. the name of the database connection to test.
 
 Layout overriding
 -----------------

docs/Sensors.md

@@ -4,6 +4,21 @@ Built-in Sensors
 #### DB Connection
 Checks whether a connection to the database server can be established.
 
+To check a different connection than ``default``, e.g. ``external``, 
+the ``connection_name``setting can be used.
+
+ ```php
+$config['App']['Heartbeat']['Sensors']['DB Connection'] = [
+    'enabled' => true,
+    'severity' => 3,
+    'class' => OrcaServices\Heartbeat\Heartbeat\Sensor\DBConnection::class,
+    'cached' => true,
+    'settings' => [
+        'connection_name' => 'external'
+    ],
+];
+```
+
 #### DB Up to date
 Uses the Migrations Plugin to check whether all migrations have been run.
 

src/Heartbeat/Sensor.php

@@ -4,6 +4,7 @@
 
 use Cake\Cache\Cache;
 use Cake\Chronos\Chronos;
+use Cake\Utility\Hash;
 use Cake\Utility\Text;
 use OrcaServices\Heartbeat\Heartbeat\Sensor\Config;
 use OrcaServices\Heartbeat\Heartbeat\Sensor\Status;
@@ -124,4 +125,20 @@ protected function _getNonCachedStatus(): Status
      * @return mixed The sensor status.
      */
     abstract protected function _getStatus();
+
+    /**
+     * Get the given setting or an optional default value
+     *
+     * @param string $name The name of the setting to retrieve.
+     * @param null|mixed $default The optional default value, if the setting is not set.
+     * @return string The name of the connection to check.
+     * @todo Cover by a test.
+     */
+    protected function _getSetting(string $name, $default = null): string
+    {
+        $settings = $this->config->getSettings();
+        $setting = Hash::get($settings, $name, $default);
+
+        return $setting;
+    }
 }

src/Heartbeat/Sensor/Config.php

@@ -44,6 +44,13 @@ class Config
      */
     protected $cached = false;
 
+    /**
+     * Additional settings
+     *
+     * @var array
+     */
+    protected $settings = [];
+
     /**
      * The default config
      *
@@ -54,6 +61,7 @@ class Config
         'severity' => Status::STATUS_NONCRITICAL,
         'class' => null,
         'cached' => false,
+        'settings' => [],
     ];
 
     /**
@@ -72,6 +80,7 @@ public function __construct($name, array $config)
         $this->setSeverity($config['severity']);
         $this->setClass($config['class']);
         $this->setCached($config['cached']);
+        $this->setSettings($config['settings']);
     }
 
     /**
@@ -201,4 +210,26 @@ public function setCached($cached)
         $this->cached = $cached;
     }
 
+    /**
+     * Get additional settings for the sensor
+     *
+     * @return array The settings of the sensor.
+     * @todo Cover by a test.
+     */
+    public function getSettings(): array
+    {
+        return $this->settings;
+    }
+
+    /**
+     * Set the additional settings of the sensor
+     *
+     * @param array $settings The settings of the sensor.
+     * @todo Cover by a test.
+     */
+    public function setSettings(array $settings)
+    {
+        $this->settings = $settings;
+    }
+
 }

src/Heartbeat/Sensor/DBConnection.php

@@ -2,6 +2,7 @@
 
 namespace OrcaServices\Heartbeat\Heartbeat\Sensor;
 
+use Cake\Database\DriverInterface;
 use OrcaServices\Heartbeat\Heartbeat\Sensor;
 use Cake\Datasource\ConnectionManager;
 
@@ -20,11 +21,14 @@ class DBConnection extends Sensor
     protected function _getStatus()
     {
         try {
-            $connection = ConnectionManager::get('default');
+            $connectionName = $this->_getSetting('connection_name', 'default');
+
+            /** @var DriverInterface $connection */
+            $connection = ConnectionManager::get($connectionName);
+
             return $connection->connect();
         } catch (\Exception $e) {
             return false;
         }
     }
-
 }