Splunk Cloud Platform

Splunk Dashboard Studio

Acrobat logo Download manual as PDF


This documentation does not apply to the most recent version of SplunkCloud. Click here for the latest version.
Acrobat logo Download topic as PDF

Share data with Splunk Enterprise and the Splunk Dashboard Studio

For users of the Splunk Dashboard Studio for Enterprise, the Splunk platform sends anonymized usage data to Splunk Inc. ("Splunk") to help improve the Splunk Dashboard Studio in future releases. For information about how to opt in or out and how the data is collected, stored, and governed, see Share data in Splunk Enterprise.

What data is collected

The Splunk Dashboards app collects the following basic usage information:

Component Description Example
app.session.udf.telemetry General telemetry collected on visualization usage and settings.
{
    "component": "app.session.udf.telemetry",
    "data": {
        "pageAction": "dashboard.initialize",
        "metadata": {},
        "udfVersion": "20.3.1",
        "definition": {
            "visualizations": {
                "viz_2aae822a03cb3f7c58a43c04652ee908": {
                    "type": "viz.column",
                    "options": {},
                    "titleLength": 13,
                    "descriptionLength": 26
                },
                "viz_3a1a36fecbc0b5b46b5cb8777756ea6c": {
                    "type": "viz.singlevalueicon",
                    "options": {
                        "showValue": false,
                        "icon": true
                    }
                },
                "viz_cf5bd9532cfe6d8619132f9bb11cefd5": {
                    "type": "viz.rectangle"
                },
                "viz_36b6e66b1475b0e0677676b947f1d884": {
                    "type": "viz.singlevalue",
                    "options": {},
                    "titleLength": 13,
                    "descriptionLength": 24
                },
                "viz_f3479a853843e0e72405cc99fc9fc810": {
                    "type": "viz.text",
                    "options": {
                        "content": true
                    }
                }
            },
            "inputs": {},
            "layout": {
                "globalInputs": [],
                "type": "absolute",
                "options": {},
                "structure": [
                    {
                        "item": "viz_2aae822a03cb3f7c58a43c04652ee908",
                        "type": "block",
                        "position": {
                            "x": 0,
                            "y": 0,
                            "w": 300,
                            "h": 300
                        }
                    },
                    {
                        "item": "viz_3a1a36fecbc0b5b46b5cb8777756ea6c",
                        "type": "block",
                        "position": {
                            "x": 330,
                            "y": 0,
                            "w": 250,
                            "h": 250
                        }
                    },
                    {
                        "item": "viz_cf5bd9532cfe6d8619132f9bb11cefd5",
                        "type": "block",
                        "position": {
                            "x": 640,
                            "y": 40,
                            "w": 150,
                            "h": 160
                        }
                    },
                    {
                        "item": "viz_36b6e66b1475b0e0677676b947f1d884",
                        "type": "block",
                        "position": {
                            "x": 10,
                            "y": 340,
                            "w": 250,
                            "h": 250
                        }
                    },
                    {
                        "item": "viz_f3479a853843e0e72405cc99fc9fc810",
                        "type": "block",
                        "position": {
                            "x": 370,
                            "y": 270,
                            "w": 310,
                            "h": 60
                        }
                    }
                ]
            },
            "descriptionLength": 0,
            "titleLength": 44
        },
        "app": "splunk-dashboard-studio",
        "page": "_do_not_edit_delete_telemetryreviewdashboard"
    }
app.session.createNewDashboardDialog.interact General telemetry collected when a new dashboard is created.
{
        "component": "app.session.createNewDashboardDialog.interact",
        "data": {
            "action": "createNewDashboard",
            "editId": true,
            "hasDescription": false,
            "dashboardType": "udf",
            "layout": "absolute",
            "sharing": "user",
            "status": "success",
            "app": "search",
            "page": "dashboards"
        },
    }
app.session.dashboard.load Triggered when a dashboard is loaded.
{
"component": "app.session.dashboard.load"
   "data": { [-]
     "app": search
     dashboard: { [-]
       autoRun: false
       hideAppBar: false
       hideChrome: false
       hideEdit: false
       hideExport: false
       hideFilters: false
       hideSplunkBar: false
       hideTitle: false
       isScheduled: false
       isVisible: true
       numCustomCss: 0
       numCustomJs: 0
       refresh: 0
       submitButton: false
       theme: light
     }
     elementTypeCounts: { [-]
       statistics: 1
     }
     formInputTypeCounts: { [-]
     }
     layoutType: row-column-layout
     numElements: 1
     numFormInputs: 0
     numPanels: 1
     numPrebuiltPanels: 0
     numSearches: 1
     page: splunker
     searchTypeCounts: { [-]
       saved: 1
     },
    enableRiskyCommandCheckDashboard: true
   }
}
"pageAction": "scheduledExport.save" Scheduled export successfully created.
{
type: "dashboard.telemetry"
    data: {
        pageAction: "scheduledExport.save",
        success: true,
        enabledInitially: false,
        enabledAtSave: true,
        cronSchedule: "0 18 * * *",
        emailCountTo: 1,
        emailCountCC: 0,
        emailCountBCC: 0,
        emailSubjectLength: 22,
        emailMessageLength: 17,
        includeLinkInitially: false,
        includeLinkAtSave: false
    }
}
"pageAction": "performance.startTimer" Performance time to render visualizations.
{
"component": "app.session.udf.telemetry",
"data": {
     "pageAction": "performance.startTimer",
     "metadata": {
            "timerId": "Visualization - input - ab268181536746432d1ba55ed554c677c90014ed5b8e8714f68dd51a07f08c69 - Time to Interactive",
            "sourceElement": 'TimeRangePicker',
            "heroElement": "Visualization - input - ab268181536746432d1ba55ed554c677c90014ed5b8e8714f68dd51a07f08c69 - Time to Interactive",
            "currentTime": 1279352,
            "markInformation": "Visualization - input - ab268181536746432d1ba55ed554c677c90014ed5b8e8714f68dd51a07f08c69 - Time to Interactive"
        },
       "udfVersion": "23.0.0",
       "source": "TimeRangePicker",
       "app": "search",
       "page": "telemetry_testing"
    },
}
"pageAction": "riskyWarningDialog.open" Warning dialogue opens and describes a risky command in the query.
{
    "component": "app.session.udf.telemetry",
    "data": {
        "pageAction": "riskyWarningDialog.open",
        "metadata": {
            "type": "input"
        },
        "udfVersion": "22.4.0",
        "source": "riskyWarningDialog",
        "app": "search",
        "page": "telemetry_testing"
    },
}
"pageAction": "riskyWarningDialog.cancel" Warning dialogue confirming cancelation of a query with a risky command.
{
"component": "app.session.udf.telemetry",
    "data": {
        "pageAction": "riskyWarningDialog.cancel",
        "metadata": {
            "type": "visualization"
        },
        "udfVersion": "22.4.0",
        "source": "riskyWarningDialog",
        "app": "search",
        "page": "telemetry_testing"
    },
}
"pageAction": "riskyWarningDialog.runSearch" Warning dialogue confirming the action to perform a query with a risky command.
{
"component": "app.session.udf.telemetry",
    "data": {
        "pageAction": "riskyWarningDialog.runSearch",
        "metadata": {
            "type": "input"
        },
        "udfVersion": "22.4.0",
        "source": "riskyWarningDialog",
        "app": "search",
        "page": "telemetry_testing"
    },
}
Last modified on 17 March, 2022
PREVIOUS
Migrate your dashboards and delete the Splunk Dashboards app (beta)
  NEXT
About the Splunk Dashboard Studio tutorial

This documentation applies to the following versions of Splunk Cloud Platform: 8.2.2109, 8.2.2111, 8.2.2112


Was this documentation topic helpful?


You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters