Lexicon Garden

at.happyproto.server.getIngestMetrics

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

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

Query

query · GET

Parameters

query string

id

requiredstring

The instance's UUID.

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

collections

requiredarray
itemsref
Reference

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 id is not a UUID, or the window is not one this method takes.

NotFound

No such instance, or it is not the caller's. These are indistinguishable.

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 a HappyProto customer, or the provisioner refused them.

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.

#collection

object

One collection and action's records. The rate is records over the window.

Properties

action

requiredstring

create, update or delete.

collection

requiredstring

The record's NSID.

deadLettered

requiredinteger

Records set aside after failing for good.

failed

requiredinteger

Records whose hook failed.

recordUs

requiredref

Each record's time through the pipeline.

Reference

records

requiredinteger

timeouts

requiredinteger

Records whose hook ran out of time.

Similar lexicons

semantic match

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