We’ve extended Inspire Early Bird Pricing until March 1. Register now and enjoy 20% off conference passes and 10% off training passes. P.S. Don’t forget to bring friends! When you sign up for five or more tickets, you get an extra 20% discount on conference passes. Learn more now.

Engine Works

Under the hood of Alteryx: tips, tricks and how-tos.
pmaier1971
Alteryx
Alteryx

Workflow governance is a big topic for our users, and we recently published a list of best practices. Exact governance requirements may vary by industry, sector and use case, but one general point is that when considering how to manage and govern analytic workflows, it is helpful to distinguish managing workflows on users’ desktop vs. execution of workflows on Alteryx Server.

 

  • Alteryx Server can show which workflows users are running (and at what frequency), and when set up to accommodate different environments (say, a pilot vs. production environment), rules can be put in place to ensure best practices are followed for production analytics. Alteryx server also provides great built-in versioning features.

 

  • Alteryx Designer is great for building and executing workflows on users’ desktops. That said, because it is a desktop tool, Compliance or IT partners may be concerned about users accessing sensitive data or running workflows for business-critical processes without following a peer review process.

 

Customer-managed telemetry fills some of the governance gaps for desktop users. In this post, we discuss what customer-managed telemetry is, how to turn it on, and how to deploy it. Subsequent posts will highlight analyzing the gathered information.

 

Screen Shot 2023-02-21 at 12.06.03 PM.png

  

What Is Customer-Managed Telemetry?

 

When enabled, customer-managed telemetry writes a log file into a directory every time a user runs any workflow on their desktop. This capability was added in Alteryx Designer 2021.4. The resulting log files exported by Customer Managed Telemetry are not sent to Alteryx or consumed by Alteryx in any way. The log file contains metadata about the workflow – such as user ID, machine ID, and time stamp – and saves the entire workflow in Extensible Markup Language (XML).

 

Customers can view all workflow-included tools and how they were configured. As explained below, the directory can be on a shared network drive, making log file parsing easier.

 

Why Use Customer-Managed Telemetry?

 

Imagine the following situations:

 

  • For heavily regulated processes, compliance partners may want reassurance that all business-critical workflows are executed in a controlled, isolated way on an Alteryx production server. Customer-managed telemetry documents workflow execution on the desktop, as well as the frequency with which each workflow is run. This enables the detection of whether a user is running a production workflow on the desktop, which could signal that the workflow has not been independently reviewed.

 

  • Workflow developers pull data from a soon-to-be discontinued SharePoint site. How would you identify not just all users of the site but also all workflows? Customer-managed telemetry can provide Impact Analysis: because it stores the entire workflow, you can view all data connections in the workflow. Leveraging this data, it is easy to identify not just every user of the SharePoint site but even every workflow accessing the site.

 

  • Within heavily regulated processes, additional use cases can involve checking if someone routinely runs workflows using data stored on their desktop (which may not be a recommended data source) – or if a user suddenly attempts to access confidential data to which he or she should not have access.

 

  • Two teams perform similar tasks, one more efficiently than the other. Leveraging insights from customer-managed telemetry, you could identify training or best practice opportunities and deploy a customized curriculum educating users about specific tools.

 

  • Most transformation or process-improvement projects involve gathering an inventory of data connections, users, and tools or workflows used. This information collection can be accomplished by parsing the log files. Hence, customer-managed telemetry can be an invaluable tool for managing teams and improving processes.

 

MeganDibble_0-1677005677018.png

 

How Do I Turn on Customer-Managed Telemetry?

 

Here are the steps to turn on Customer-managed telemetry:

  1. From the “Start” menu, right-click to open an editor like NotePad and choose “Run As Admin” (the option may be under the “more” selection)
  2. Open the RuntimeSettings.xml file in that editor. By default, the location of this file is:
    1. Admin Version: %ProgramFiles%\Alteryx\bin\RuntimeData
    2. Non-Admin Version: %LocalAppData%\Alteryx\bin\RuntimeData
  3.  Scroll to the bottom, and before the </SystemSettings> tag, add the following code:

 

 

<Telemetry>

<EnableCustomerManagedTelemetry>C:\ProgramData\Alteryx\Engine\Logs</EnableCustomerManagedTelemetry>

</Telemetry>

 

 

  1. Save the file, and reboot the machine. From now on, every time a workflow is executed, a new log file will be created.

Screen Shot 2023-02-21 at 12.07.41 PM.png

 

In addition to the full workflow details, the log files store the following metadata:

 

XML Tag

Description

TimeStamp

Timestamp that identifies when the workflow was executed. Timestamp is in UTC with this format: yyyy-MM-dd'T'HH:mm:ss'Z'.

UserEmail

The user email submitted at time of product activation.

MachineName

The machine hostname.

AlteryxGlobalUID

Unique Run ID.

WorkflowFilePath

Fully qualified path for the file that was run.

LicenseKey

License key used to activate the product.

 

