How to Configure Audit Logging in Tableau Server
Setting up audit logging in Tableau Server lets you track exactly how users interact with your dashboards and data sources. This guide walks you through the configuration process using the Tableau Services Manager (TSM) command-line interface, helps you understand where to find the logs, and shows you how to use this valuable data.
What Exactly is Audit Logging in Tableau Server?
Audit logging is the process of recording important events that happen on your Tableau Server. Think of it as a detailed security camera for your data environment. Whenever someone signs in, views a dashboard, publishes a new workbook, or changes permissions, Tableau makes a note of it. This isn't just about security, it gives you powerful insights into how your server is being used.
Unlike traditional applications that often write logs to a simple text file, Tableau Server records this audit information directly into its internal PostgreSQL database, known as the Tableau Server repository. This makes the data structured, queryable, and ready for analysis right from the get-go.
Why Should You Enable Audit Logging?
Tracking user activity isn't just for big corporations with strict compliance rules. It’s incredibly useful for any administrator looking to maintain a healthy, efficient, and secure server. Here are the main benefits:
- Security and Compliance: The most obvious reason. Audit logs help you monitor for suspicious activity, track access to sensitive data, and provide concrete evidence for compliance audits like HIPAA, SOX, or GDPR. You can see who accessed what, and when.
- User Adoption and Content Management: Find out which dashboards are runaway successes and which ones are gathering dust. With this info, you can focus training efforts, promote popular dashboards, and identify unused content that can be archived or deleted.
- Performance Monitoring: Identify dashboards or data sources that are consistently slow to load. Logs can show you event duration, helping you pinpoint assets that need optimization to improve the user experience.
- Troubleshooting: When a user reports an issue, like not being able to access a view they think they should see, audit logs can give you a step-by-step history of their interactions and permissions, making it easier to diagnose the problem.
Prerequisites for Configuration
Before you get started, make sure you have the following in place:
- Administrator Access: You need permission to log into the machine where Tableau Server is installed (either via Remote Desktop for Windows or SSH for Linux).
- TSM Command-Line Familiarity: The entire process is managed through the Tableau Services Manager (TSM) command-line tool. You should be comfortable opening a command prompt or terminal and running commands.
- Maintenance Window: Enabling auditing requires a full restart of the Tableau Server services. Plan to perform these steps during a scheduled maintenance window to avoid disrupting your users.
Step-by-Step: How to Configure Audit Logging in Tableau Server
The process is straightforward and only takes a few commands. The longest part is waiting for the server to restart once you apply the changes.
Step 1: Open a Command-Line Interface
First, you need to connect to your Tableau Server's primary node. For Windows Server, use the Remote Desktop client. For Linux, use an SSH client like PuTTY.
Once you are logged in, open PowerShell or Command Prompt as an Administrator on Windows, or a terminal session on Linux.
Step 2: Enable Audit Logging Using TSM
Audit logging is controlled by a single configuration key in TSM. To enable it, you'll use the tsm configuration set command. This command tells Tableau to start recording user-activity events.
Run the following command in your terminal:
tsm configuration set -k tsm.eventing.enabled -v trueAfter you run this, TSM will let you know that you've made a configuration change that requires a server restart to take effect.
Note: If you ever need to disable logging, you can run the same command but change the value to false.
Step 3: Apply the Pending Changes
The change you just made is now staged and waiting to be applied. You can see all pending changes by running tsm pending-changes list.
To apply your change and restart the server, run this command:
tsm pending-changes applyTSM will prompt you to confirm that you want to proceed, as this action will stop and then restart all Tableau Server services. Type y and press Enter to continue.
The process can take anywhere from 10 to 30 minutes, depending on the size and complexity of your server environment. You can follow the progress in the command-line output.
Step 4: Verify the Configuration
Once the services are back online and the command has finished, you should verify that your configuration was applied correctly. Run the following command to check the current value of the logging key:
tsm configuration get -k tsm.eventing.enabledThe output should show true, confirming that audit logging is now active.
How to Access and Analyze Your Audit Data
Now that logging is enabled, Tableau is busy recording events in its repository. There are two primary ways to access this valuable information: the easy way and the more flexible, powerful way.
Method 1: Use the Built-in Administrative Views
The easiest way to start using your audit data is through Tableau Server’s pre-built Administrative Views. Tableau has already done the work of querying the repository and visualizing the most common metrics for you.
To access them:
- Log into your Tableau Server UI as a Server Administrator.
- Navigate to the Status or Site Status page.
- Click on Server Activity Analysis or Site Activity Analysis.
Here you will find a dashboard with several helpful views, including:
- Traffic to Views: See which dashboards are visited most often and by whom.
- Traffic to Data Sources: Track the usage of published data sources.
- Actions by Users: Get a summary of all user activities like publishing, login events, and permission changes.
- Background Tasks for Extracts: Monitor the performance and success rate of your data extract refreshes.
Method 2: Connect Directly to the Tableau Server Repository
For more custom or detailed analysis, you can connect directly to the Tableau Server PostgreSQL repository and build your own dashboards. This gives you full control to explore all the recorded data.
Enabling Repository Access
For security, direct access to the repository is disabled by default. You need to enable it and set a password for the dedicated read-only user, named readonly.
In your TSM command line, run the following command:
tsm data-access repository-access enable --repository-username readonly --repository-password "YourSecurePasswordHere"Replace "YourSecurePasswordHere" with a strong, secure password of your choice. An apply-pending-changes is not required for this command, the change takes effect immediately.
Connecting with Tableau Desktop
With access enabled, you can now connect to the repository just like any other PostgreSQL database:
- Open Tableau Desktop.
- In the Connect pane, select PostgreSQL.
- Server: Enter the hostname or IP address of your Tableau Server.
- Port: The port is typically
8060. - Database: The database name is
workgroup. - Username: Enter
readonly. - Password: Enter the secure password you set in the previous step.
- Click Sign In.
Once connected, you will see a list of database tables. The historical event tables typically start with hist_ or _. For example, hist_views_stats contains detailed information about every view load, while _users contains a list of all users. Exploring these tables allows you to build completely custom administrative dashboards tailored to your organization’s needs.
Final Thoughts
Enabling audit logging in Tableau Server is a simple but powerful step toward better server management. A few TSM commands give you the visibility needed to enhance security, optimize performance, and understand how people are actually using the content you produce. You can start with the built-in Admin Views and graduate to direct repository access when your questions become more specific.
Effectively managing platforms like Tableau requires making sense of deep system data. In much the same way, marketing and sales teams need to understand performance across dozens of SaaS tools. At Graphed, we automate the tedious work of logging into each platform, connecting the dots in a spreadsheet, and explaining what the data means. By connecting your tools like Google Analytics, Shopify, and Salesforce, you can use plain English to build custom dashboards and ask questions, so your team gets instant answers instead of waiting all week for a report.
Related Articles
What SEO Tools Work with Google Analytics?
Discover which SEO tools integrate seamlessly with Google Analytics to provide a comprehensive view of your site's performance. Optimize your SEO strategy now!
Looker Studio vs Metabase: Which BI Tool Actually Fits Your Team?
Looker Studio and Metabase both help you turn raw data into dashboards, but they take completely different approaches. This guide breaks down where each tool fits, what they are good at, and which one matches your actual workflow.
How to Create a Photo Album in Meta Business Suite
How to create a photo album in Meta Business Suite — step-by-step guide to organizing Facebook and Instagram photos into albums for your business page.