<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/c8c60d18-5674-4f40-88c7-1aad6ee8891b/alert.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/c8c60d18-5674-4f40-88c7-1aad6ee8891b/alert.png" width="40px" /> pyRevit does not collect your data. All your telemetry data is private to you. Telemetry system is optional and is designed to be used internally inside your ogranization.

</aside>

What is the Telemetry System

The telemetry system allows you to quickly setup a server and listen to reports being sent from all pyRevit instances being used on all your machines and by your users. It's a feature that benefits you if you are managing and using pyRevit for your team or company.

There are two types of reports being sent by pyRevit

• Script Execution Reports Every time a user clicks on a pyRevit tool (or your custom pyRevit tools), the telemetry system will send a report to the server with information about the tool, the environment, and the results. This includes any error messages generated by the engine, alongside any custom data sent by the script.
• Application Event Reports Revit has a built-in event system. pyRevit can be configured to listed to these events, generate a report based on the arguments passed to that event, and submit these records to the server. An example would be listening to the "Document Opened" event and sending a report with information about the opened document to the server.
  • Custom Application Events pyRevit also provides its own events that can send telemetry data.

Get Started

To get up and running with the Telemetry Server

1. Pick a machine or cloud service as your database server. This database stores all the telemetry data.
2. Pick a machine as your telemetry server, and run the telemetry server binary on this machine, pointing it to the database.
3. Configure installed pyRevit instances to send data to this server
4. Consider modifying your own pyRevit tools to send more relevant data to the server, so you can maximise the benefits

Starting Telemetry Server

pyRevit ships with a telemetry server. The server is a single executive, is written in Go, and the compiled binary (bin/pyrevit-telemetryserver.exe) has no dependencies. To use the server you need to setup a database first. The server writes all the Revit events and pyRevit script telemetry data to this database. You can use different databases for events and script telemetry, by launching more than once instance of this server on different ports. See below for instructions on configuring the your databases. See Telemetry Server REST API to learn more about the telemetry API

Preparing the Server

Copy the bin/pyrevit-telemetryserver.exe to your host machine. The host machine is the machine that runs the pyRevit telemetry server. This machine needs to be visible to other machines running pyRevit instances. The shipped version is compiled for x64 Windows. However, you can download Go and compile the telemetry server, from source code, for other operating systems. The source code is under dev/pyRevitTelemetryServer in pyRevit code base.

↓ Follow the guide below to build the server for other operating systems

Building Telemetry Server