@intentius/chant-lexicon-prometheus 0.106.4 → 0.108.0

package/README.md

@@ -28,6 +28,9 @@ export { api, oncall, fallback, root };
 | `RuleGroup` | rule file |
 | `Slo` (composite) | rule file: SLI recording rules, error budget and multiwindow burn-rate alerts |
 | `GenAiRules` (composite) | rule file: request, error, latency, token and cost rules and opt-in alerts for the otel GenAI preset |
+| `RedAlerts` (composite) | rule file: error-ratio and latency alerts per service over a spanmetrics connector's metrics |
+| `Watchdog` (composite) | rule file and `alertmanager.yml`: an always-firing alert, its heartbeat route and receiver |
+| `AlertRouting` (composite) | `alertmanager.yml`: a route tree by team and severity, inhibit rules between levels, receivers |
 | `ScrapeConfig`, `PrometheusConfig` | `prometheus.yml`: scrape jobs with relabelling and typed kubernetes, file, http, dns, ec2 and consul discovery (other `*_sd_configs` kinds pass through untyped), plus `global`, `alerting`, `rule_files`, `remote_write`, `remote_read` and `otlp` |
 | `Route`, `Receiver` (every Alertmanager integration), `InhibitRule`, `TimeInterval`, `AlertmanagerSettings` | `alertmanager.yml` |
 
@@ -62,10 +65,12 @@ PromQL is parsed with `@prometheus-io/lezer-promql`, the Prometheus project's ow
 - `src/alertmanager.ts`: the Alertmanager entities
 - `src/composites/slo.ts`: `Slo` and `sloMetrics`
 - `src/composites/genai.ts`: `GenAiRules` and `genAiRuleMetrics`
+- `src/composites/red-alerts.ts`: `RedAlerts` and `redAlertRules`
+- `src/composites/watchdog.ts`, `src/composites/alert-routing.ts`: `Watchdog` and `AlertRouting`
 - `src/build.ts`: entities to config to YAML
 - `src/promql.ts`, `src/matchers.ts`, `src/duration.ts`: parsing
 - `src/validate-config.ts`, `src/lint/`: checks
 - `src/tools.ts`: promtool and amtool
 - `src/import/`: `chant import` for rule files and `alertmanager.yml` (parser, generator, `Slo` recognition, round-trip tests and fixtures)
 - `src/rule-eval.ts`: a small rule evaluator the SLO and GenAI tests run over synthetic series
-- `examples/`: getting-started, alerting, rules-from-data, slo, k3d-stack
+- `examples/`: getting-started, alerting, rules-from-data, slo, k3d-stack, observe-converge

package/dist/api/alertmanager.d.ts

@@ -0,0 +1,56 @@
+/**
+ * The Alertmanager config APIs (#3371).
+ *
+ * | Kind | Config | Health |
+ * |---|---|---|
+ * | `alertmanager` | `/api/v2/status` `config.original` | the same answer: `cluster.status`, `versionInfo.version` |
+ * | `mimir`, `cortex` | `/api/v1/alerts` (YAML: `alertmanager_config`, `template_files`) | `<prefix>/api/v2/status`, best effort |
+ *
+ * A plain Alertmanager's `config.original` is not the file it loaded. It is
+ * the loaded config marshalled again (`Config.String()` in Alertmanager's
+ * `config/config.go`): secrets read `<secret>`, the global defaults are
+ * written out, and every receiver carries the settings it inherited from
+ * `global:`. ../import/alertmanager-live.ts takes those back out. Mimir and
+ * Cortex return the config as the tenant uploaded it.
+ *
+ * `setConfig` is for the ruler apply target (#3372): `POST /api/v1/alerts`,
+ * which Mimir and Cortex serve with `-alertmanager.enable-api`. A plain
+ * Alertmanager has no config write API.
+ */
+import type { AlertmanagerTarget } from "../config.js";
+import { type PromClient } from "./client.js";
+/** What `/api/v2/status` says about the Alertmanager itself. */
+export interface AlertmanagerHealth {
+    /** `ready`, `settling` or `disabled` (no clustering). */
+    cluster?: string;
+    peers?: number;
+    version?: string;
+}
+/** A live Alertmanager config, as text, with where it came from. */
+export interface LiveAlertmanagerConfig {
+    /** The config YAML. */
+    text: string;
+    /** Where it was read. */
+    address: string;
+    /** True when it is Alertmanager's own re-marshalled form (`/api/v2/status`), with defaults written out and secrets masked. */
+    remarshalled: boolean;
+    /** Mimir and Cortex: the notification templates uploaded with it, by file name. */
+    templateFiles?: Record<string, string>;
+}
+/** A bound Alertmanager: the transport and the target it reaches. */
+export declare class AlertmanagerApi {
+    readonly client: PromClient;
+    readonly target: AlertmanagerTarget;
+    constructor(client: PromClient, target: AlertmanagerTarget);
+    /** Where `/api/v2/status` is served. */
+    get statusPath(): string;
+    /** The status answer, read once per client; undefined on 404. */
+    private status;
+    /** The loaded config; undefined when there is none (Mimir answers 404 for a tenant with no config). */
+    readConfig(): Promise<LiveAlertmanagerConfig | undefined>;
+    /** Cluster status and version. Never throws: a failed read is no health, since health is an attribute, not presence. */
+    health(): Promise<AlertmanagerHealth | undefined>;
+    /** Upload a config (Mimir and Cortex, `POST /api/v1/alerts`, 201). */
+    setConfig(config: string, templateFiles?: Record<string, string>): Promise<void>;
+}
+//# sourceMappingURL=alertmanager.d.ts.map

