Solved: How to allow dashboard users to turn off auto-refr...

brajaram · ‎05-31-2018

I have a dashboard that looks at the last 15 minutes, and refreshes every 2 minutes.

<form refresh="120> in the dashboard code.

However, I want a way for viewers of the dashboard to be able to turn off the refresh if they desire. How do I add an input to toggle the auto-refresh?

paramagurukarth · ‎06-01-2018

In refresh option splunk is not doing any data only refresh. They are doing simple page refresh.
You can achieve that functionality by using simple javascript.

<!-- Custom Refresh>
<form script="custom_refresh.js">
  <label>Test_Refresh</label>
  <row>
    <panel>
      <html>
        <input id="is_refresh_enabled" type="checkbox" checked="">Refresh</input>
      </html>
    </panel>
  </row>
  <row>
    <panel>
      <event>
        <search>
          <query>index="_internal" | head 10</query>
        </search>
        <option name="count">20</option>
        <option name="list.drilldown">none</option>
        <option name="list.wrap">1</option>
        <option name="maxLines">5</option>
        <option name="raw.drilldown">full</option>
        <option name="rowNumbers">0</option>
        <option name="table.drilldown">all</option>
        <option name="table.sortDirection">asc</option>
        <option name="table.wrap">1</option>
        <option name="type">list</option>
      </event>
    </panel>
  </row>
</form>

.

//custom_refresh.js
// Place this file inside /appserver/static/ folder of your application
require([
    "jquery",
    "splunkjs/mvc",
    "splunkjs/mvc/simplexml/ready!"
    ], function($, mvc){
    console.log("Test");
    setInterval(function(){
        if(document.getElementById("is_refresh_enabled").checked){
            window.location.reload();
        }         
    }, 10000);
});

Refer Javascript related tweaks here

View solution in original post

paramagurukarth · ‎06-01-2018

In refresh option splunk is not doing any data only refresh. They are doing simple page refresh.
You can achieve that functionality by using simple javascript.

<!-- Custom Refresh>
<form script="custom_refresh.js">
  <label>Test_Refresh</label>
  <row>
    <panel>
      <html>
        <input id="is_refresh_enabled" type="checkbox" checked="">Refresh</input>
      </html>
    </panel>
  </row>
  <row>
    <panel>
      <event>
        <search>
          <query>index="_internal" | head 10</query>
        </search>
        <option name="count">20</option>
        <option name="list.drilldown">none</option>
        <option name="list.wrap">1</option>
        <option name="maxLines">5</option>
        <option name="raw.drilldown">full</option>
        <option name="rowNumbers">0</option>
        <option name="table.drilldown">all</option>
        <option name="table.sortDirection">asc</option>
        <option name="table.wrap">1</option>
        <option name="type">list</option>
      </event>
    </panel>
  </row>
</form>

.

//custom_refresh.js
// Place this file inside /appserver/static/ folder of your application
require([
    "jquery",
    "splunkjs/mvc",
    "splunkjs/mvc/simplexml/ready!"
    ], function($, mvc){
    console.log("Test");
    setInterval(function(){
        if(document.getElementById("is_refresh_enabled").checked){
            window.location.reload();
        }         
    }, 10000);
});

Refer Javascript related tweaks here

nicolocervo · ‎03-10-2022

worked for me 👍

varun8159 · ‎05-31-2018

You would need some bit of Javascript code.

brajaram · ‎05-31-2018

Any idea as to where I should begin to do that?

ddrillic · ‎05-31-2018

@brajaram, please keep in mind that this auto-refresh can apply a heavy load on the environment.

We spoke a bit about it at - Does a dashboard keep refreshing itself by default?

    <form refresh="0">

is my favorite.

How to allow dashboard users to turn off auto-refresh?

Join the Splunk Community Slack to learn, troubleshoot, and make connections with fellow Splunk practitioners in real time!

Join Splunk User Groups to connect and learn in-person by region or remotely by topic or industry.

[Puzzles] Solve, Learn, Repeat: Matching cron expressions

Design, Compete, Win: Submit Your Best Splunk Dashboards for a .conf26 Pass

May 2026 Splunk Expert Sessions: Security & Observability

Join the Conversation