Skip to content

Usage data and crash reports

Everything you review stays on your computer. To learn which features are used and to fix crashes, Pinrail sends anonymous usage data and crash reports to its own server. Both are on by default, and you can turn either off at any time in Settings › Privacy.

Nothing is recorded or sent until you have answered the notice about it. The notice appears at the top of the inbox the first time Pinrail starts.

Usage data is a list of events. Each event has a name, the time it happened, and a few fields that hold numbers, true or false, or names that Pinrail’s code fixes.

EventWhen it is recordedFields
app_startedPinrail starts, or you answer the notice the first timewhether it is the first start
review_decidedyou decide a reviewthe plugin, whether you approved it or asked for changes, the number of rounds, and how many seconds it waited
questions_answeredyou answer an agent’s questionsthe number of questions and of those left unanswered, and whether you sent the reply the agent suggested
review_discardedyou discard a reviewthe plugin
session_startedan agent reports its first status in a sessionthe agent
item_changeda work item is added, claimed, held, queued, done or cancelledthe change, and whether an agent made it
plugin_installeda plugin is installed, updated or removedthe plugin, whether it is an official plugin, and whether it was removed
feature_usedyou use a feature, counted once a day for eachthe feature, such as command_palette or page_items
cli_usedan agent or a script runs a pinrail command, counted once a day for each command and agentthe command, such as ask, and the agent

A plugin and an agent are sent by name when the name is at most 40 letters, digits, -, _ and ., and as other otherwise.

Every batch of events also carries the version of Pinrail, the operating system and its version, the processor architecture, and the release channel.

Usage data never contains review titles or payloads, decisions, notes, comments, questions or answers, work item titles or descriptions, file names or paths, repository or project names, session ids, what agents write, your user name, or your computer’s name.

When Pinrail crashes, or the app’s window has an error that nothing handled, Pinrail keeps a report of it in its data directory: where it happened, the error message and the stack trace. Before the report is written to disk, Pinrail removes what could identify you or your work. Each file path becomes its file name, and quoted text, web addresses, email addresses and anything that looks like a key or a token become ….

Pinrail sends the report the next time it starts, then deletes it. Only one report waits at a time, the first since the last one was sent.

  • An install id: 32 random characters that Pinrail creates the first time it records an event, and keeps in its data directory. Nothing ties it to you or to your computer. Turning usage data off deletes it, and turning it on again creates a new one. A crash report carries it only while usage data is on.
  • A session id: a new random id each time Pinrail starts, which groups the events of one run.

Pinrail sends the events in batches to api.pinrail.dev, every 5 minutes or as soon as 50 are waiting. A batch that cannot be sent is tried once more and then dropped. Quitting Pinrail never waits for a send.

The server does not store your IP address. It keeps events and crash reports for 13 months, and then deletes them. Pinrail does not share them with anyone.

Any of these turns it off:

  • In Settings › Privacy, turn off Send usage data, Send crash reports, or both.
  • Set the environment variable DO_NOT_TRACK or PINRAIL_TELEMETRY to any value before Pinrail starts. Both switches are then off, and Settings › Privacy says which variable turned them off.
  • Set telemetry.usage or telemetry.crashes to false in settings.json in the data directory. See Where settings are stored.

When usage data is off, nothing is recorded or sent, and the install id and the events that were waiting are deleted. When crash reports are off, no report is kept, and one that was waiting is deleted. Data that was already sent stays on the server until it is deleted after 13 months.

In Settings › Privacy, Show what is sent shows the install id, the events waiting to be sent, the last 100 sent, and the crash report waiting, if any, as JSON.

To watch the batches instead of sending them, start Pinrail with PINRAIL_TELEMETRY_DEBUG=1. Each batch is then printed to standard error and not sent.

Pinrail connects to the internet in two other cases:

  • Updates: while Check automatically is on, Pinrail looks for a new version on GitHub when it starts and every few hours. See About.
  • Send feedback: what you write in Send feedback, the files you attach, and the diagnostics unless you leave them out, are sent to our server only when you send them, with the version of Pinrail and of the operating system.