Lexicon Garden

at.happyproto.fleet.getTenantIngestMetrics

How any tenant handled incoming records in a window, by collection and action. The same shape as server.getIngestMetrics. 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

tenant

requiredstring

The instance id.

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.

retentionDays

integer

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

window

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

Errors

InvalidRequest

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

NotFound

No such tenant.

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.

  • at.happyproto.server.getIngestMetrics

    query

    How one of the caller's own instances handled incoming records in a window, by collection and action. Customers only.

  • at.happyproto.fleet.getTenantScriptMetrics

    query

    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.

  • at.happyproto.fleet.getTenantUsage

    query

    One tenant's metered usage by hour or day, with the hours that have no report. Proxied from the provisioner. Admin only.

  • at.happyproto.fleet.getCapacity

    query

    Store capacity: the latest totals, a daily trend, per-collection counts and what each tenant holds. Proxied from the provisioner. Admin only.

  • at.happyproto.fleet.getGrowth

    query

    Fleet and per-instance growth rates from instance_daily_deltas. Counter resets are excluded by the view, so a wiped volume lowers no rate. Admin only.