What is Scout?
Scout is an exploratory testing tool that interacts with Tableau's Server or Desktop product in order to capture performance metrics for specific User actions across a set of workbooks. Since Scout executes user actions on any content it's also used for User Acceptance Testing, for basic validation.
When to use Scout?
Scout supports two main scenarios: performance and user acceptance testing
- Help you find slow workbooks on the server
- Can validate performance improvements or regressions after making configuration\topology changes
User acceptance testing
- Can validate workbooks and dashboards are loading properly after upgrading to a new Tableau server
- Can validate that workbooks are still working properly after data source changes
Where to get more info about Scout?
Here is a basic overview of Scout: Scout - Getting started - YouTube
How can I get started?
First copy the attached Scout zip file to your hardrive. Then unzip the archive in a folder (let's call it Scout).
Next you have the option to execute Scout as a UI tool or execute it as a command line. We suggest people to run Scout from the UI at the beginning to get used to the options and the results of runs.
If you choose to run Scout as an UI tool Here are all the options from the UI that you could change to affect the way Scout runs: Executing Scout runs from the UI
If you want to run Scout from the command line you need to start Java and point the classpath to the location of the Scout jar file (bin), and the java dependencies (libs). You would also need to make just the JNA used by Java is the one provided by Scout and not the default JNI. Another parameter to be set for Java is the folder for the native library, which should point to the dependencies folder.
Here is an example of a command to execute Scout:
java -Djna.nosys=true -Djava.library.path=.;.\dependencies -cp bin\*;libs\* com.tableausoftware.test.tools.scout.ScoutRunner <Scout arguments>
You can find more information about execution Scout from the command line and all the arguments supported by Scout here: Running Scout from the command line or scheduled
What are the requirements for Scout?
Scout has a very few requirements:
- A Windows machine (Scout currently runs on Windows only)
- A supported version of Tableau Server. For now, Tableau Server > 10.0 is supported
- Java 64 bit JVM
- Latest version of Chrome
- Tableau server should be enabled to collect Web Client Metrics
- Follow the steps for getting to run tabadmin
- Execute the following commands
- tabadmin set vizqlserver.client_metrics_enabled true
- tabadmin set vizqlserver.client_metrics_filter core
- tabadmin configure
- tabadmin restart
This should be all!!!
How can I investigate the Scout results
You can use the default viz, shipped with Scout to look at the Scout results, to see the slowest workbooks, errors, ...
Or you could just use the results.csv file to make your own visualizations to see and understand your data
Here is more information about the format of the Scout results data: The Scout results files
Is Scout supported?
Scout is made available AS-IS with no support. This is intended to be a self-service tool and includes several training videos and an installation guide. Please review those fully to get the most out of Scout.
That being said we will be actively looking at issues discovered by users and try to respond and resolve them.
What if I find an issue or have feedback?
If you want to stay informed and get updates, please watch this project page for updates or follow us on twitter @tableau, @ionutg, @sanosuman and @thedavesmolin
Scout is subject to the MIT license set forth below. Portions of Scout may be licensed under additional or different open source licenses, as set forth in the Scout dependencies list. To the extent required by the license that accompanies the open source software, the terms of such license will apply in lieu of the terms of the MIT license with respect to such open source software, including, without limitation, any provisions governing access to source code, modification or reverse engineering.
Copyright © 2017 Tableau Software, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.