topic how to refresh the panel not entire dashboard in Dashboards & Visualizations

how to refresh the panel not entire dashboard

mvaradarajam — Mon, 09 Dec 2013 13:06:58 GMT

using refresh="12" it refresh the entire dashboard page but i dnt want entire page refresh,i want only one panel refresh,how acheive this one.plz help any one.

Re: how to refresh the panel not entire dashboard

cesarn — Mon, 21 Apr 2014 16:54:07 GMT

I concur that an AJAX based refresh of the individual panels is so much desirable.

Re: how to refresh the panel not entire dashboard

ben_leung — Wed, 11 Feb 2015 23:39:05 GMT

Is this possible in version 6.0.X? 6.2.X?

Re: how to refresh the panel not entire dashboard

bandit — Fri, 10 Apr 2015 21:28:54 GMT

Panel refresh

  <option name="refresh.auto.interval">60</option>

Also works with tokens if you want to allow the user to specify with a dashboard dropdown.

      <option name="refresh.auto.interval">$refresh_interval$</option>

Dashboard input example:

        <input type="dropdown" token="refresh_interval" searchWhenChanged="true">
          <label>Panel Refresh Override</label>
          <choice value="60">1 Minute</choice>
          <choice value="300">5 Minutes</choice>
          <default>300</default>
        </input>

http://docs.splunk.com/Documentation/Splunk/latest/Viz/PanelreferenceforSimplifiedXML

Re: how to refresh the panel not entire dashboard

chimell — Sat, 11 Apr 2015 15:23:47 GMT

Hi mvaradarajam

To refresh a search for a panel:

1) In the Panel Editor, click the Refresh icon.

2) use the option in your panel

 <option name="refresh.auto.interval"> 12 </option>

Re: how to refresh the panel not entire dashboard

dlisicre — Tue, 15 Dec 2015 12:35:29 GMT

Hi Rob,

I am trying token based refresh.auto.interval as you have specified, but it is not working correctly.

Is this not valid for Splunk Free 6.3?

Kind regards

Re: how to refresh the panel not entire dashboard

TonyLeeVT — Tue, 12 Apr 2016 21:43:57 GMT

I am having the same issue with the token based refresh not working.

Re: how to refresh the panel not entire dashboard

dlisicre — Wed, 13 Apr 2016 08:45:25 GMT

Hi Tony, token based refresh wasn't working for me either.
Ended up doing something quick and dirty:
Created my own dropdown with my refresh values. This sets off a time on change of value.
When timer sets off, it looks for the refresh icon available below each chart, and clicks it.

Was the only way I found of doing it.

Kind regards,
David Lisin

Re: how to refresh the panel not entire dashboard

cesaccenturefed — Tue, 20 Sep 2016 21:34:40 GMT

how did you do this? we have the same issue. are you using some kind of java script to do this?

i'm lost on this part
"This sets off a time on change of value.
When timer sets off, it looks for the refresh icon available below each chart, and clicks it.

Was the only way I found of doing it."

Re: how to refresh the panel not entire dashboard

dlisicre — Tue, 29 Sep 2020 11:03:00 GMT

Hi Cesaccenturefed,

so basically what I did was:

On your dashboard:

1) Add refresh_charts_en.js to your form scripts section.

2) Add this code to your dashboard:

<input type="dropdown" token="refreshPeriod" searchWhenChanged="true" id="row0Element4">
      <label>Refresh period</label>
      <choice value="0">Off</choice>
      <choice value="1">1 min</choice>
      <choice value="2">2 min</choice>
      <choice value="5">5 min</choice>
      <choice value="10">10 min</choice>
      <choice value="30">30 min</choice>
      <choice value="60">1 hour</choice>
      <default>0</default>    
    </input>

Create the refresh_charts_en.js script in appserver\static with following content:

require(['jquery', 'splunkjs/mvc/simplexml/ready!','splunkjs/mvc','splunkjs/mvc/utils','splunkjs/mvc/tokenutils'], function($) {
require(['splunkjs/ready!'], function(mvc,utils,TokenUtils){

    var defaultTokenModel = mvc.Components.get("default");


    var tokenValue = defaultTokenModel.get("refreshPeriod");

    if(tokenValue==0){
        ref = setInterval(showDashboard, 1000); 
        clearInterval(ref); 
    }else{
        var intervalOnLoad = tokenValue * 60 * 1000;    
        ref = setInterval(showDashboard, intervalOnLoad); 
    }
    defaultTokenModel.on("change:refreshPeriod", function(newIndexName, indexName, options) {

    var interval = indexName * 60 * 1000;    
    clearInterval(ref);    
    if (interval > 0) {
        ref = setInterval(showDashboard, interval)     
    }});


    function showDashboard() {          
        var list = document.getElementsByClassName("refresh-button");
        for (var i = 0; i < list.length; i++) {
            doScaledTimeout(list[i],i);  
        }
    }

    function doScaledTimeout(listofI,i) {
            setTimeout(function() {                             
                listofI.click();
            }, (i+1) * 30);
        }


    });
})