package/dist/api/alertmanager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"alertmanager.d.ts","sourceRoot":"","sources":["../../src/api/alertmanager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAIH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAgB,KAAK,UAAU,EAAE,MAAM,UAAU,CAAC;AAEzD,gEAAgE;AAChE,MAAM,WAAW,kBAAkB;IACjC,yDAAyD;IACzD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,oEAAoE;AACpE,MAAM,WAAW,sBAAsB;IACrC,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,8HAA8H;IAC9H,YAAY,EAAE,OAAO,CAAC;IACtB,mFAAmF;IACnF,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACxC;AAMD,qEAAqE;AACrE,qBAAa,eAAe;IAExB,QAAQ,CAAC,MAAM,EAAE,UAAU;IAC3B,QAAQ,CAAC,MAAM,EAAE,kBAAkB;IAFrC,YACW,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,kBAAkB,EACjC;IAEJ,wCAAwC;IACxC,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED,iEAAiE;IACjE,OAAO,CAAC,MAAM;IAId,uGAAuG;IACjG,UAAU,IAAI,OAAO,CAAC,sBAAsB,GAAG,SAAS,CAAC,CA0B9D;IAED,wHAAwH;IAClH,MAAM,IAAI,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAetD;IAED,sEAAsE;IAChE,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAMzF;CACF"}

package/dist/api/apply.d.ts

@@ -0,0 +1,126 @@
+/**
+ * The ruler apply target (#3372): `nativeApply`'s `ruler` target, reached
+ * through `@intentius/chant-lexicon-prometheus/api/apply` the way core
+ * reaches the grafana and sql appliers. Core imports no lexicon; it loads
+ * this module by name at call time.
+ *
+ * One transport with observe and export ({@link bindEndpoints}), so the
+ * tenant (`X-Scope-OrgID`) and the Mimir, Cortex and Loki path variants are
+ * the profile's: `prometheus.profiles.<env>.ruler`.
+ *
+ * The ownership boundary is {@link declaredNamespaces}. The plan reads only
+ * those namespaces, a group is written only into the namespace
+ * {@link namespaceOfGroup} gives it, and an owned-only delete removes a
+ * group the ruler has and the project does not declare, one group at a
+ * time, only inside those namespaces. A namespace the project does not
+ * declare is never listed, read, written or deleted. This is the difference
+ * from `mimirtool rules sync`, which deletes every remote namespace missing
+ * from the local files unless `--namespaces` is set.
+ *
+ * Rollback re-applies the previous group set. Before the first write an
+ * apply saves, beside the build file, what each changed or pruned group
+ * looked like (and which groups it creates); {@link rulerRollback} puts the
+ * first back and deletes the second.
+ */
+import { type AppliedAction, type ApplyResult, type NotAttemptedReason } from "@intentius/chant/apply";
+import { type BindOptions } from "./bind.js";
+import type { RawRuleGroup } from "./ruler.js";
+type Json = Record<string, unknown>;
+export interface RulerApplyArgs {
+    /** The build's primary file: the rule file (`groups:`), or an `alertmanager.yml` when no rules are declared. */
+    buildPath: string;
+    /** The chant environment whose `prometheus.profiles.<env>` names the ruler. */
+    environment?: string;
+    /** Delete groups the ruler has in a declared namespace and the project does not declare. */
+    prune?: boolean;
+}
+export interface RulerApplyDeps extends BindOptions {
+}
+export interface RulerPlanEntry {
+    kind: "RuleGroup" | "AlertmanagerConfig";
+    /** `<namespace>/<group>`, or the Alertmanager tenant. */
+    name: string;
+    namespace?: string;
+    group?: string;
+    action: "create" | "update" | "unchanged" | "delete";
+}
+export interface RulerOutcome {
+    applied: Array<{
+        kind: string;
+        name: string;
+        action: AppliedAction;
+    }>;
+    pruned: Array<{
+        kind: string;
+        name: string;
+        deleted: boolean;
+    }>;
+    notAttempted: Array<{
+        kind: string;
+        name: string;
+        reason: NotAttemptedReason;
+        detail?: string;
+    }>;
+}
+/** What a rollback needs: the previous form of what an apply wrote, and what it created. */
+export interface RulerSnapshot {
+    environment: string;
+    /** The previous form of every group the apply replaced or deleted. */
+    restore: Array<{
+        namespace: string;
+        group: RawRuleGroup;
+    }>;
+    /** Groups the apply created. */
+    remove: Array<{
+        namespace: string;
+        name: string;
+    }>;
+    /** The Alertmanager config before an upload, when there was one. */
+    alertmanager?: {
+        text: string;
+        templateFiles?: Record<string, string>;
+    };
+}
+interface Built {
+    groups: Array<Json & {
+        name: string;
+    }>;
+    alertmanager?: string;
+}
+/** Read the build: the rule groups, and an Alertmanager config (the primary itself, or `alertmanager.yml` beside it). */
+export declare function readBuilt(buildPath: string): Built;
+/**
+ * True when every key the declared value carries is in the live one with an
+ * equal value. A ruler adds fields of its own to a group it returns
+ * (`source_tenants`, say), and those are not a difference.
+ */
+export declare function covers(declared: unknown, live: unknown): boolean;
+/** The snapshot file an apply to `environment` writes beside the build file. */
+export declare function snapshotPath(buildPath: string, environment: string): string;
+/** What an apply would do, per declared namespace. Reads the ruler; writes nothing. */
+export declare function planRuler(args: RulerApplyArgs, deps?: RulerApplyDeps): Promise<RulerPlanEntry[]>;
+/** Apply the build to the environment's ruler (and Alertmanager). */
+export declare function rulerApply(args: RulerApplyArgs, deps?: RulerApplyDeps): Promise<RulerOutcome>;
+export interface RulerRollbackOutcome {
+    /** Groups put back to their previous form. */
+    restored: number;
+    /** Groups the apply created, deleted again. */
+    removed: number;
+    alertmanagerRestored: boolean;
+    /** False when no apply to this environment left a snapshot. */
+    hadSnapshot: boolean;
+}
+/**
+ * Re-apply the previous group set: put back every group the last apply
+ * replaced or deleted, and delete the ones it created. Touches only the
+ * groups the snapshot names, so a namespace the project does not declare is
+ * as untouched here as in the apply.
+ */
+export declare function rulerRollback(args: {
+    buildPath: string;
+    environment?: string;
+}, deps?: RulerApplyDeps): Promise<RulerRollbackOutcome>;
+/** The outcome as core's apply envelope (#1446). */
+export declare function toApplyResult(outcome: RulerOutcome): ApplyResult;
+export {};
+//# sourceMappingURL=apply.d.ts.map

