Add external link to Grafana header via icon

- Adds a link via an icon in headline for both iframe and proxy mode
- Remove enableLink configuration and permission

Author: martialblog

application/forms/Config/GeneralConfigForm.php

@@ -271,22 +271,8 @@ public function createElements(array $formData)
                     'description' => $this->translate('The default graph width in pixels.')
                 ]
             );
-            $this->addElement(
-                'select',
-                'grafana_enableLink',
-                [
-                    'label' => $this->translate('Enable link'),
-                    'value' => 'no',
-                    'multiOptions' => [
-                        'yes' => $this->translate('Yes'),
-                        'no' => $this->translate('No'),
-                    ],
-                    'description' => $this->translate('Image is an link to the dashboard on the Grafana server.'),
-                    'class' => 'autosubmit'
-                ]
-            );
         }
-        if (isset($formData['grafana_enableLink']) && ( $formData['grafana_enableLink'] === 'yes') && ( $formData['grafana_accessmode'] != 'iframe' )) {
+        if (( $formData['grafana_accessmode'] != 'iframe' )) {
             $this->addElement(
                 'select',
                 'grafana_usepublic',

configuration.php

@@ -9,7 +9,6 @@
 $this->providePermission('grafana/graph', $this->translate('Allow to view graphs in dashboards.'));
 $this->providePermission('grafana/debug', $this->translate('Allow to see module debug information.'));
 $this->providePermission('grafana/showall', $this->translate('Allow access to see all graphs of a host.'));
-$this->providePermission('grafana/enablelink', $this->translate('Allow to follow links to Grafana.'));
 
 $this->provideConfigTab('config', [
     'title' => 'Configuration',

doc/03-module-configuration.md

@@ -35,7 +35,6 @@ height = "280"
 width = "640"
 timerange = "3h"
 timerangeAll = "1M/M"
-enableLink = "yes"
 defaultorgid = "1"
 defaultdashboard = "icinga2-default"
 defaultdashboardpanelid = "1"
@@ -66,7 +65,6 @@ ssl_verifyhost = "0"
 |width                  | **Optional.** Global graph width in pixel. Defaults to `640`.|
 |timerange              | **Optional.** Global time range for graphs. Defaults to `6h`.|
 |timerangeAll           | **Optional.** Time range for all graphs feature. Defaults to `Previous week`.|
-|enableLink             | **Optional.** Enable/disable graph with a rendered URL to the Grafana dashboard. Defaults to `yes`.|
 |datasource             | **Required for Grafana 4.x only.** Type of the Grafana datasource (`influxdb`, `graphite` or `pnp`). Defaults to `influxdb`.|
 |defaultdashboard       | **Required.** Name of the default dashboard which will be shown for unconfigured graphs. Set to `none` to hide the module output. Defaults to `icinga2-default`.|
 |defaultdashboarduid    | **Required for Grafana 5** The UID of the default dashboard for **Grafana 5**.
@@ -118,9 +116,6 @@ This option can be overwritten by a graph configuration.
 ### timerangeAll
 Time range for all graphs feature. Defaults to `Previous week`
 
-### enableLink
-Enable or disable the graphs as a link to the Grafana Server.
-
 ### datasource
 The datasource that Grafana server uses. Can be InfluxDB, Graphite.
 

library/Grafana/ProvidedHook/Icingadb/IcingaDbGrapher.php

@@ -23,12 +23,20 @@
 use ipl\Stdlib\Filter;
 use ipl\Web\Url;
 use ipl\Web\Widget\Link;
+use ipl\Web\Widget\Icon;
 
+/**
+ * IcingaDbGrapher contains methods for retrieving and rendering the data from Grafana
+ */
 trait IcingaDbGrapher
 {
     use Database;
     use IcingaDbAuth;
 
+    // Could be constants in the future, but for now we want to keep compatibility
+    protected $GRAFANA_URL = "%s://%s/d/%s/%s?var-hostname=%s&var-service=%s&var-command=%s%s&from=%s&to=%s&orgId=%s&viewPanel=%s";
+    protected $GRAFANA_URL_SOLO = "%s://%s/d-solo/%s/%s?var-hostname=%s&var-service=%s&var-command=%s%s&panelId=%s&orgId=%s&theme=%s&from=%s&to=%s";
+
     protected $config;
     protected $graphConfig;
     protected $auth;
@@ -46,7 +54,6 @@ trait IcingaDbGrapher
     protected $apiToken = null;
     protected $width = 640;
     protected $height = 280;
-    protected $enableLink = true;
     protected $defaultDashboard = "icinga2-default";
     protected $defaultDashboardPanelId = "1";
     protected $defaultOrgId = "1";
@@ -81,6 +88,7 @@ protected function init()
         $this->title = Html::tag("h2", "Performance Graph");
         $this->permission = Auth::getInstance();
         $this->config = Config::module('grafana')->getSection('grafana');
+
         $this->grafanaVersion = $this->config->get('version', $this->grafanaVersion);
         $this->grafanaHost = $this->config->get('host', $this->grafanaHost);
         if ($this->grafanaHost === null) {
@@ -89,21 +97,20 @@ protected function init()
             );
         }
 
+        // Set the protocol and host
         $this->protocol = $this->config->get('protocol', $this->protocol);
-        $this->enableLink = $this->config->get('enableLink', $this->enableLink);
-        if ($this->enableLink === "yes" && $this->permission->hasPermission('grafana/enablelink')) {
-            $this->usePublic = $this->config->get('usepublic', $this->usePublic);
-            if ($this->usePublic === "yes") {
-                $this->publicHost = $this->config->get('publichost', $this->publicHost);
-                if ($this->publicHost === null) {
-                    throw new ConfigurationError(
-                        'No Grafana public host configured!'
-                    );
-                }
-                $this->publicProtocol = $this->config->get('publicprotocol', $this->publicProtocol);
-            } else {
-                $this->publicHost = $this->grafanaHost;
-                $this->publicProtocol = $this->protocol;
+        $this->publicHost = $this->grafanaHost;
+        $this->publicProtocol = $this->protocol;
+
+        // Override protocol and host if usePublic is set
+        $this->usePublic = $this->config->get('usepublic', $this->usePublic);
+        if ($this->usePublic === 'yes') {
+            $this->publicHost = $this->config->get('publichost', $this->publicHost);
+            $this->publicProtocol = $this->config->get('publicprotocol', $this->publicProtocol);
+            if ($this->publicHost === null) {
+                throw new ConfigurationError(
+                    'No Grafana public host configured!'
+                );
             }
         }
 
@@ -120,6 +127,7 @@ protected function init()
             'defaultdashboardpanelid',
             $this->defaultDashboardPanelId
         );
+
         $this->defaultOrgId = $this->config->get('defaultorgid', $this->defaultOrgId);
         $this->grafanaTheme = $this->getUserThemeMode();
         $this->height = $this->config->get('height', $this->height);
@@ -164,7 +172,6 @@ protected function init()
         /**
          * Username & Password or token
          */
-
         $this->apiToken = $this->config->get('apitoken', $this->apiToken);
         $this->authentication = $this->config->get('authentication');
         if ($this->apiToken === null && $this->authentication === "token") {
@@ -310,8 +317,7 @@ private function getMyPreviewHtml($serviceName, $hostName, HtmlDocument $preview
             $previewHtml->add($imgHtml);
         } elseif ($this->accessMode === "iframe") {
             $iFramesrc = sprintf(
-                "%s://%s/d-solo/%s/%s?" .
-                "var-hostname=%s&var-service=%s&var-command=%s%s&panelId=%s&orgId=%s&theme=%s&from=%s&to=%s",
+                $this->GRAFANA_URL_SOLO,
                 $this->protocol,
                 $this->grafanaHost,
                 $this->dashboarduid,
@@ -339,6 +345,7 @@ private function getMyPreviewHtml($serviceName, $hostName, HtmlDocument $preview
 
             $previewHtml->add($iframeHtml);
         }
+
         return true;
     }
 
@@ -444,6 +451,35 @@ public function getPreviewHtml(Model $object, $report = false)
 
         $return_html = new HtmlDocument();
 
+        // URL for link to external Grafana
+        $url = sprintf(
+            $this->GRAFANA_URL,
+            $this->publicProtocol,
+            $this->publicHost,
+            $this->dashboarduid,
+            $this->dashboard,
+            rawurlencode(($this->dataSource === 'graphite' ? Util::graphiteReplace($hostName) : $hostName)),
+            rawurlencode(
+                ($this->dataSource === 'graphite' ? Util::graphiteReplace($serviceName) : $serviceName)
+            ),
+            rawurlencode($object->checkcommand_name),
+            $this->customVars,
+            urlencode($this->timerange),
+            urlencode($this->timerangeto),
+            $this->orgId,
+            $this->panelId
+        );
+
+        // Add a link to Grafana in the title
+        $this->title->add(new Link(
+            new Icon(
+                'arrow-up-right-from-square',
+                ['title' => 'View in Grafana']
+            ),
+            str_replace('/d-solo/', '/d/', $url),
+            ['target' => '_blank', 'class' => 'external-link']
+        ));
+
         // Hide menu if in reporting or compact mode
         $menu = "";
 
@@ -458,44 +494,18 @@ public function getPreviewHtml(Model $object, $report = false)
             $html = new HtmlDocument();
             $this->panelId = $panelid;
 
-            //image value will be returned as reference
+            // The image value will be returned as reference
             $previewHtml = new HtmlDocument();
             $res = $this->getMyPreviewHtml($serviceName, $hostName, $previewHtml);
-            //do not render URLs on error or if disabled
-            if (! $res
-                || $this->enableLink === "no"
-                || ! $this->permission->hasPermission('grafana/enablelink')) {
-                $html->addHtml($previewHtml);
-            } else {
-                $urlFormat = "%s://%s/d/%s/%s" .
-                "?var-hostname=%s&var-service=%s&var-command=%s%s&from=%s&to=%s&orgId=%s&viewPanel=%s";
-
-                $url = sprintf(
-                    $urlFormat,
-                    $this->publicProtocol,
-                    $this->publicHost,
-                    $this->dashboarduid,
-                    $this->dashboard,
-                    rawurlencode(($this->dataSource === "graphite" ? Util::graphiteReplace($hostName) : $hostName)),
-                    rawurlencode(
-                        ($this->dataSource === "graphite" ? Util::graphiteReplace($serviceName) : $serviceName)
-                    ),
-                    rawurlencode($object->checkcommand_name),
-                    $this->customVars,
-                    urlencode($this->timerange),
-                    urlencode($this->timerangeto),
-                    $this->orgId,
-                    $this->panelId
-                );
 
-                $link = new Link($previewHtml, $url, ["target" => "_blank"]);
-
-                $html->add($link);
+            if ($res) {
+                $html->addHtml($previewHtml);
             }
 
             $return_html->add($html);
         }
 
+        // Add a data table with runtime information and configuration for debugging purposes
         if ($this->debug && $this->permission->hasPermission('grafana/debug') && $report === false) {
             if ($this->accessMode === "indirectproxy") {
                 $usedUrl = $this->pngUrl;

public/css/module.less

@@ -52,6 +52,12 @@
   padding: 0;
 }
 
+/* Icon to external pages like Grafana */
+.external-link {
+  margin: 0 0.33em;
+  font-size: 0.77em;
+}
+
 /* NAVIGATION */
 .grafana-menu-navigation {
   list-style: none;