Lexicon Garden

at.happyproto.fleet.getIngestHealth

Report lag, clock skew and schema-version spread. Lag and skew are separate facts and must not be averaged together. Admin only.

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

Checks

Valid
  • unlimited-string defs.main.output.schema.properties.statusNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.output.schema.properties.unitNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.skew.properties.instanceIdNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "lag": {
      "properties": {
        "max": {
          "type": "integer"
        },
        "p50": {
          "type": "integer"
        },
        "p90": {
          "type": "integer"
        }
      },
      "required": [
        "p50",
        "p90",
        "max"
      ],
      "type": "object"
    },
    "main": {
      "description": "Report lag, clock skew and schema-version spread. Lag and skew are separate facts and must not be averaged together. Admin only.",
      "errors": [
        {
          "description": "This endpoint requires an authenticated caller.",
          "name": "AuthRequired"
        },
        {
          "description": "The caller is not a HappyProto admin.",
          "name": "Forbidden"
        },
        {
          "description": "The telemetry store could not be queried.",
          "name": "Upstream"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "have": {
              "description": "History available, when accruing.",
              "type": "integer"
            },
            "lag": {
              "ref": "#lag",
              "type": "ref"
            },
            "need": {
              "description": "History required, when accruing.",
              "type": "integer"
            },
            "schemaVersions": {
              "items": {
                "ref": "#schemaVersion",
                "type": "ref"
              },
              "type": "array"
            },
            "skewed": {
              "items": {
                "ref": "#skew",
                "type": "ref"
              },
              "type": "array"
            },
            "status": {
              "description": "Why a figure is absent. Branch on this, never on field presence.",
              "knownValues": [
                "ok",
                "accruing",
                "withheld"
              ],
              "type": "string"
            },
            "unit": {
              "knownValues": [
                "days",
                "snapshots"
              ],
              "type": "string"
            },
            "windowDays": {
              "type": "integer"
            }
          },
          "required": [
            "status"
          ],
          "type": "object"
        }
      },
      "type": "query"
    },
    "schemaVersion": {
      "properties": {
        "instances": {
          "type": "integer"
        },
        "version": {
          "type": "integer"
        }
      },
      "required": [
        "version",
        "instances"
      ],
      "type": "object"
    },
    "skew": {
      "properties": {
        "aheadSeconds": {
          "description": "Seconds the snapshot was stamped ahead of receipt. A wrong clock makes every delta from this instance suspect.",
          "type": "integer"
        },
        "instanceId": {
          "type": "string"
        }
      },
      "required": [
        "instanceId",
        "aheadSeconds"
      ],
      "type": "object"
    }
  },
  "id": "at.happyproto.fleet.getIngestHealth",
  "lexicon": 1
}