Lexicon Garden

at.happyproto.fleet.getTenantScriptMetrics

How any tenant's scripts ran in a window: every script that ran, or with trigger, one script's series. The same shape as server.getScriptMetrics. Admin only.

Repository @happyproto.at did:plc:mo7vq4jbioxwafy5zkcc3eux namespace authority
Details · query
Kindquery
Authorityfleet.happyproto.at
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

step

string

With trigger: how wide each point is. 1m and 30m suit 1h and 24h; 1h and 1d suit 7d and 30d. Defaults to the window's own.

  • knownValues: 1m | 30m | 1h | 1d

tenant

requiredstring

The instance id.

trigger

string

One script's trigger, such as xrpc.query:com.example.getThing, at most 400 characters. With it, the reply is that script's series; without it, every script that ran.

window

string

How far back to read. 1h and 24h come from the instance's memory; 7d and 30d from what it stored, as far back as it keeps.

  • default: "1h"
  • knownValues: 1h | 24h | 7d | 30d

Output

application/json

enabled

requiredboolean

Whether the instance is recording metrics at all.

points

array

With trigger: the window in steps, oldest first.

retentionDays

integer

On 7d and 30d: how many days the instance keeps, so a longer window covers only that.

script

ref

With trigger: the script, over the whole window.

Reference

scripts

array

Without trigger: every script that ran in the window.

step

string

With trigger: how wide each point is.

  • knownValues: 1m | 30m | 1h | 1d

window

requiredstring
  • knownValues: 1h | 24h | 7d | 30d

Errors

InvalidRequest

The tenant id is not a UUID, or the window, step or trigger is not one this method takes.

NotFound

No such tenant.

ScriptNotRun

With trigger: that script has not run in the window.

MetricsUnavailable

The instance is not running, or its host cannot be reached.

MetricsBusy

Too many metrics reads are running for this instance or its host. Try again shortly.

MetricsTimeout

The instance's HappyView did not answer in time. Try again shortly.

NotSupported

The instance runs a HappyView too old to report its metrics. Upgrading it fixes this.

AuthRequired

This endpoint requires an authenticated caller.

Forbidden

The caller is not HappyProto staff, or the provisioner does not treat them as staff.

InvalidSlug

Passed through from the provisioner.

SlugTaken

Passed through from the provisioner.

NotEntitled

Passed through from the provisioner.

InstanceLimit

Passed through from the provisioner.

NoCapacity

Passed through from the provisioner.

OperationInProgress

Passed through from the provisioner.

Upstream

The provisioner is unreachable, not configured, or answered with an error it does not explain to callers.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.