function getURLParameter(name) {
    return decodeURIComponent((new RegExp('[?|&]' + name + '=' + '([^&;]+?)(&|#|;|$)').exec(location.search)||[,""])[1].replace(/\+/g, '%20'))||null
}
;

This iterates through all refresh buttons on your grapghs and clicks them.

Kind regards, and I hope this works well for you,
David Lisin

Re: how to refresh the panel not entire dashboard

tred23 — Wed, 21 Dec 2016 12:56:24 GMT

The <option name="refresh.auto.interval">XYZ</option> worked for me when setting refresh rates on individual panels.

Re: how to refresh the panel not entire dashboard

cesaccenturefed — Wed, 21 Dec 2016 15:46:54 GMT

I just wanted to let you know this panel javasript solution worked great for my panel refresh issue! thanks I upvoted this I wish I could mark it as the answer.

Re: how to refresh the panel not entire dashboard

cesaccenturefed — Wed, 21 Dec 2016 15:47:45 GMT

Solution was awesome. Thanks David.

Re: how to refresh the panel not entire dashboard

mstadler_splunk — Tue, 31 Oct 2017 14:45:59 GMT

It does work for me with the new 'refresh' tag:

Setting the interval with an input:

    <input type="radio" token="refresh_interval" searchWhenChanged="true">
      <label>Panel Refresh</label>
      <choice value="24h">no refresh</choice>
      <choice value="1m">1 Minute</choice>
      <choice value="5m">5 Minutes</choice>
      <default>1m</default>
      <initialValue>1m</initialValue>
    </input>

And then setting this inside the

    <refresh>$refresh_interval$</refresh>

Re: how to refresh the panel not entire dashboard

samcogheil — Fri, 08 Jun 2018 18:38:37 GMT

refresh.auto.interval is now deprecated, but you can use 'refresh' within the Search block. i.e.

<search>
  <query>...
  </query>
  <earliest>-1m</earliest>
  <latest>now</latest>
  <refresh>1m</refresh>
</search>

Re: how to refresh the panel not entire dashboard

romanwaldecker — Sat, 16 Feb 2019 22:56:48 GMT

@samcogheil - Thanks a lot for the update!
Could you turn your comment into a separate answer so that we can upvote it as the new right answer to the original question?
That way others will find your solution faster! 🙂

Re: how to refresh the panel not entire dashboard

worshamn — Tue, 15 Oct 2019 18:15:27 GMT

I wanted to add a new solution to this as the option refresh.auto.interval is now deprecated. There is now a child element of refresh (https://docs.splunk.com/Documentation/Splunk/latest/Viz/PanelreferenceforSimplifiedXML#search) to do this sort of thing. However I needed (and saw other questions) asking for a refresh button (large and obvious to end user) to refresh a single panel, I have found a way to do this with Simple XML with a single option link list input and some token management. The form.refresh is unset using the progress child element so the user can refresh over and over. Below is an example dashboard of how to do so:

<form>
  <label>Refresh Panel Test</label>
  <fieldset submitButton="false"></fieldset>
  <row>
    <panel>
      <input type="link" token="refresh">
        <label></label>
        <choice value="Yes">Refresh?</choice>
        <change>
          <condition value="Yes">
            <set token="refresh_delay">1</set>
          </condition>
        </change>
      </input>
      <table>
        <search>
          <progress>
            <unset token="refresh_delay"></unset>
            <unset token="form.refresh"></unset>
          </progress>
          <query>| tstats count where index=_internal by source host
| sort -count</query>
          <earliest>-60m@m</earliest>
          <latest>now</latest>
          <refresh>$refresh_delay$</refresh>
          <refreshType>delay</refreshType>
        </search>
        <option name="drilldown">none</option>
        <option name="refresh.display">progressbar</option>
      </table>
    </panel>
  </row>
</form>

One problem with the link list input is it makes a gigantic empty space, that isn't terribly effiecient or obvious:

By adding an id to the input and some css this can be fixed like so (dashboard with stylesheet and id):

<form stylesheet="slim_input.css">
  <label>Refresh Panel Test</label>
  <fieldset submitButton="false"></fieldset>
  <row>
    <panel>
      <input type="link" token="refresh" id="slim_input>
        <label></label>
        <choice value="Yes">Refresh?</choice>
        <change>
          <condition value="Yes">
            <set token="refresh_delay">1</set>
          </condition>
        </change>
      </input>
      <table>
        <search>
          <progress>
            <unset token="refresh_delay"></unset>
            <unset token="form.refresh"></unset>
          </progress>
          <query>| tstats count where index=_internal by source host
| sort -count</query>
          <earliest>-60m@m</earliest>
          <latest>now</latest>
          <refresh>$refresh_delay$</refresh>
          <refreshType>delay</refreshType>
        </search>
        <option name="drilldown">none</option>
        <option name="refresh.display">progressbar</option>
      </table>
    </panel>
  </row>
</form>

Then the slim_input.css file:

#slim_input {
    display: inline-flex;
}

#slim_input button {
    background-color: #4608A5;
    color: #fff
}

#slim_input label, #slim_input .splunk-choice-input-message{
    display: none;
}

Now we get a nice purple button that refreshes the given panel: