Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ export -s impact
- [ ] Batch project comparison features

## Usage reporting
Usage reporting is on by default: Parpt reports that it was used to the maintainers' [trace](https://github.com/Stephenson-Software/trace) service at `https://trace.danielstephenson.dev`, sending a `startup` event carrying its name and version once per run, and a `project-created` event carrying only the version when a project is saved. Nothing about your projects is sent: no project names, descriptions, scores or files, and no usernames, hostnames, IP addresses, paths or anything typed at the prompt. A one-line notice is printed the first time it runs on a machine (recorded in `~/.config/parpt/usage-reporting-notice-shown`).
Usage reporting is on by default: Parpt reports that it was used to the maintainers' [trace](https://danielstephenson.dev/usage-reporting) service at `https://trace.danielstephenson.dev`, sending a `startup` event carrying its name and version once per run, and a `project-created` event carrying only the version when a project is saved. Nothing about your projects is sent: no project names, descriptions, scores or files, and no usernames, hostnames, IP addresses, paths or anything typed at the prompt. A one-line notice is printed the first time it runs on a machine (recorded in `~/.config/parpt/usage-reporting-notice-shown`).

Every event also carries a random installation ID (the tag `install`), so installations can be counted rather than events. It is a random UUID written the first time reporting runs to `~/.config/parpt/trace-install-id`, next to the notice marker, and reused after that; it identifies no person, account or address. Delete the file to get a new one, or set `TRACE_INSTALL_ID` in the environment to pin one. Every opt-out below also stops it: when reporting is off, no ID is made up and the file is neither read nor written.

Expand All @@ -133,7 +133,7 @@ To turn it off, any one of these is enough:

The key under `usage-reporting.key` in `application.yaml` is the write key issued to Parpt; it can only add usage events and is not secret.

Details on what trace collects and why: https://github.com/Stephenson-Software/trace#usage-reporting
Details on what trace collects and why: https://danielstephenson.dev/usage-reporting

## Contributing
This project is in early development. Contributions, suggestions and issue reports are welcome!
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/com/preponderous/parpt/trace/TraceClient.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* trace-client 0.6.0 -- https://github.com/Stephenson-Software/trace-client-java
* trace-client 0.6.1 -- https://github.com/Stephenson-Software/trace-client-java
*
* One call to report that a program was used. Copy this file into a project as
* is, or depend on the artifact; either way there is nothing else to add.
Expand Down Expand Up @@ -124,7 +124,7 @@
public final class TraceClient {

/** This client's version, as sent in the User-Agent. */
public static final String VERSION = "0.6.0";
public static final String VERSION = "0.6.1";

/** How many reports may wait to be sent before new ones are dropped. */
public static final int QUEUE_CAPACITY = 256;
Expand Down Expand Up @@ -162,7 +162,7 @@ public final class TraceClient {
/** Exactly what a missing server-wide switch file is created with. */
static final String SERVER_WIDE_CONFIG_CONTENT =
"# Server-wide switch for usage reporting by plugins that report to trace\n"
+ "# (https://github.com/Stephenson-Software/trace#usage-reporting).\n"
+ "# (https://danielstephenson.dev/usage-reporting).\n"
+ "# Set enabled to false and every such plugin on this server stops reporting,\n"
+ "# regardless of its own usage-reporting.enabled setting. Plugins never turn\n"
+ "# this back on.\n"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public class UsageReporter {
static final String PROJECT_CREATED_EVENT = "project-created";
static final String NOTICE_MARKER_FILE = "usage-reporting-notice-shown";
/** The public page describing what trace collects and every way to turn it off. */
static final String DETAILS_URL = "https://github.com/Stephenson-Software/trace#usage-reporting";
static final String DETAILS_URL = "https://danielstephenson.dev/usage-reporting";
/** Sent as the version when not run from a built JAR. */
static final String UNKNOWN_VERSION = "unknown";

Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/application.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ app:
# -Dusage-reporting.enabled=false or USAGE_REPORTING_ENABLED=false, or with
# TRACE_USAGE_REPORTING=off / DO_NOT_TRACK=1 in the environment, which the client checks
# first. The key is the write key issued to Parpt; it can only add usage events and is not
# secret. Details: https://github.com/Stephenson-Software/trace#usage-reporting
# secret. Details: https://danielstephenson.dev/usage-reporting
usage-reporting:
enabled: true
endpoint: https://trace.danielstephenson.dev
Expand Down
Loading