package/dist/api/apply.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apply.d.ts","sourceRoot":"","sources":["../../src/api/apply.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAIH,OAAO,EAEL,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACxB,MAAM,wBAAwB,CAAC;AAGhC,OAAO,EAAsC,KAAK,WAAW,EAAE,MAAM,QAAQ,CAAC;AAE9E,OAAO,KAAK,EAAE,YAAY,EAAY,MAAM,SAAS,CAAC;AAGtD,KAAK,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEpC,MAAM,WAAW,cAAc;IAC7B,gHAAgH;IAChH,SAAS,EAAE,MAAM,CAAC;IAClB,+EAA+E;IAC/E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4FAA4F;IAC5F,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,cAAe,SAAQ,WAAW;CAAG;AAEtD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,WAAW,GAAG,oBAAoB,CAAC;IACzC,yDAAyD;IACzD,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,WAAW,GAAG,QAAQ,CAAC;CACtD;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,aAAa,CAAA;KAAE,CAAC,CAAC;IACtE,MAAM,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAChE,YAAY,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,kBAAkB,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAClG;AAED,4FAA4F;AAC5F,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,sEAAsE;IACtE,OAAO,EAAE,KAAK,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,YAAY,CAAA;KAAE,CAAC,CAAC;IAC3D,gCAAgC;IAChC,MAAM,EAAE,KAAK,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACnD,oEAAoE;IACpE,YAAY,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;CACzE;AAED,UAAU,KAAK;IACb,MAAM,EAAE,KAAK,CAAC,IAAI,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACvC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAMD,yHAAyH;AACzH,wBAAgB,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,KAAK,CAclD;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAQhE;AAED,gFAAgF;AAChF,wBAAgB,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAE3E;AAsED,uFAAuF;AACvF,wBAAsB,SAAS,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,GAAE,cAAmB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAU1G;AAaD,qEAAqE;AACrE,wBAAsB,UAAU,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,GAAE,cAAmB,GAAG,OAAO,CAAC,YAAY,CAAC,CAwFvG;AAaD,MAAM,WAAW,oBAAoB;IACnC,8CAA8C;IAC9C,QAAQ,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,oBAAoB,EAAE,OAAO,CAAC;IAC9B,+DAA+D;IAC/D,WAAW,EAAE,OAAO,CAAC;CACtB;AAED;;;;;GAKG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,EAAE,IAAI,GAAE,cAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CA8B/I;AAED,oDAAoD;AACpD,wBAAgB,aAAa,CAAC,OAAO,EAAE,YAAY,GAAG,WAAW,CAMhE"}

