{
  "code": null,
  "collection": "architecture",
  "href": "https://banes-lab.com/ontology#architecture-health-checks",
  "id": "health-checks",
  "kind": "mechanism",
  "layer": {
    "href": "https://banes-lab.com/ontology/schema#layer-correctness-core",
    "json": "https://banes-lab.com/json/records/layer/correctness-core",
    "label": "Correctness Core",
    "markdown": "https://banes-lab.com/records/layer/correctness-core.md",
    "ref": "layer:correctness-core"
  },
  "name": "Health Checks",
  "ref": "architecture:health-checks",
  "relations": [
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-observable-health-criteria",
          "json": "https://banes-lab.com/json/records/lexicon/observable-health-criteria",
          "label": "Observable Health Criteria",
          "markdown": "https://banes-lab.com/records/lexicon/observable-health-criteria.md",
          "ref": "lexicon:observable-health-criteria"
        }
      ],
      "relation": "requires"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-self-healing-architecture",
          "json": "https://banes-lab.com/json/records/architecture/self-healing-architecture",
          "label": "Self-Healing Architecture",
          "markdown": "https://banes-lab.com/records/architecture/self-healing-architecture.md",
          "ref": "architecture:self-healing-architecture"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-load-balancing",
          "json": "https://banes-lab.com/json/records/architecture/load-balancing",
          "label": "Load Balancing",
          "markdown": "https://banes-lab.com/records/architecture/load-balancing.md",
          "ref": "architecture:load-balancing"
        }
      ],
      "relation": "reinforces"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-readiness-liveness-routing",
          "json": "https://banes-lab.com/json/records/lexicon/readiness-liveness-routing",
          "label": "Readiness/Liveness Routing",
          "markdown": "https://banes-lab.com/records/lexicon/readiness-liveness-routing.md",
          "ref": "lexicon:readiness-liveness-routing"
        }
      ],
      "relation": "enables"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-blind-routing",
          "json": "https://banes-lab.com/json/records/lexicon/blind-routing",
          "label": "Blind Routing",
          "markdown": "https://banes-lab.com/records/lexicon/blind-routing.md",
          "ref": "lexicon:blind-routing"
        }
      ],
      "relation": "conflicts-with"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-false-positives",
          "json": "https://banes-lab.com/json/records/lexicon/false-positives",
          "label": "False Positives",
          "markdown": "https://banes-lab.com/records/lexicon/false-positives.md",
          "ref": "lexicon:false-positives"
        }
      ],
      "relation": "tensions-with"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/schema#tension-false-positives-health-checks",
          "json": "https://banes-lab.com/json/records/tension/false-positives-health-checks",
          "label": "Health Checks / False Positives",
          "markdown": "https://banes-lab.com/records/tension/false-positives-health-checks.md",
          "ref": "tension:false-positives-health-checks"
        }
      ],
      "relation": "tensions"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-blind-routing",
          "json": "https://banes-lab.com/json/records/lexicon/blind-routing",
          "label": "Blind Routing",
          "markdown": "https://banes-lab.com/records/lexicon/blind-routing.md",
          "ref": "lexicon:blind-routing"
        }
      ],
      "relation": "violated-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/schema#vocabulary-severity-contextual",
          "json": "https://banes-lab.com/json/records/vocabulary/severity-contextual",
          "label": "contextual",
          "markdown": "https://banes-lab.com/records/vocabulary/severity-contextual.md",
          "ref": "vocabulary:severity-contextual"
        }
      ],
      "relation": "severity"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-category-self-healing-recovery-deployment-safety",
          "json": "https://banes-lab.com/json/records/architecture-category/self-healing-recovery-deployment-safety",
          "label": "Self-Healing / Recovery / Deployment Safety",
          "markdown": "https://banes-lab.com/records/architecture-category/self-healing-recovery-deployment-safety.md",
          "ref": "architecture-category:self-healing-recovery-deployment-safety"
        }
      ],
      "relation": "category"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-service-discovery",
          "json": "https://banes-lab.com/json/records/architecture/service-discovery",
          "label": "Service Discovery",
          "markdown": "https://banes-lab.com/records/architecture/service-discovery.md",
          "ref": "architecture:service-discovery"
        }
      ],
      "relation": "required-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-category-runtime-discovery-dynamic-binding",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-runtime-discovery-dynamic-binding",
          "label": "Runtime Discovery / Dynamic Binding",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-runtime-discovery-dynamic-binding.md",
          "ref": "chapter:/ontology#architecture-category-runtime-discovery-dynamic-binding"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-category-scalability-performance-optimization",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-scalability-performance-optimization",
          "label": "Scalability / Performance / Optimization",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-scalability-performance-optimization.md",
          "ref": "chapter:/ontology#architecture-category-scalability-performance-optimization"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-category-plugin-extensibility-ioc",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-plugin-extensibility-ioc",
          "label": "Plugin / Extensibility / IoC",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-plugin-extensibility-ioc.md",
          "ref": "chapter:/ontology#architecture-category-plugin-extensibility-ioc"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-category-self-healing-recovery-deployment-safety",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-self-healing-recovery-deployment-safety",
          "label": "Self-Healing / Recovery / Deployment Safety",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-self-healing-recovery-deployment-safety.md",
          "ref": "chapter:/ontology#architecture-category-self-healing-recovery-deployment-safety"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-category-core-vocabulary",
          "json": "https://banes-lab.com/json/ontology/lexicon/lexicon-category-core-vocabulary",
          "label": "Core Vocabulary",
          "markdown": "https://banes-lab.com/ontology/lexicon/lexicon-category-core-vocabulary.md",
          "ref": "chapter:/ontology/lexicon#lexicon-category-core-vocabulary"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-category-self-healing-recovery-deployment-safety",
          "json": "https://banes-lab.com/json/ontology/lexicon/lexicon-category-self-healing-recovery-deployment-safety",
          "label": "Self-Healing / Recovery / Deployment Safety",
          "markdown": "https://banes-lab.com/ontology/lexicon/lexicon-category-self-healing-recovery-deployment-safety.md",
          "ref": "chapter:/ontology/lexicon#lexicon-category-self-healing-recovery-deployment-safety"
        },
        {
          "href": "https://banes-lab.com/ontology/schema#the-vocabulary-severity",
          "json": "https://banes-lab.com/json/ontology/schema/the-vocabulary-severity",
          "label": "Severity levels",
          "markdown": "https://banes-lab.com/ontology/schema/the-vocabulary-severity.md",
          "ref": "chapter:/ontology/schema#the-vocabulary-severity"
        },
        {
          "href": "https://banes-lab.com/ontology/schema#the-resolutions",
          "json": "https://banes-lab.com/json/ontology/schema/the-resolutions",
          "label": "The resolutions",
          "markdown": "https://banes-lab.com/ontology/schema/the-resolutions.md",
          "ref": "chapter:/ontology/schema#the-resolutions"
        }
      ],
      "relation": "linked-from"
    }
  ],
  "summary": "A mechanism that reports whether an instance and the dependencies it needs are ready to serve, so routing and restarts can act on it.",
  "siblings": {
    "next": {
      "href": "https://banes-lab.com/ontology#architecture-failover",
      "json": "https://banes-lab.com/json/records/architecture/failover",
      "label": "Failover",
      "markdown": "https://banes-lab.com/records/architecture/failover.md",
      "ref": "architecture:failover"
    },
    "previous": {
      "href": "https://banes-lab.com/ontology#architecture-self-healing-architecture",
      "json": "https://banes-lab.com/json/records/architecture/self-healing-architecture",
      "label": "Self-Healing Architecture",
      "markdown": "https://banes-lab.com/records/architecture/self-healing-architecture.md",
      "ref": "architecture:self-healing-architecture"
    }
  },
  "up": {
    "href": null,
    "json": "https://banes-lab.com/json/api/records/architecture",
    "label": "Architecture principles",
    "markdown": "https://banes-lab.com/api/records/architecture.md",
    "ref": "api:records/architecture"
  },
  "aliases": [],
  "exemplar": {
    "after": "app.get(\"/health\", async () => {\n  const fooStoreOk = await fooStore.ping();\n  const eventBusOk = await eventBus.ping();\n  return {\n    state: fooStoreOk && eventBusOk ? \"ready\" : \"blocked\",\n    checks: { fooStore: fooStoreOk, eventBus: eventBusOk },\n  };\n});",
    "before": "app.get(\"/health\", () => \"ok\");",
    "lang": "ts",
    "medium": "code"
  },
  "formedBy": null,
  "scope": [
    "service",
    "deployment",
    "runtime"
  ],
  "severity": "contextual"
}