Diagnostics and reports
TDXCollab is in beta, and most of what we fix we learn from sessions we were not in. This page says what TDXCollab can send us, when, and what it never sends. All of it goes only to the hosted TDXCollab relay, and only when the relay says it takes it: never through a relay of your own, never over TCP/IP.
Problem signatures (anonymous, on by default)
When TDXCollab finds a problem in a room on the TDXCollab relay (copies that drift apart, an error while applying a partner's message, a message the relay had to drop), it sends a short, anonymous note, a signature:
- the kind of problem, how many operators, which kind of change, operator types;
- the TDXCollab, TouchDesigner and system versions.
Never operator, network or custom parameter names (they travel as hashes that change every run), values, expressions, comments, DAT text, your name, the room, or what you made.
You are asked about it once, the first time you join a room (OK, or Turn Off), and nothing is sent
before you answer. Send Diagnostics on the More page switches it any time. The choice is
kept for you in ~/.tdxcollab/diagnostics.json, not in the project, so it holds in every project.
Report a Problem (by hand)
Report a Problem, on the More page or the chip's right-click, sends more, and only when you press Send:
- your note, the versions, the room code and the Status;
- which operators and parameters differ, with names and values;
- TDXCollab's settings that are switches, menus or numbers (never Room Secret, Member Token, your Display Name or an address);
- the last events TDXCollab saw or logged: message names, warnings, errors, never a message's contents.
Show Report opens exactly what Send sends, a file in logs/ taken when the dialog opened.
Cancel deletes it. Where the relay takes no reports, that file is the report: send it to us by hand.
Add Note to Last Report adds up to 500 characters to the report you sent last.
Beta testers
Switch on Beta Tester (More page) to help more. It shows the beta terms in a dialog (Decline, No Tag, Accept) with nothing to type. Accepted:
- Log Session stays on, and your reports carry the end of your session log (at most 32 KB: operator names, parameter values, file paths, the names of everyone in the session). Only while everyone in the session is a beta tester, and only the part after the last moment someone who was not had left; the dialog says when no log is attached, and why.
- Auto Report (on when you accept): when TDXCollab finds a problem, it sends a report by itself
a moment later. At most one every 2 minutes and ten a run, only while everyone in the session is a
tester. A copy of exactly what was sent is saved in
logs/, and the status bar says so. Switch it off and report by hand. - The copies-differ pop-up gets a third button, Report.
- Tester Tag: the name your reports carry, so we can ask you about one and delete yours on
request. The dialog offers one made from your Display Name (
Dan-3f9a); No Tag accepts with none. Edit or empty it any time. A signature never carries it.
Like Send Diagnostics, all of this is kept for you in ~/.tdxcollab/diagnostics.json: a project
saved with Beta Tester on starts with it off for someone who has not accepted the terms on their
computer.
Where it goes, and for how long
The relay stores each report and signature in a database only Function Store can read, with no user id or IP address beside it. Reports are deleted after 7 days, anonymous signatures after 90. The privacy page and the beta terms are the authority on what is kept and how to have yours deleted.