What your install reports to Marshal

Every install sends Marshal a small report of counts: licensed users, peak deputy concurrency and launches that waited on the limit. Nothing in it identifies a person. This page lists every field, so you can check the report against your own policy.

You can read the last report your install sent, field by field, on the Licensing page under Reported to Marshal. See Licensing.

What never leaves your cluster

• People’s names, emails and user IDs. The list of licensed users stays on the Licensing page and in your CSV export.
• Your prompts, code, files, credentials and run output.

Two pieces of text that your people write do leave, and they are the only free text in a report:

1. Org names. Each report names the orgs it has numbers for, so Marshal can show them next to their figures. A name is cut to 200 characters and stripped of control characters.
2. The capacity request message. When an admin sends Request more capacity with a message, up to 500 characters travel to Marshal. The form says so beside the message box.

Every other text field comes from a fixed list or is an identifier.

When and how it is sent

• Your install sends a report every hour by default. The first goes out a few minutes after the install starts.
• Each report carries the running totals for the current day and month, plus any earlier day Marshal has not confirmed. An install that was offline catches up on its next report, and nothing counts twice.
• The report is sent with the install’s own identity token, the same identity it uses to refresh its license. Marshal rejects a report that does not authenticate as the install it names.
• Reporting is on whenever your install refreshes its license online. It has no separate switch. An install that runs offline on an uploaded license sends no reports.
• The Licensing page shows Last report to Marshal with the date of the last successful report.

The report

A report holds up to 2,000 values, 500 orgs and 20 events, and is at most 256 KiB.

Numbers

Each entry in values has the metric name, its period (day or month, in UTC), the date the period starts, the org it belongs to (or the whole install) and the value.

• licensed_users is the number of distinct people who ran a space or started a run that month. See what counts as a licensed user.
• deputy_concurrency_max is the most deputy runs in flight at once that day.
• deputy_concurrency_limit is the install-wide limit in force that day. 0 means unlimited.
• throttle_queued is how many launches waited because of the install concurrency limit.
• throttle_wait_seconds_total and throttle_wait_seconds_max are the total and the longest wait of those launches, in seconds.

A figure only goes up within its period, except the limit, which takes the latest value. A resent report never lowers a count.

Capacity request events

An entry in events has the type capacity_request and these fields:

See the exact last report

Open Dashboards, then Licensing, then Reported to Marshal.

• An org admin sees the schema and chart versions, the send time, their own org’s name and numbers, the install totals and their org’s capacity requests.
• The owner of the install’s first organization sees the whole report, including the install fingerprint and every org.

The Telemetry toggle under Settings is a separate setting for product and error analytics. It has no effect on this report.

For operators

Two Helm values under license control where and how often reports go:

Related

• Licensing
• Admin dashboards
• Configuration reference