Dashboards & Visualizations
×

Are you a member of the Splunk Community?

Sign in or Register with your Splunk account to get your questions answered, access valuable resources and connect with experts!
cancel
Turn on suggestions
Auto-suggest helps you quickly narrow down your search results by suggesting possible matches as you type.
Showing results for 
Show  only  | Search instead for 
Did you mean: 
Ask a Question
Solved! Jump to solution

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

brajaram
Communicator
‎05-31-2018 12:09 PM

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?

Tags (2)
Reply
1 Solution
Solved! Jump to solution
Solution

paramagurukarth
Builder
‎06-01-2018 02:53 AM

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

Reply
Solved! Jump to solution
Solution

paramagurukarth
Builder
‎06-01-2018 02:53 AM

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

Reply
Solved! Jump to solution

nicolocervo
Engager
‎03-10-2022 07:20 AM

worked for me 👍

Reply
Solved! Jump to solution

varun8159
Explorer
‎05-31-2018 01:14 PM

You would need some bit of Javascript code.

0 Karma
Reply
Solved! Jump to solution

brajaram
Communicator
‎05-31-2018 04:11 PM

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

0 Karma
Reply
Solved! Jump to solution

ddrillic
Ultra Champion
‎05-31-2018 12:40 PM

@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.

0 Karma
Reply
Get Updates on the Splunk Community!

Building Reliable Asset and Identity Frameworks in Splunk ES

 Accurate asset and identity resolution is the backbone of security operations. Without it, alerts are ...

Cloud Monitoring Console - Unlocking Greater Visibility in SVC Usage Reporting

For Splunk Cloud customers, understanding and optimizing Splunk Virtual Compute (SVC) usage and resource ...

Automatic Discovery Part 3: Practical Use Cases

If you’ve enabled Automatic Discovery in your install of the Splunk Distribution of the OpenTelemetry ...