@nage-api/observability 1.0.0-beta.2

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,141 @@
+# @nage-api/observability
+
+Logging, tracing, metrics and health (PLAN.md §18, §21, §25 P1).
+
+Ports with no-op defaults. The framework's own instrumentation — a span per
+request, a counter per response — costs nothing when nobody is collecting,
+which is the normal case in development and in tests. An application that wants
+OpenTelemetry or a hosted metrics backend binds an adapter, and no caller
+changes.
+
+| Concern | Port          | Default             | Enabled by                      |
+| ------- | ------------- | ------------------- | ------------------------------- |
+| Logging | `LoggerPort`  | `JsonLogger` (core) | always                          |
+| Tracing | `TracerPort`  | `NoopTracer`        | `observability.tracing.enabled` |
+| Metrics | `MetricsPort` | `NoopMetrics`       | `observability.metrics.enabled` |
+| Health  | —             | `HealthRegistry`    | always                          |
+
+## Health
+
+`/health/live` never touches a dependency. If a database outage made liveness
+fail, the orchestrator would restart every pod and turn a degraded system into
+an outage.
+
+`/health/ready` does check, concurrently, each probe under its own timeout —
+because a dependency that hangs must be reported down in bounded time rather
+than holding the probe open until the orchestrator gives up.
+
+It also answers `503 draining` the moment a shutdown signal arrives, before any
+probe runs: dependency state was never the only reason to stop taking traffic, and
+a draining instance is about to close the connection it is being offered. The flag
+comes from `NAGE_LIFECYCLE`, published by `NageCoreModule` and flipped by
+`installShutdown`; `/health/live` ignores it deliberately, because failing liveness
+during a drain gets the process killed before it can finish.
+
+```ts
+import { Module } from '@nestjs/common';
+import { NageObservabilityModule, healthCheck } from '@nage-api/observability';
+
+// Whatever the application already holds: a Sequelize instance, an ioredis
+// client. A probe is any function that resolves when the dependency answers.
+declare const repository: { ping(): Promise<unknown> };
+declare const redis: { ping(): Promise<unknown> };
+
+@Module({
+  imports: [
+    NageObservabilityModule.forRoot({
+      checks: [
+        healthCheck('database', () => repository.ping()),
+        healthCheck('cache', () => redis.ping(), { critical: false }),
+      ],
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+`critical: false` degrades the report instead of failing it. Pulling a node out
+of the load balancer because Redis blinked makes the outage worse. Readiness
+answers 503 only when something critical is down.
+
+Failure detail is **withheld by default**: a probe endpoint is unauthenticated,
+and a connection string in an error message is a disclosure.
+`exposeHealthDetail: true` opts in.
+
+## Metrics
+
+An in-process registry with Prometheus text exposition, served from `/metrics`
+when metrics are enabled. Counters, gauges and histograms; nothing else.
+
+The thing it takes seriously is **cardinality**. A label whose value comes from
+a request path or a user id creates a new time series per value, and a metrics
+endpoint that grows without bound eventually takes the scraper down with it. So
+the HTTP interceptor labels by route **template** (`/orders/:id`, never
+`/orders/1`), and the registry caps series per metric name and exposes
+`nage_metrics_dropped_total` rather than growing silently or dropping silently.
+
+Built-in series: `nage_http_requests_total{method,route,status}`,
+`nage_http_request_duration_ms{method,route}`, `nage_http_requests_in_flight`.
+In-flight is decremented on the error path too, so a failing endpoint does not
+show a permanent backlog.
+
+## Tracing
+
+`NAGE_TRACER` is what application code injects; it resolves to whatever the
+deployment bound, or to `NoopTracer`, and the call site does not change.
+
+```ts
+import { Inject, Injectable } from '@nestjs/common';
+import { NAGE_TRACER, type TracerPort } from '@nage-api/observability';
+
+interface Order {
+  readonly id: string;
+  readonly total: number;
+}
+
+declare const gateway: { charge(order: Order): Promise<{ reference: string }> };
+
+@Injectable()
+export class PaymentService {
+  constructor(@Inject(NAGE_TRACER) private readonly tracer: TracerPort) {}
+
+  async charge(order: Order): Promise<{ reference: string }> {
+    return this.tracer.trace(
+      'charge-card',
+      async (span) => {
+        span.setAttribute('order.id', order.id);
+        return gateway.charge(order);
+      },
+      { kind: 'client' },
+    );
+  }
+}
+```
+
+The span ends in a `finally`, so a thrown error still closes it — an unclosed
+span reads as an operation that never returned. `RecordingTracer` is the same
+interface backed by memory, so a test can assert on spans without a collector.
+
+The span per request comes from the same HTTP interceptor that records the
+metrics, so that interceptor is registered as soon as **either** metrics or
+tracing is enabled. A deployment that turns tracing on and leaves metrics off
+still gets its request spans.
+
+Two details: the correlation id from the request context is attached
+automatically, which is what ties a span to the log lines and the response
+envelope for the same request; and string attributes go through the same
+redaction that guards log lines, because attributes reach a collector the team
+may not control.
+
+## Not yet implemented
+
+- The OpenTelemetry adapter itself. `TracerPort` is the seam; the exporter,
+  sampler and propagation headers are not written.
+- pino as a `LoggerPort` implementation (§8 names it); `JsonLogger` in
+  `@nage-api/core` covers structured output today.
+- Sentry. `ObservabilityConfig.sentry` is declared and unread.
+- Metric-name collision detection: registering the same name as two different
+  types produces two series rather than an error.
+- Binding your own `metrics` sink while `metrics.enabled` is true still mounts
+  `/metrics` from the built-in registry, which then renders empty: the
+  framework's series go to the bound sink, and only that sink has them.

package/dist/health.controller.d.ts

@@ -0,0 +1,61 @@
+/**
+ * `/health/live`, `/health/ready` and `/metrics` (PLAN.md §21).
+ *
+ * All three are `@Public()`, exempt from throttling — an orchestrator polls
+ * them every few seconds — and unwrapped, because probes and scrapers expect an
+ * exact body rather than a response envelope.
+ *
+ * Liveness never touches a dependency. If a database outage made liveness fail,
+ * the orchestrator would restart every pod, turning a degraded system into an
+ * outage.
+ *
+ * Readiness returns per-check **status** to anyone, but the failure detail only
+ * when the deployment opts in: a probe response is an unauthenticated endpoint,
+ * and a connection string in an error message is a disclosure.
+ *
+ * Readiness also fails the moment a shutdown signal arrives, before any check
+ * runs. Dependency state is not the only reason to stop taking traffic: a process
+ * that is draining will close the connection it is being offered, and endpoint
+ * removal is asynchronous, so the honest answer during a drain is 503.
+ */
+import { type LifecycleState } from '@nage-api/core';
+import { HealthRegistry } from './health.js';
+import { MetricsRegistry } from './metrics.js';
+interface ResponseLike {
+    status(code: number): {
+        send(body: string): void;
+    };
+}
+export interface PublicHealthCheck {
+    readonly name: string;
+    readonly status: string;
+    readonly durationMs: number;
+    readonly detail?: string;
+}
+export interface PublicHealthReport {
+    readonly status: string;
+    readonly checks: readonly PublicHealthCheck[];
+}
+export declare class HealthController {
+    #private;
+    /**
+     * Constructor injection by token rather than a plain options object: Nest
+     * instantiates controllers itself, so a `useValue` provider for a controller
+     * class is quietly ignored.
+     */
+    constructor(health: HealthRegistry, exposeDetail: boolean, lifecycle?: LifecycleState);
+    live(): {
+        status: 'ok';
+    };
+    ready(response: {
+        statusCode?: number;
+    }): Promise<PublicHealthReport>;
+}
+/** Separate controller so `/metrics` can be mounted, or not, on its own. */
+export declare class MetricsController {
+    #private;
+    constructor(metrics: MetricsRegistry);
+    scrape(_response: ResponseLike): string;
+}
+export {};
+//# sourceMappingURL=health.controller.d.ts.map

package/dist/health.controller.js

@@ -0,0 +1,141 @@
+"use strict";
+/**
+ * `/health/live`, `/health/ready` and `/metrics` (PLAN.md §21).
+ *
+ * All three are `@Public()`, exempt from throttling — an orchestrator polls
+ * them every few seconds — and unwrapped, because probes and scrapers expect an
+ * exact body rather than a response envelope.
+ *
+ * Liveness never touches a dependency. If a database outage made liveness fail,
+ * the orchestrator would restart every pod, turning a degraded system into an
+ * outage.
+ *
+ * Readiness returns per-check **status** to anyone, but the failure detail only
+ * when the deployment opts in: a probe response is an unauthenticated endpoint,
+ * and a connection string in an error message is a disclosure.
+ *
+ * Readiness also fails the moment a shutdown signal arrives, before any check
+ * runs. Dependency state is not the only reason to stop taking traffic: a process
+ * that is draining will close the connection it is being offered, and endpoint
+ * removal is asynchronous, so the honest answer during a drain is 503.
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetricsController = exports.HealthController = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nage-api/core");
+const health_js_1 = require("./health.js");
+const metrics_js_1 = require("./metrics.js");
+const tokens_js_1 = require("./tokens.js");
+let HealthController = class HealthController {
+    #health;
+    #exposeDetail;
+    #lifecycle;
+    /**
+     * Constructor injection by token rather than a plain options object: Nest
+     * instantiates controllers itself, so a `useValue` provider for a controller
+     * class is quietly ignored.
+     */
+    constructor(health, exposeDetail, lifecycle) {
+        this.#health = health;
+        this.#exposeDetail = exposeDetail;
+        this.#lifecycle = lifecycle;
+    }
+    live() {
+        // No dependency checks, deliberately — and no lifecycle check either. A
+        // draining process is healthy; failing liveness while it drains asks the
+        // orchestrator to kill the process that is trying to finish its work.
+        return { status: 'ok' };
+    }
+    async ready(response) {
+        // Checked before the probes, and instead of them: the verdict cannot change,
+        // and a draining process should not be spending its drain budget on a
+        // `SELECT 1`.
+        if (this.#lifecycle?.draining === true) {
+            response.statusCode = common_1.HttpStatus.SERVICE_UNAVAILABLE;
+            return { status: 'draining', checks: [] };
+        }
+        const report = await this.#health.check();
+        // 503 when a critical dependency is down, so a load balancer stops sending
+        // traffic. `degraded` still serves: the application works, just less well.
+        if (report.status === 'down')
+            response.statusCode = common_1.HttpStatus.SERVICE_UNAVAILABLE;
+        return {
+            status: report.status,
+            checks: report.checks.map((check) => ({
+                name: check.name,
+                status: check.status,
+                durationMs: check.durationMs,
+                ...(this.#exposeDetail && check.detail !== undefined ? { detail: check.detail } : {}),
+            })),
+        };
+    }
+};
+exports.HealthController = HealthController;
+__decorate([
+    (0, common_1.Get)('live'),
+    (0, core_1.Public)(),
+    (0, core_1.SkipRateLimit)(),
+    (0, core_1.NoEnvelope)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Object)
+], HealthController.prototype, "live", null);
+__decorate([
+    (0, common_1.Get)('ready'),
+    (0, core_1.Public)(),
+    (0, core_1.SkipRateLimit)(),
+    (0, core_1.NoEnvelope)(),
+    (0, common_1.HttpCode)(common_1.HttpStatus.OK),
+    __param(0, (0, common_1.Res)({ passthrough: true })),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], HealthController.prototype, "ready", null);
+exports.HealthController = HealthController = __decorate([
+    (0, common_1.Controller)('health'),
+    __param(0, (0, common_1.Inject)(tokens_js_1.NAGE_HEALTH)),
+    __param(1, (0, common_1.Inject)(tokens_js_1.NAGE_HEALTH_EXPOSE_DETAIL)),
+    __param(2, (0, common_1.Optional)()),
+    __param(2, (0, common_1.Inject)(core_1.NAGE_LIFECYCLE)),
+    __metadata("design:paramtypes", [health_js_1.HealthRegistry, Boolean, Function])
+], HealthController);
+/** Separate controller so `/metrics` can be mounted, or not, on its own. */
+let MetricsController = class MetricsController {
+    #metrics;
+    constructor(metrics) {
+        this.#metrics = metrics;
+    }
+    scrape(_response) {
+        return this.#metrics.render();
+    }
+};
+exports.MetricsController = MetricsController;
+__decorate([
+    (0, common_1.Get)('metrics'),
+    (0, core_1.Public)(),
+    (0, core_1.SkipRateLimit)(),
+    (0, core_1.NoEnvelope)(),
+    (0, common_1.Header)('content-type', 'text/plain; version=0.0.4; charset=utf-8'),
+    __param(0, (0, common_1.Res)({ passthrough: true })),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", String)
+], MetricsController.prototype, "scrape", null);
+exports.MetricsController = MetricsController = __decorate([
+    (0, common_1.Controller)(),
+    __param(0, (0, common_1.Inject)(tokens_js_1.NAGE_METRICS_REGISTRY)),
+    __metadata("design:paramtypes", [metrics_js_1.MetricsRegistry])
+], MetricsController);
+//# sourceMappingURL=health.controller.js.map

package/dist/health.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Readiness and liveness (PLAN.md §21).
+ *
+ * Liveness answers "is this process wedged?" — it must not touch a dependency,
+ * because a database outage restarting every pod turns a degraded system into
+ * an outage. Readiness answers "should traffic come here?" and does check
+ * dependencies.
+ *
+ * Two things the legacy framework got wrong and this fixes:
+ *
+ * **A slow probe is a failing probe.** Every check runs under a timeout, so a
+ * dependency that hangs is reported as down in bounded time rather than holding
+ * the probe open until the orchestrator's own timeout fires.
+ *
+ * **Not every dependency is critical.** A cache being down should degrade the
+ * report, not fail it — pulling a node out of the load balancer because Redis
+ * blinked makes the outage worse.
+ */
+import type { Clock, HealthCheck, HealthReport } from './ports.js';
+export interface HealthRegistryOptions {
+    /** Per-check timeout. A probe that has not answered by then is down. */
+    readonly timeoutMs?: number;
+    readonly clock?: Clock;
+}
+export declare class HealthRegistry {
+    #private;
+    constructor(options?: HealthRegistryOptions);
+    register(check: HealthCheck): this;
+    unregister(name: string): this;
+    get names(): readonly string[];
+    /**
+     * Run every check.
+     *
+     * Concurrently, because readiness is polled every few seconds and running ten
+     * probes in series makes the probe itself the slow dependency.
+     */
+    check(): Promise<HealthReport>;
+}
+/** Build a check from any async probe — a `SELECT 1`, a `PING`, a HEAD request. */
+export declare function healthCheck(name: string, probe: () => Promise<unknown>, options?: {
+    critical?: boolean;
+}): HealthCheck;
+//# sourceMappingURL=health.d.ts.map