Skip to content

Feature: Config option that switches Grafana-Link destination #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
martialblog merged 3 commits into from
Mar 9, 2026
Merged

Feature: Config option that switches Grafana-Link destination #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aa6af7f
Feature: Config option that switches Grafana-Link destination
mrdsam Feb 17, 2026
87d95e8
Documentation: fixed typo
mrdsam Feb 17, 2026
b03cad1
IcingaDbGrapher: fix code style problems
mrdsam Feb 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions application/forms/Config/GeneralConfigForm.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,17 @@ public function createElements(array $formData)
]
);

// Grafana link to dashboard/panel configuration
$this->addElement(
'checkbox',
'grafana_dashboardlink',
[
'value' => false,
'label' => $this->translate('Link to dashboard'),
'description' => $this->translate('Link points to the dashboard instead of a single panel.'),
]
);

// Default theme
$this->addElement(
'select',
Expand Down
5 changes: 5 additions & 0 deletions doc/03-module-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ publicprotocol = "http"
custvardisable = "idontwanttoseeagraph"
ssl_verifypeer = "0"
ssl_verifyhost = "0"
dashboardlink = "0"
```

Hint: to display debug information for graphs you can use the URL parameter `&grafanaDebug`. This requires the `grafana/debug` permission.
Expand All @@ -57,6 +58,7 @@ Hint: to display debug information for graphs you can use the URL parameter `&gr
|defaultdashboarduid | **Required for Grafana 5** The UID of the default dashboard for **Grafana 5**.
|defaultdashboardpanelid| **Required** IDs of the panels used in the default dashboard. Defaults to `1`.
|shadows | **Optional.** Show shadows around the graphs. ** Defaults to `false`.|
|dashboardlink | **Optional.** Link to the dashboard instead to a single panel. |
|defaultorgid | **Required.** Number of the default organization id where dashboards are located. Defaults to `1`.
|accessmode | **Optional.** Controls whether graphs are fetched with curl (`indirectproxy`) or in iframe ('iframe'). Iframe needs `auth.anonymous` enabled in Grafana. Defaults to `indirectproxy`.|
|timeout | **Proxy only** **Optional.** Timeout in seconds for proxy mode to fetch images. Defaults to `5`.|
Expand Down Expand Up @@ -123,6 +125,9 @@ The IDs of the panels used in the default dashboard. Defaults to `1`.
### shadows
Enable/Disable fancy shadows around the graph image.

### dashboardlink
Controls whether the "view in grafana" link points to the whole dashboard or only to the panel (default). This is useful when only specific or single panels are shown in Icingaweb2 and the dashboard contains additional panels.

### accessmode
Controls how the graphs are fetched/delivered for/to the users.
Defaults to `indirectproxy`.
Expand Down
8 changes: 7 additions & 1 deletion library/Grafana/ProvidedHook/Icingadb/IcingaDbGrapher.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ trait IcingaDbGrapher
protected $defaultDashboardPanelId = "1";
protected $defaultOrgId = "1";
protected $shadows = false;
protected $dashboardLink = false;
protected $dataSource = null;
protected $accessMode = "proxy";
protected $proxyTimeout = "5";
Expand Down Expand Up @@ -142,6 +143,7 @@ protected function init()
$this->timerange = $this->config->get('timerange', $this->timerange);
$this->dataSource = $this->config->get('datasource', $this->dataSource);
$this->shadows = $this->config->get('shadows', $this->shadows);
$this->dashboardLink = $this->config->get('dashboardlink', $this->dashboardLink);
$this->custvardisable = ($this->config->get('custvardisable', $this->custvardisable));
$this->custvarconfig = ($this->config->get('custvarconfig', $this->custvarconfig));

Expand Down Expand Up @@ -482,7 +484,11 @@ public function getPreviewHtml(Model $object, $report = false): ValidHtml
// Add Link to Panel if the user has the permission
if ($this->permission->hasPermission('grafana/showlink')) {
$linkUrl = $url;
$linkUrl = preg_replace('/(viewPanel=)[^&]+/', '${1}' . $panelid, $linkUrl);
if ($this->dashboardLink) {
$linkUrl = preg_replace('/(viewPanel=)[^&]+/', '', $linkUrl);
} else {
$linkUrl = preg_replace('/(viewPanel=)[^&]+/', '${1}' . $panelid, $linkUrl);
}
$textLink = new Link('View in Grafana', $linkUrl, ['target' => '_blank', 'class' => 'external-link']);
$html->add($textLink);
$iconLink = new Link(new Icon('arrow-up-right-from-square', ['title' => 'View in Grafana']), $linkUrl, ['target' => '_blank', 'class' => 'external-link']);
Expand Down