Ster/Docs

ster support

Ask Ster's support for help from this installation, with what support needs to answer attached, and read the replies.

Invocation and purpose#

text
ster support report --description <TEXT> [--subject <TEXT>] [--email <ADDRESS>] [--without-failure]
ster support status

report files one report with Ster's support: what you were doing and what happened, with Ster's version, this system's version, this installation's id (the one ster telemetry status prints) and the last failure telemetry holds, exactly as ster telemetry show prints it, already without your home directory or this machine's name. A user who never turned telemetry on has no failure to attach, and the report goes without one. status reads every report this installation filed back from support. Ster Desktop's Help → Report a Problem files and reads the same reports through ster request support/report|status.

Inputs and options#

InputRequiredMeaning
--description <TEXT>with reportWhat you were doing and what happened.
--subject <TEXT>noOne line naming the problem.
--email <ADDRESS>noWhere support may answer; without it the reply is read with ster support status.
--without-failurenoLeave the last failure out.
WISENT_SUPPORT_URLnoThe support service to file with instead of Wisent's public one, https://support.wisent.com/v1/public/reports: https://, or http:// on this machine's loopback.
WISENT_TELEMETRY_HOMEnoWhere the report's key is kept, as for ster telemetry.

Output and state#

report prints { "id", "status", "created_at", "address", "kept", "with_failure" }: the report's id (WCS-000042), its state at support, where it went, and the file its access key is kept in, support/<id>.json under the telemetry directory. The key is the only way to read the report back and is never printed. status prints { "reports": [...] }, every kept report, oldest first, as support answers it now: id, status (triaged, open, waiting_on_customer, resolved, …), subject, created_at, updated_at and replies, each at and text; a report support could not be asked about prints id, subject and unread with the sentence and the fix, and the others still read.

Refusals#

  • report without --description, or with an empty one, is refused as filing a support report: the report has no description; fix: say what you were doing and what happened: ster support report --description "…", and nothing is sent.
  • A support address that is not https:// (or http:// on the loopback) is refused as reading the support address from WISENT_SUPPORT_URL: a support address must be https://, or http:// on a loopback host; observed: WISENT_SUPPORT_URL holds <address>.
  • A report support declines prints its reason: filing a support report at <address>: support refused HTTP <status>: <reason>; observed: nothing was filed — for example email "…" is not an email address, or too many reports from one address in an hour with the time to file again.
  • Without network: filing a support report at <address>: support could not be reached: <error>; observed: nothing was filed.
  • An address that answers something other than support: reading support's answer at <address>: the answer is not a support service's: <answer>; observed: HTTP <status>.
  • A key that cannot be kept is refused as ster telemetry refuses an unwritable directory. Nothing is kept for a report support did not take.