A few comments on the file location:

 

  • You can deploy Customer Managed Telemetry by editing administrator files as part of an Alteryx install.
  • Alteryx does not recommend storing files locally. If files are stored locally, a separate process will need to be created to harvest the data into a central location. For most customers, likely a better solution is to create a central repository, possibly with a subfolder for each user with appropriate permissions to ensure data privacy.
  • Second, to store the log file, the machine needs access to the drive, as the file will not be created if the drive is unavailable. Such a situation may arise e.g. when users are traveling. In that case, it may be useful to specify a cloud directory. This way, the file is copied over once the user connects again to the network.

 

What Should I Consider?

 

First, turning on this feature might subject administrators to obligations under local privacy laws, such as the responsibility to disclose the collection of personal data.

 

Second, for large Enterprises, careful upfront planning is needed to identify which information is needed and how long it should be stored. If the user base is large, log files accumulate fast, and processing the information could become complex.

 

Alteryx recommends distinguishing alerts from reporting cadence, i.e. information needed on a periodic basis. For instance, it may be useful to scan logs and send an alert if a malicious user accesses confidential data. In contrast, information on which Alteryx versions are being used or comparing tool usage across teams to identify training opportunities would likely rely on longer data collection periods, compiled less frequently.

 

For scheduled data gathering, Alteryx recommends mocking up a report or dashboard to identify and refine how the data will be used. This determines what information should be extracted from log files and how long data must be stored. A sample dashboard is below:

 

Customer Managed Telemetry (1).png

 

What’s Next?

 

In this post, we scratched the surface of how powerful Customer-managed telemetry can be in filling governance gaps and how to turn it on. Future blog posts will detail how to process and parse the information gathered from customer-managed telemetry and build sample Alteryx workflows to process the information available in a Starter Kit.

 

For complex IT environments, additional configuration may be needed, and a working session with Alteryx Professional Services (servicesops@alteryx.com) could be helpful.

 

A new Enterprise Utility that features Customer Managed Telemetry is now available. This utility lets you process the telemetry data you've collected using this new telemetry feature in Designer into usable data. The utility also includes 2 sample dashboards that automatically populate with your data to streamline your journey to insight.

 

To download this utility, go to the Alteryx Marketplace. In the search box type "Enterprise Starter Kit" and select "Customer-Managed Telemetry."

Comments
AbhilashR
15 - Aurora
15 - Aurora

Great post!

bkclaw113
9 - Comet

IT does not matter if you have 10 users or 10k, you should have your Customer Managed Telemetry turned on and routed to a central location. Alteryx is a power tool, but like any tool it can be used in an appropriate fashion or not and CMT is the best way of monitoring this for your Desktop Designer user base and making sure that you are protecting your firm and also ensuring the continued adoption of Alteryx. Regardless if you spend the time to build out your own process to aggregate and scan these log files or use something like WAM from Capitalize Analytics you should be doing this.

 

You need to ask yourself do you want to be explaining why an Alteryx desktop users was sending client A details that should only be seen by client B after client A calls your CEO and is asking who we are sending her data to if they are getting data about client B, or do you want to be the person telling your CEO about the controls that you have in place that identified the desktop use of the email tool too external addresses the first day that it was run and who was able to proactively recall the message and save the day. I know which I want to be which is why I make sure all of my clients understand Customer Managed Telemetry is the backbone of your Alteryx Designer Control strategy.

fmvizcaino
17 - Castor
17 - Castor

Great post, @pmaier1971 !

 

The RuntimeSettings file is in a different place. The ProgramData folder has the file but the one being used is located in a different folder.

 

Tbh, I don`t know the difference between the 2 files but it only works when changing the ones from the following places:

  • Admin Version: %ProgramFiles%\Alteryx\bin\RuntimeData
  • Non-Admin Version: %LocalAppData%\Alteryx\bin\RuntimeData
pmaier1971
Alteryx
Alteryx

@fmvizcaino: You are correct. Let me fix in the post.

Michael_McKee
Alteryx Alumni (Retired)

Is there a way of automating the install with Telemetry configured so it could be pushed out?

bkclaw113
9 - Comet

@Michael_McKee  it really depends on how your organization deploys Alteryx. If you allow users to download and update themselves then unfortunately no. I have put in a request with the update team that as part of the update process they look to at least carry forward the Telemetry settings from the RuntimeSettings.XML file but it does not seem like that is going to happen anytime soon.

If your organization controls updates to designer centrally by packaging in something like software center then your IT team that creates the package can include the telemetry so that it is pushed out.

The final option is to  have you central IT push out something like a 'hot fix' that runs on the uses computers to update the setting for all users.

briannet
6 - Meteoroid

Please confirm this functionality is still limited to desktop. Is there a way we can get similar information from workflows run through the server?

TimN
13 - Pulsar

Awesome!

bkclaw113
9 - Comet

@briannet  Workflow Admin Manager (WAM) is the best way to manager your Alteryx Server environment including the ability to understood who is running what, what data sources are being utilized across workflows, and parsing out the details of individual workflows. Check out https://capitalizeconsulting.com/workflow-admin-manager/ for more information.

lucasquintieri98
8 - Asteroid

Hello guys!

I am having some issues regarding the installation of CMT, and I've created this forum: Alteryx Customer-Managed Telemetry installation is... - Alteryx Community

If any of you can take a look, maybe you could help me... 
It would be really appreciated.


EdP
Alteryx
Alteryx