5

I've created a scripted dashboard for Grafana v2.1.2 and would like to add it to the Home dashboard list, however don't see a way to do it using the GUI's dashboard settings.

Is it possible? And if so, is there some documentation or example on how to do this?

Alan
  • 3,715
  • 3
  • 39
  • 57
  • are you looking something similar to https://grafana.wikimedia.org ? – Anatoly Sep 07 '15 at 06:57
  • That looks like a completely custom dashboard. I was wondering how to simply add my dashboard script to the Home page's default "Dashboards" list. – Alan Sep 08 '15 at 16:59

2 Answers2

3

This seems to be an longstanding issue with grafana and is not supported as mentioned on https://github.com/grafana/grafana/issues/4145

But luckily there is a workaround as described on https://github.com/anryko/grafana-influx-dashboard/issues/54

You will have to create a new grafana dashboard. In dashboard settings you should rename it to "Scripted Dashboard". Then add a "text" row of "html" type. Then to the text field of that row you need paste this code:

<meta http-equiv="refresh" content="1;url=/dashboard/script/getdash.js">
<script type="text/javascript">window.location.href = "/dashboard/script/getdash.js"</script>

After this is done you will have to save the dashboard. That's it. Now from your Grafana Home screen you can select newly created "Scripted Dashboard" and it will automatically redirect you to the actual GetDash dashboard.

In Grafana 4, you add a text panel in a row and switch mode from Markup to HTML, then insert snippet above.

Downside of this solution is that such dashboards can't be used in playlists (will redirect out of playlist's url).

Be careful about URL (especially if you run grafana under /grafana path) as this redirect dashboard can not be deleted from web UI, you will need to use API for that or (as stated in above issue)

Create a new one with the same name. Then on saving action it will let you overwrite the old one.

Update: Grafana 6 does not allow workaround anymore :(

VasekCh
  • 984
  • 8
  • 8
1

Yes, it is possible. But there is no direct way to implement this feature. Grafana allows dashboard API to create or update dashboards. You need to modify the default script dashboard object to adapt to this dashboard API as well as scripted dashboards.

Following is the default scripted dashboard:

'use strict';
var window, document, ARGS, $, jQuery, moment, kbn;
var dashboard = {
  rows : [],
};
dashboard.title = 'Scripted Dashboard';
dashboard.time = {
  from: "now-6h",
  to: "now"
};

dashboard.rows.push({
    title: 'Chart',
    height: '300px',
    panels: [
      {
        title: 'Events',
        type: 'graph'
      }]
  });


return dashboard;

Modified script to achieve the purpose:

'use strict' ;
var window, document, ARGS, $, jQuery, moment, kbn;
var ScriptedDashboard= {
        dashboard :{},
        overwrite: true
};

/* Create a simple dashboard*/
function createDashboard(dashboard){
        dashboard.title = 'Grafana Dashboard';
        dashboard.time = {
                from : "now-6h",
                to : "now"
        };
        dashboard.id= null;
        dashboard.uid= null;
}

function sendHTTPData(method, url, data){
    var httpRequest = new XMLHttpRequest();
    httpRequest.open( method,url , true);
    httpRequest.setRequestHeader("Content-Type", "application/json");
    httpRequest.setRequestHeader("Access-Control-Allow-Origin","*");
    var reqData = JSON.stringify(data);
    httpRequest.send(reqData);
}

createDashboard(ScriptedDashboard.dashboard);
sendHTTPData("POST", "http://192.168.0.104:3000/api/dashboards/db", ScriptedDashboard);

return ScriptedDashboard.dashboard;

See the difference between the above-scripted dashboards.

RaselAshraf
  • 11
  • 4