Skip to content
Install

Manage anonymous usage reports

An Orchard instance can send anonymous usage reports to the Orchard team. The reports show which versions are in use, how large instances get, and which server errors happen in the field, so the team can find bugs that no one reports. Reports are off until a superadmin turns them on, or until an operator sets ORCHARD_TELEMETRY to true. This page lists every field that a report contains, so you can decide with the full picture.

The setting is separate from POSTHOG_API_KEY, which sends analytics to your own PostHog project.

Reports go to https://us.i.posthog.com. If you restrict outbound traffic, this is the host to allow. Only a server running with NODE_ENV=production sends reports. Orchard’s images set this value.

ReportWhen
Daily reportOne server pod, the leader, checks every hour and sends at most one report every 23 hours. If a superadmin turns reports on in the dashboard, Orchard sends the first report at that moment.
Error reportWhen an unexpected server error happens, up to 60 each hour for each server pod.
FieldContent
version, node_version, archThe versions of Orchard and Node.js, and the CPU architecture.
users_totalThe number of users.
users_active_1d, users_active_7d, users_active_30dThe number of users active in the last day, 7 days, and 30 days.
organizations, projects, databases, jobs, nodesThe number of each.
deployments, deployments_runningThe number of apps, and the number of apps that are not stopped.
Counts from installed graftsA number for each counter that an installed graft registers.
builds_succeeded_24h, builds_failed_24hThe number of builds that succeeded and failed in the last 24 hours.
feature_github_app, feature_email, feature_backups, feature_sso, feature_mcp, feature_userspace_schedulingWhether the GitHub App, email, backups, SSO, MCP, and node scheduling are turned on.

Orchard sends an error report for a response with a 5xx status, for an exception that Orchard did not handle, and for an error outside a request.

FieldContent
Error typeThe class name of the error, such as TypeError.
Stack framesUp to 40 frames, each with the function name, the file, the line, and the column. Files are paths inside Orchard or its dependencies.
versionThe version of Orchard.
error_codeThe error code, only if it is a Prisma code, a system code, or a Node.js code, such as P2002, ECONNRESET, or ERR_INVALID_ARG_TYPE.
http_method, http_statusThe method and status of the request.
http_routeThe route pattern, such as /deployments/:id.
context_typeThe kind of context, for an error outside a request.

The reports on this page are the only statistics that Orchard sends to the Orchard team, and Orchard sends them only while reports are on. Each report carries a random ID that Orchard creates for the instance.

  1. Go to Instance admin > Configuration.
  2. In Anonymous usage reports, select See the exact report.

This shows the daily report with this instance’s values. It does not show error reports, which use the fields listed earlier.

  1. Go to Instance admin > Configuration.
  2. In Anonymous usage reports, turn Share anonymous reports on or off.

You can also answer the prompt that superadmins see during setup or after setup. Nothing is sent until someone answers.

After you turn reports off, every server pod stops sending within a minute.