package/dist/api/bind.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Binding the ruler and the Alertmanager for one environment: the config
+ * lookup, the targets, the transports. Shared by observe, live export and
+ * the ruler apply target (#3372), so all three reach the same endpoints.
+ *
+ * The two bind independently. A project that declares only rule groups has
+ * no Alertmanager to bind, and that must not make its groups unobservable.
+ */
+import type { ChantConfig } from "@intentius/chant/config";
+import type { UnobservedReason } from "@intentius/chant/observation";
+import { type PromHttp } from "./client.js";
+import { AlertmanagerApi } from "./alertmanager.js";
+import { RulerApi } from "./ruler.js";
+import { type UnresolvedTarget } from "../config.js";
+/** What callers may inject: tests pass `http` or point the config at a fake server; the CLI passes nothing. */
+export interface BindOptions {
+    environment?: string;
+    /** The project's config. Loaded from `cwd` (default: the working directory) when omitted. */
+    config?: Pick<ChantConfig, "prometheus">;
+    cwd?: string;
+    env?: Record<string, string | undefined>;
+    /** Transport overrides, per endpoint. The targets are still resolved, so a test exercises the binding too. */
+    http?: {
+        ruler?: PromHttp;
+        alertmanager?: PromHttp;
+    };
+}
+/** A target that could not be resolved. */
+export declare class PromBindingError extends Error {
+    readonly unresolved: UnresolvedTarget;
+    constructor(unresolved: UnresolvedTarget);
+}
+/** Both endpoints, each bound or the reason it is not. */
+export interface BoundEndpoints {
+    ruler: RulerApi | UnresolvedTarget;
+    alertmanager: AlertmanagerApi | UnresolvedTarget;
+}
+/** Resolve both endpoints for an environment. Never throws for a missing binding; each side says why it is unbound. */
+export declare function bindEndpoints(options?: BindOptions): Promise<BoundEndpoints>;
+/** The ruler alone, for a caller (the apply target) that needs it bound. Throws {@link PromBindingError} when there is none. */
+export declare function bindRuler(options?: BindOptions): Promise<RulerApi>;
+/** The Alertmanager alone. Throws {@link PromBindingError} when there is none. */
+export declare function bindAlertmanager(options?: BindOptions): Promise<AlertmanagerApi>;
+/** What a failed bind or read means, in the observation vocabulary. */
+export declare function classifyPromFailure(err: unknown): {
+    reason: UnobservedReason;
+    detail: string;
+};
+//# sourceMappingURL=bind.d.ts.map

package/dist/api/bind.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bind.d.ts","sourceRoot":"","sources":["../../src/api/bind.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAsC,KAAK,QAAQ,EAAE,MAAM,UAAU,CAAC;AAC7E,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAqE,KAAK,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAErH,+GAA+G;AAC/G,MAAM,WAAW,WAAW;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6FAA6F;IAC7F,MAAM,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IACzC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IACzC,8GAA8G;IAC9G,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,QAAQ,CAAC;QAAC,YAAY,CAAC,EAAE,QAAQ,CAAA;KAAE,CAAC;CACtD;AAED,2CAA2C;AAC3C,qBAAa,gBAAiB,SAAQ,KAAK;IAC7B,QAAQ,CAAC,UAAU,EAAE,gBAAgB;IAAjD,YAAqB,UAAU,EAAE,gBAAgB,EAGhD;CACF;AAED,0DAA0D;AAC1D,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,QAAQ,GAAG,gBAAgB,CAAC;IACnC,YAAY,EAAE,eAAe,GAAG,gBAAgB,CAAC;CAClD;AAYD,uHAAuH;AACvH,wBAAsB,aAAa,CAAC,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,cAAc,CAAC,CAStF;AAED,gIAAgI;AAChI,wBAAsB,SAAS,CAAC,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAI5E;AAED,kFAAkF;AAClF,wBAAsB,gBAAgB,CAAC,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,eAAe,CAAC,CAI1F;AAED,uEAAuE;AACvE,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,OAAO,GAAG;IAAE,MAAM,EAAE,gBAAgB,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAQ9F"}

package/dist/api/client.d.ts

@@ -0,0 +1,76 @@
+/**
+ * The HTTP transport for the ruler and Alertmanager APIs (#3371): one client
+ * for observe and live export here, and for the ruler apply target (#3372),
+ * so every path reaches the same endpoint with the same tenant and
+ * credentials.
+ *
+ * `PromHttp` is the seam. The default is `fetch` against a resolved target;
+ * a test hands in a function, or points the target at a local fake server
+ * (./fake-servers.ts).
+ *
+ * Bodies are text. The ruler's config API speaks YAML both ways, the
+ * Prometheus-compatible APIs answer JSON, and Mimir's Alertmanager config
+ * API answers YAML, so the caller decides how to read a body.
+ *
+ * Status mapping is in one place ({@link statusVerdict}): a 404 is the only
+ * answer that means "not there", 401 and 403 mean the credentials were
+ * refused, anything else that is not a 2xx is a failed read.
+ */
+/** How the client authenticates. */
+export type PromAuth = {
+    readonly token: string;
+} | {
+    readonly user: string;
+    readonly password: string;
+};
+/** A resolved endpoint: where, as which tenant, as whom, and where that came from. */
+export interface PromTarget {
+    /** Base URL, without a trailing slash. */
+    readonly url: string;
+    /** `X-Scope-OrgID`, for a multi-tenant Mimir, Cortex or Loki. */
+    readonly tenant?: string;
+    readonly auth?: PromAuth;
+    /** Where the binding came from: `prometheus.profiles.prod.ruler`, `env PROMETHEUS_RULER_URL`. */
+    readonly source: string;
+}
+export interface PromResponse {
+    readonly status: number;
+    readonly text: string;
+}
+/** One request. `path` starts with `/` and is relative to the target's URL. */
+export type PromHttp = (method: string, path: string, body?: {
+    text: string;
+    contentType: string;
+}) => Promise<PromResponse>;
+/** The default transport: `fetch` against the target, with the tenant header and credentials on every request. */
+export declare function promHttp(target: PromTarget, fetchImpl?: typeof fetch): PromHttp;
+/** What a status means for a read. */
+export type StatusVerdict = "ok" | "not-found" | "refused" | "failed";
+export declare function statusVerdict(status: number): StatusVerdict;
+/** A non-2xx answer, with enough to classify it and to say where it came from. */
+export declare class PromApiError extends Error {
+    readonly status: number;
+    readonly method: string;
+    readonly path: string;
+    readonly verdict: StatusVerdict;
+    constructor(status: number, method: string, path: string, body: string);
+}
+/** A bound client: the transport, the target it reaches, and a per-client memo so N reads share one lookup. */
+export declare class PromClient {
+    readonly http: PromHttp;
+    readonly target: PromTarget;
+    private readonly memo;
+    constructor(http: PromHttp, target: PromTarget);
+    /** GET, returning the body text; undefined on 404; throws {@link PromApiError} on any other non-2xx. */
+    getText(path: string): Promise<string | undefined>;
+    /** GET a JSON body; undefined on 404. A 2xx body that is not JSON is a failed read. */
+    getJson<T = unknown>(path: string): Promise<T | undefined>;
+    /** A write. Resolves on a 2xx; throws {@link PromApiError} otherwise, a 404 included. */
+    send(method: "POST" | "PUT" | "DELETE", path: string, body?: {
+        text: string;
+        contentType: string;
+    }): Promise<PromResponse>;
+    /** Run `fn` once per key for this client's lifetime; concurrent callers share the promise. A failure is not cached. */
+    once<T>(key: string, fn: () => Promise<T>): Promise<T>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/api/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,oCAAoC;AACpC,MAAM,MAAM,QAAQ,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAEzG,sFAAsF;AACtF,MAAM,WAAW,UAAU;IACzB,0CAA0C;IAC1C,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,iEAAiE;IACjE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC;IACzB,iGAAiG;IACjG,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,+EAA+E;AAC/E,MAAM,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;AAQ7H,kHAAkH;AAClH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,UAAU,EAAE,SAAS,GAAE,OAAO,KAAa,GAAG,QAAQ,CAetF;AAED,sCAAsC;AACtC,MAAM,MAAM,aAAa,GAAG,IAAI,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEtE,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,CAK3D;AAED,kFAAkF;AAClF,qBAAa,YAAa,SAAQ,KAAK;IAGnC,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM;IAJvB,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;IAChC,YACW,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACrB,IAAI,EAAE,MAAM,EAMb;CACF;AAED,+GAA+G;AAC/G,qBAAa,UAAU;IAInB,QAAQ,CAAC,IAAI,EAAE,QAAQ;IACvB,QAAQ,CAAC,MAAM,EAAE,UAAU;IAJ7B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAuC;IAE5D,YACW,IAAI,EAAE,QAAQ,EACd,MAAM,EAAE,UAAU,EACzB;IAEJ,wGAAwG;IAClG,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAMvD;IAED,uFAAuF;IACjF,OAAO,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAQ/D;IAED,yFAAyF;IACnF,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,KAAK,GAAG,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAI/H;IAED,uHAAuH;IACvH,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAQrD;CACF"}

package/dist/api/evaluated.d.ts

@@ -0,0 +1,36 @@
+/**
+ * What `/api/v1/rules` says about a group, mapped two ways (#3371): to the
+ * group's health for `describeResources`, and, for a plain Prometheus,
+ * which has no rule group API, back to the rule-file shape for import.
+ *
+ * The second mapping is lossy, and says so. `/api/v1/rules` reports rules
+ * as Prometheus evaluates them, not as the file wrote them: `query` is the
+ * expression as PromQL prints it, durations are seconds, and a group's
+ * `interval` is the one it runs on, the global `evaluation_interval` when
+ * the group set none. A group's `labels` and `query_offset` are not
+ * reported at all.
+ */
+import type { RuleGroupConfig } from "../model.js";
+import type { EvaluatedGroup } from "./ruler.js";
+/** What the import of evaluated groups leaves out, said once per export. */
+export declare const EVALUATED_IMPORT_WARNING: string;
+/** A group from `/api/v1/rules` in the rule-file shape. */
+export declare function evaluatedToRuleGroup(group: EvaluatedGroup): RuleGroupConfig;
+/** A group's health, from its rules: `err` when any rule failed its last evaluation, `ok` when every rule passed, else `unknown`. */
+export interface GroupHealth {
+    health: "ok" | "err" | "unknown";
+    /** The first rule error, as `<rule>: <error>`. */
+    lastError?: string;
+    /** How many rules failed their last evaluation. */
+    failing: number;
+    /** Alerting rules by state. */
+    firing: number;
+    pending: number;
+    lastEvaluation?: string;
+    /** Seconds the last evaluation took. */
+    evaluationTime?: number;
+    /** Seconds. */
+    interval?: number;
+}
+export declare function groupHealth(group: EvaluatedGroup): GroupHealth;
+//# sourceMappingURL=evaluated.d.ts.map

package/dist/api/evaluated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"evaluated.d.ts","sourceRoot":"","sources":["../../src/api/evaluated.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAGH,OAAO,KAAK,EAAc,eAAe,EAAE,MAAM,UAAU,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAc9C,4EAA4E;AAC5E,eAAO,MAAM,wBAAwB,QAEqH,CAAC;AAE3J,2DAA2D;AAC3D,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,cAAc,GAAG,eAAe,CA0B3E;AAED,qIAAqI;AACrI,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,IAAI,GAAG,KAAK,GAAG,SAAS,CAAC;IACjC,kDAAkD;IAClD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mDAAmD;IACnD,OAAO,EAAE,MAAM,CAAC;IAChB,+BAA+B;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,wCAAwC;IACxC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,cAAc,GAAG,WAAW,CAyB9D"}

package/dist/api/fake-servers.d.ts

@@ -0,0 +1,74 @@
+/**
+ * A ruler and an Alertmanager in memory, for the observe and export tests
+ * (#3371), and for the ruler apply target's (#3372).
+ *
+ * Each fake is a request handler over a state the test sets up. It answers
+ * the routes ./ruler.ts and ./alertmanager.ts use, in the shapes the
+ * projects document: the ruler config API's YAML (a mapping of namespace to
+ * groups; one group alone at `/{namespace}/{group}`; 404 for a namespace or
+ * group that is not there), `/api/v1/rules` JSON, Alertmanager's
+ * `/api/v2/status` and Mimir's `/api/v1/alerts`. With `tenant` set it
+ * answers 401 to a request without that `X-Scope-OrgID`, as Mimir does
+ * ("no org id").
+ *
+ * {@link serveFake} puts a handler behind a real HTTP server on localhost,
+ * so a test drives the default `fetch` transport, headers included.
+ * {@link fakeHttp} hands the same handler in as a {@link PromHttp}.
+ */
+import type { RulerKind } from "../config.js";
+import type { PromHttp } from "./client.js";
+import type { EvaluatedGroup, RawRuleGroup } from "./ruler.js";
+export interface FakeRequest {
+    method: string;
+    path: string;
+    headers: Record<string, string | undefined>;
+    body?: string;
+}
+export interface FakeResponse {
+    status: number;
+    text: string;
+    contentType?: string;
+}
+export type FakeHandler = (req: FakeRequest) => FakeResponse;
+export interface FakeRulerState {
+    kind: RulerKind;
+    /** Groups by namespace (on a plain Prometheus, by rule file). */
+    namespaces: Record<string, RawRuleGroup[]>;
+    /** What `/api/v1/rules` reports. Defaults to every group, every rule healthy and inactive. */
+    evaluated?: EvaluatedGroup[];
+    /** Required `X-Scope-OrgID`. */
+    tenant?: string;
+    /** Answer every request with this status. */
+    status?: number;
+    /** Answer `/api/v1/rules` with this status (a ruler whose evaluation API is down). */
+    evaluatedStatus?: number;
+    prometheusPrefix?: string;
+}
+export interface FakeAlertmanagerState {
+    kind: "alertmanager" | "mimir" | "cortex";
+    /** `/api/v2/status` `config.original`. */
+    original?: string;
+    /** Mimir and Cortex: the uploaded config, absent for a tenant with none. */
+    uploaded?: {
+        alertmanager_config: string;
+        template_files?: Record<string, string>;
+    };
+    cluster?: string;
+    version?: string;
+    tenant?: string;
+    status?: number;
+}
+/** What `/api/v1/rules` reports for a group nobody set an evaluation for: every rule healthy. */
+export declare function evaluatedOf(file: string, group: RawRuleGroup): EvaluatedGroup;
+/** A ruler over `state`. Writes change `state`, so a test can read back what an apply did. */
+export declare function fakeRuler(state: FakeRulerState, calls?: string[]): FakeHandler;
+/** An Alertmanager over `state`: a plain one's `/api/v2/status`, or Mimir's and Cortex's `/api/v1/alerts` and per-tenant status. */
+export declare function fakeAlertmanager(state: FakeAlertmanagerState, calls?: string[]): FakeHandler;
+/** A handler as a {@link PromHttp}, with no headers (a tenant-checking fake then refuses; use {@link serveFake} for those). */
+export declare function fakeHttp(handler: FakeHandler, headers?: Record<string, string>): PromHttp;
+/** A handler behind a real HTTP server on 127.0.0.1, on a free port. `close()` stops it. */
+export declare function serveFake(handler: FakeHandler): Promise<{
+    url: string;
+    close: () => Promise<void>;
+}>;
+//# sourceMappingURL=fake-servers.d.ts.map

package/dist/api/fake-servers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fake-servers.d.ts","sourceRoot":"","sources":["../../src/api/fake-servers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAMH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5D,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,WAAW,GAAG,CAAC,GAAG,EAAE,WAAW,KAAK,YAAY,CAAC;AAE7D,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,SAAS,CAAC;IAChB,iEAAiE;IACjE,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;IAC3C,8FAA8F;IAC9F,SAAS,CAAC,EAAE,cAAc,EAAE,CAAC;IAC7B,gCAAgC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,sFAAsF;IACtF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,cAAc,GAAG,OAAO,GAAG,QAAQ,CAAC;IAC1C,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4EAA4E;IAC5E,QAAQ,CAAC,EAAE;QAAE,mBAAmB,EAAE,MAAM,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;IACpF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAYD,iGAAiG;AACjG,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,cAAc,CAY7E;AAED,8FAA8F;AAC9F,wBAAgB,SAAS,CAAC,KAAK,EAAE,cAAc,EAAE,KAAK,GAAE,MAAM,EAAO,GAAG,WAAW,CA8ClF;AAED,oIAAoI;AACpI,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,EAAE,KAAK,GAAE,MAAM,EAAO,GAAG,WAAW,CA8BhG;AAED,+HAA+H;AAC/H,wBAAgB,QAAQ,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GAAG,QAAQ,CAK7F;AAYD,4FAA4F;AAC5F,wBAAsB,SAAS,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAAE,CAAC,CAc1G"}

package/dist/api/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * The ruler and Alertmanager API clients (#3371), as
+ * `@intentius/chant-lexicon-prometheus/api`.
+ *
+ * One transport for observe, live export and the ruler apply target
+ * (#3372): bind with {@link bindEndpoints} (or {@link bindRuler} /
+ * {@link bindAlertmanager}), then read and write through {@link RulerApi}
+ * and {@link AlertmanagerApi}. The ownership boundary is
+ * {@link declaredNamespaces}: nothing outside it is read for import, and an
+ * apply must not write or delete outside it.
+ */
+export { PromApiError, PromClient, promHttp, statusVerdict, type PromAuth, type PromHttp, type PromResponse, type PromTarget, type StatusVerdict } from "./client.js";
+export { RulerApi, type EvaluatedGroup, type EvaluatedRule, type RawRuleGroup } from "./ruler.js";
+export { AlertmanagerApi, type AlertmanagerHealth, type LiveAlertmanagerConfig } from "./alertmanager.js";
+export { evaluatedToRuleGroup, groupHealth, type GroupHealth } from "./evaluated.js";
+export { bindAlertmanager, bindEndpoints, bindRuler, classifyPromFailure, PromBindingError, type BindOptions, type BoundEndpoints } from "./bind.js";
+export { ALERTMANAGER_KINDS, RULER_KINDS, declaredNamespaces, namespaceOfGroup, resolveAlertmanagerTarget, resolveRulerTarget, type AlertmanagerKind, type AlertmanagerTarget, type RulerKind, type RulerTarget, } from "../config.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,aAAa,EAAE,KAAK,QAAQ,EAAE,KAAK,QAAQ,EAAE,KAAK,YAAY,EAAE,KAAK,UAAU,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AACnK,OAAO,EAAE,QAAQ,EAAE,KAAK,cAAc,EAAE,KAAK,aAAa,EAAE,KAAK,YAAY,EAAE,MAAM,SAAS,CAAC;AAC/F,OAAO,EAAE,eAAe,EAAE,KAAK,kBAAkB,EAAE,KAAK,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AACvG,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC;AAClF,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,SAAS,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,KAAK,WAAW,EAAE,KAAK,cAAc,EAAE,MAAM,QAAQ,CAAC;AAClJ,OAAO,EACL,kBAAkB,EAClB,WAAW,EACX,kBAAkB,EAClB,gBAAgB,EAChB,yBAAyB,EACzB,kBAAkB,EAClB,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,SAAS,EACd,KAAK,WAAW,GACjB,MAAM,WAAW,CAAC"}

package/dist/api/ruler.d.ts

@@ -0,0 +1,87 @@
+/**
+ * The ruler APIs (#3371): Mimir's, Cortex's and Loki's rule group config
+ * API, and the Prometheus-compatible `/api/v1/rules` every one of them (and
+ * a plain Prometheus) serves with each group's evaluation state.
+ *
+ * | Kind | Config API (YAML) | Evaluated rules (JSON) |
+ * |---|---|---|
+ * | `mimir` | `<prefix>/config/v1/rules[/{namespace}[/{group}]]` | `<prefix>/api/v1/rules` |
+ * | `cortex` | `/api/v1/rules[/{namespace}[/{group}]]` | `<prefix>/api/v1/rules` |
+ * | `loki` | `/loki/api/v1/rules[/{namespace}[/{group}]]` | `/prometheus/api/v1/rules` |
+ * | `prometheus` | none: rule files on disk | `/api/v1/rules` |
+ *
+ * `<prefix>` is `-http.prometheus-http-prefix`, `/prometheus` unless the
+ * profile says otherwise. Mimir does not register Cortex's `/api/v1/rules`
+ * config path. Every request carries the target's `X-Scope-OrgID`.
+ *
+ * The writes (`setGroup`, `deleteGroup`) are here for the ruler apply
+ * target (#3372), which reuses this module through
+ * `@intentius/chant-lexicon-prometheus/api`. Nothing here deletes a
+ * namespace: an apply bounded by the declared namespaces deletes groups one
+ * by one, and only inside {@link declaredNamespaces}.
+ */
+import type { RuleGroupConfig } from "../model.js";
+import type { RulerTarget } from "../config.js";
+import { type PromClient } from "./client.js";
+type Json = Record<string, unknown>;
+/** A rule group as the ruler's config API returns it: the rule-file shape, plus whatever the ruler adds (`source_tenants`, say). */
+export type RawRuleGroup = Json & {
+    name: string;
+};
+/** One rule as `/api/v1/rules` reports it. */
+export interface EvaluatedRule {
+    type: "alerting" | "recording";
+    name: string;
+    query: string;
+    /** Seconds. Alerting rules only. */
+    duration?: number;
+    /** Seconds. Alerting rules only. */
+    keepFiringFor?: number;
+    labels?: Record<string, string>;
+    annotations?: Record<string, string>;
+    health?: "ok" | "err" | "unknown" | string;
+    lastError?: string;
+    /** `inactive`, `pending` or `firing`. Alerting rules only. */
+    state?: string;
+    lastEvaluation?: string;
+    evaluationTime?: number;
+}
+/** One group as `/api/v1/rules` reports it. `file` is the rule file on a Prometheus, the namespace on a ruler. */
+export interface EvaluatedGroup {
+    name: string;
+    file: string;
+    /** Seconds. */
+    interval?: number;
+    limit?: number;
+    rules: EvaluatedRule[];
+    lastEvaluation?: string;
+    evaluationTime?: number;
+}
+/** A bound ruler: the transport and the target it reaches. */
+export declare class RulerApi {
+    readonly client: PromClient;
+    readonly target: RulerTarget;
+    constructor(client: PromClient, target: RulerTarget);
+    /** The base of the rule group config API, or undefined for a plain Prometheus, which has none. */
+    get configPath(): string | undefined;
+    /** The Prometheus-compatible rules endpoint, with evaluation state. */
+    get evaluatedPath(): string;
+    private requireConfigPath;
+    private parseNamespaces;
+    /** Every namespace the tenant has, with its groups. A 404 (Mimir: "no rule groups found") is none. */
+    listNamespaces(): Promise<Record<string, RawRuleGroup[]>>;
+    /** One namespace's groups; undefined when the ruler has no such namespace. */
+    readNamespace(namespace: string): Promise<RawRuleGroup[] | undefined>;
+    /** The path {@link readGroup} reads, for `queried`. */
+    groupPath(namespace: string, group: string): string;
+    /** One group; undefined when it is not there. */
+    readGroup(namespace: string, group: string): Promise<RawRuleGroup | undefined>;
+    /** Create or replace one group in `namespace` (202 on Mimir, Cortex and Loki). */
+    setGroup(namespace: string, group: RuleGroupConfig | RawRuleGroup): Promise<void>;
+    /** Delete one group from `namespace`. */
+    deleteGroup(namespace: string, group: string): Promise<void>;
+    /** Every group the ruler evaluates, with its health. Read once per client. */
+    evaluated(): Promise<EvaluatedGroup[]>;
+}
+export {};
+//# sourceMappingURL=ruler.d.ts.map

package/dist/api/ruler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ruler.d.ts","sourceRoot":"","sources":["../../src/api/ruler.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAEhD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAgB,KAAK,UAAU,EAAE,MAAM,UAAU,CAAC;AAEzD,KAAK,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEpC,oIAAoI;AACpI,MAAM,MAAM,YAAY,GAAG,IAAI,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnD,8CAA8C;AAC9C,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,UAAU,GAAG,WAAW,CAAC;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,MAAM,CAAC,EAAE,IAAI,GAAG,KAAK,GAAG,SAAS,GAAG,MAAM,CAAC;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8DAA8D;IAC9D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,kHAAkH;AAClH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,eAAe;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAQD,8DAA8D;AAC9D,qBAAa,QAAQ;IAEjB,QAAQ,CAAC,MAAM,EAAE,UAAU;IAC3B,QAAQ,CAAC,MAAM,EAAE,WAAW;IAF9B,YACW,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,WAAW,EAC1B;IAEJ,kGAAkG;IAClG,IAAI,UAAU,IAAI,MAAM,GAAG,SAAS,CAWnC;IAED,uEAAuE;IACvE,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,eAAe;IAUvB,sGAAsG;IAChG,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC,CAI9D;IAED,8EAA8E;IACxE,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,GAAG,SAAS,CAAC,CAK1E;IAED,uDAAuD;IACvD,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAElD;IAED,iDAAiD;IAC3C,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAOnF;IAED,kFAAkF;IAC5E,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,GAAG,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAEtF;IAED,yCAAyC;IACnC,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAEjE;IAED,8EAA8E;IACxE,SAAS,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC,CAY3C;CACF"}