@intentius/chant-lexicon-prometheus 0.96.0

package/dist/model.d.ts

@@ -0,0 +1,262 @@
+/**
+ * The plain-data model of a Prometheus rule file and an Alertmanager config.
+ *
+ * Everything else in this lexicon reads or writes these shapes: the serializer
+ * builds them from declared entities, the YAML emitter prints them, the checks
+ * validate them, and other lexicons (the k8s `PrometheusRule`, the SLO
+ * composite, Grafana panels) read them. They are exactly the files' own
+ * layouts, so a parsed rule file or `alertmanager.yml` already is one and
+ * needs no conversion.
+ *
+ * Field names keep the files' snake_case (`keep_firing_for`, `group_wait`),
+ * so a declaration reads the same as the file it produces and the upstream
+ * docs apply word for word.
+ */
+/** Labels or annotations: string keys to string values. */
+export type LabelSet = Record<string, string>;
+/** A recording rule: evaluates `expr` and stores the result as the series `record`. */
+export interface RecordingRuleConfig {
+    /** The metric name the result is stored under, e.g. `job:http_requests:rate5m`. */
+    record: string;
+    /** The PromQL expression. */
+    expr: string;
+    /** Labels added to the stored series. */
+    labels?: LabelSet;
+}
+/** An alerting rule: fires while `expr` returns anything, after `for`. */
+export interface AlertingRuleConfig {
+    /** The alert name, the `alertname` label on every alert it fires. */
+    alert: string;
+    /** The PromQL expression. Every series it returns is one alert. */
+    expr: string;
+    /** How long the expression must hold before the alert fires, e.g. `5m`. */
+    for?: string;
+    /** How long the alert keeps firing after the expression stops returning it. */
+    keep_firing_for?: string;
+    /** Labels added to the alert. Alertmanager routes on these; set `severity`. */
+    labels?: LabelSet;
+    /** Annotations added to the alert, e.g. `summary`, `description`, `runbook_url`. */
+    annotations?: LabelSet;
+}
+export type RuleConfig = RecordingRuleConfig | AlertingRuleConfig;
+/** One entry under `groups:` in a rule file, and one entry in a `PrometheusRule`'s `spec.groups`. */
+export interface RuleGroupConfig {
+    name: string;
+    /** How often the group is evaluated. Defaults to the global `evaluation_interval`. */
+    interval?: string;
+    /** Evaluate the group this far in the past, for late-arriving data. */
+    query_offset?: string;
+    /** Cap on alerts (alerting rules) or series (recording rules) a rule may produce; 0 is no limit. */
+    limit?: number;
+    /** Labels added to every rule in the group. A rule's own labels win. */
+    labels?: LabelSet;
+    rules: RuleConfig[];
+}
+/** A whole rule file, the YAML `rule_files:` points at and `promtool check rules` reads. */
+export interface RuleFileConfig {
+    groups: RuleGroupConfig[];
+}
+export declare function isRecordingRuleConfig(rule: unknown): rule is RecordingRuleConfig;
+export declare function isAlertingRuleConfig(rule: unknown): rule is AlertingRuleConfig;
+/** The rule's name: `record` for a recording rule, `alert` for an alerting rule. */
+export declare function ruleName(rule: RuleConfig): string;
+/** HTTP client settings shared by the receivers that make HTTP calls. */
+export interface HttpClientConfig {
+    basic_auth?: {
+        username?: string;
+        username_file?: string;
+        password?: string;
+        password_file?: string;
+    };
+    authorization?: {
+        type?: string;
+        credentials?: string;
+        credentials_file?: string;
+    };
+    bearer_token?: string;
+    bearer_token_file?: string;
+    oauth2?: Record<string, unknown>;
+    proxy_url?: string;
+    follow_redirects?: boolean;
+    enable_http2?: boolean;
+    tls_config?: {
+        ca_file?: string;
+        cert_file?: string;
+        key_file?: string;
+        server_name?: string;
+        insecure_skip_verify?: boolean;
+        min_version?: string;
+    };
+}
+interface NotifierBase {
+    /** Whether to notify about resolved alerts too. */
+    send_resolved?: boolean;
+}
+export interface WebhookConfig extends NotifierBase {
+    /** Where alerts are POSTed. Set this or `url_file`. */
+    url?: string;
+    url_file?: string;
+    http_config?: HttpClientConfig;
+    /** Most alerts per message; 0 sends them all. */
+    max_alerts?: number;
+    timeout?: string;
+}
+export interface EmailConfig extends NotifierBase {
+    to: string;
+    from?: string;
+    /** `host:port` of the SMTP server. Falls back to `global.smtp_smarthost`. */
+    smarthost?: string;
+    hello?: string;
+    auth_username?: string;
+    auth_password?: string;
+    auth_password_file?: string;
+    auth_secret?: string;
+    auth_secret_file?: string;
+    auth_identity?: string;
+    require_tls?: boolean;
+    tls_config?: HttpClientConfig["tls_config"];
+    html?: string;
+    text?: string;
+    headers?: Record<string, string>;
+}
+export interface SlackConfig extends NotifierBase {
+    /** The incoming-webhook URL. It is a credential: prefer `api_url_file`. */
+    api_url?: string;
+    api_url_file?: string;
+    channel?: string;
+    username?: string;
+    color?: string;
+    title?: string;
+    title_link?: string;
+    pretext?: string;
+    text?: string;
+    footer?: string;
+    fallback?: string;
+    icon_emoji?: string;
+    icon_url?: string;
+    link_names?: boolean;
+    short_fields?: boolean;
+    mrkdwn_in?: string[];
+    fields?: Array<{
+        title: string;
+        value: string;
+        short?: boolean;
+    }>;
+    actions?: Array<Record<string, unknown>>;
+    http_config?: HttpClientConfig;
+}
+export interface PagerDutyConfig extends NotifierBase {
+    /** Events API v2 integration key. A credential: prefer `routing_key_file`. */
+    routing_key?: string;
+    routing_key_file?: string;
+    /** Events API v1 integration key. A credential: prefer `service_key_file`. */
+    service_key?: string;
+    service_key_file?: string;
+    url?: string;
+    client?: string;
+    client_url?: string;
+    description?: string;
+    severity?: string;
+    class?: string;
+    component?: string;
+    group?: string;
+    source?: string;
+    details?: Record<string, string>;
+    links?: Array<{
+        href: string;
+        text?: string;
+    }>;
+    images?: Array<{
+        src: string;
+        alt?: string;
+        href?: string;
+    }>;
+    http_config?: HttpClientConfig;
+}
+/** One entry under `receivers:`. */
+export interface ReceiverConfig {
+    name: string;
+    webhook_configs?: WebhookConfig[];
+    email_configs?: EmailConfig[];
+    slack_configs?: SlackConfig[];
+    pagerduty_configs?: PagerDutyConfig[];
+}
+/** A route in the routing tree. The top-level `route:` is the root. */
+export interface RouteConfig {
+    receiver?: string;
+    group_by?: string[];
+    continue?: boolean;
+    /** Matchers in Alertmanager's syntax, e.g. `severity="critical"` or `team=~"db|infra"`. */
+    matchers?: string[];
+    group_wait?: string;
+    group_interval?: string;
+    repeat_interval?: string;
+    mute_time_intervals?: string[];
+    active_time_intervals?: string[];
+    routes?: RouteConfig[];
+}
+/** One entry under `inhibit_rules:`. */
+export interface InhibitRuleConfig {
+    source_matchers?: string[];
+    target_matchers?: string[];
+    /** Labels that must be equal on source and target for the inhibition to apply. */
+    equal?: string[];
+}
+export interface TimeRangeConfig {
+    start_time: string;
+    end_time: string;
+}
+/** One period inside a time interval. Every field left out matches everything. */
+export interface TimePeriodConfig {
+    times?: TimeRangeConfig[];
+    /** e.g. `monday:friday`, `saturday`. */
+    weekdays?: string[];
+    /** e.g. `1:5`, `-1`. */
+    days_of_month?: string[];
+    /** e.g. `january:march`, `12`. */
+    months?: string[];
+    /** e.g. `2026:2027`. */
+    years?: string[];
+    /** An IANA time zone name, e.g. `Europe/Berlin`. Defaults to UTC. */
+    location?: string;
+}
+/** One entry under `time_intervals:`. */
+export interface TimeIntervalConfig {
+    name: string;
+    time_intervals: TimePeriodConfig[];
+}
+/** `global:` settings. */
+export interface AlertmanagerGlobalConfig {
+    resolve_timeout?: string;
+    smtp_from?: string;
+    smtp_smarthost?: string;
+    smtp_hello?: string;
+    smtp_auth_username?: string;
+    smtp_auth_password?: string;
+    smtp_auth_password_file?: string;
+    smtp_auth_secret?: string;
+    smtp_auth_secret_file?: string;
+    smtp_auth_identity?: string;
+    smtp_require_tls?: boolean;
+    slack_api_url?: string;
+    slack_api_url_file?: string;
+    pagerduty_url?: string;
+    http_config?: HttpClientConfig;
+}
+/** A whole `alertmanager.yml`, the file `amtool check-config` reads. */
+export interface AlertmanagerConfig {
+    global?: AlertmanagerGlobalConfig;
+    templates?: string[];
+    route?: RouteConfig;
+    inhibit_rules?: InhibitRuleConfig[];
+    receivers?: ReceiverConfig[];
+    time_intervals?: TimeIntervalConfig[];
+}
+/** The four receiver integrations this lexicon types. */
+export declare const RECEIVER_INTEGRATIONS: readonly ["webhook_configs", "email_configs", "slack_configs", "pagerduty_configs"];
+/** True when a parsed document has the shape of a Prometheus rule file. */
+export declare function looksLikeRuleFile(value: unknown): value is RuleFileConfig;
+/** True when a parsed document has the shape of an `alertmanager.yml`. */
+export declare function looksLikeAlertmanagerConfig(value: unknown): value is AlertmanagerConfig;
+export {};
+//# sourceMappingURL=model.d.ts.map

package/dist/model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,2DAA2D;AAC3D,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAE9C,uFAAuF;AACvF,MAAM,WAAW,mBAAmB;IAClC,mFAAmF;IACnF,MAAM,EAAE,MAAM,CAAC;IACf,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,MAAM,CAAC,EAAE,QAAQ,CAAC;CACnB;AAED,0EAA0E;AAC1E,MAAM,WAAW,kBAAkB;IACjC,qEAAqE;IACrE,KAAK,EAAE,MAAM,CAAC;IACd,mEAAmE;IACnE,IAAI,EAAE,MAAM,CAAC;IACb,2EAA2E;IAC3E,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,+EAA+E;IAC/E,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,+EAA+E;IAC/E,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,oFAAoF;IACpF,WAAW,CAAC,EAAE,QAAQ,CAAC;CACxB;AAED,MAAM,MAAM,UAAU,GAAG,mBAAmB,GAAG,kBAAkB,CAAC;AAElE,qGAAqG;AACrG,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,sFAAsF;IACtF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,uEAAuE;IACvE,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oGAAoG;IACpG,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wEAAwE;IACxE,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,KAAK,EAAE,UAAU,EAAE,CAAC;CACrB;AAED,4FAA4F;AAC5F,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,eAAe,EAAE,CAAC;CAC3B;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,mBAAmB,CAEhF;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,kBAAkB,CAE9E;AAED,oFAAoF;AACpF,wBAAgB,QAAQ,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAEjD;AAID,yEAAyE;AACzE,MAAM,WAAW,gBAAgB;IAC/B,UAAU,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACtG,aAAa,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACnF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,UAAU,CAAC,EAAE;QACX,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,oBAAoB,CAAC,EAAE,OAAO,CAAC;QAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED,UAAU,YAAY;IACpB,mDAAmD;IACnD,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,aAAc,SAAQ,YAAY;IACjD,uDAAuD;IACvD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAC/B,iDAAiD;IACjD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC/C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,6EAA6E;IAC7E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC/C,2EAA2E;IAC3E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,MAAM,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAClE,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACzC,WAAW,CAAC,EAAE,gBAAgB,CAAC;CAChC;AAED,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,8EAA8E;IAC9E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,8EAA8E;IAC9E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,KAAK,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC/C,MAAM,CAAC,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC7D,WAAW,CAAC,EAAE,gBAAgB,CAAC;CAChC;AAED,oCAAoC;AACpC,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,CAAC,EAAE,aAAa,EAAE,CAAC;IAClC,aAAa,CAAC,EAAE,WAAW,EAAE,CAAC;IAC9B,aAAa,CAAC,EAAE,WAAW,EAAE,CAAC;IAC9B,iBAAiB,CAAC,EAAE,eAAe,EAAE,CAAC;CACvC;AAED,uEAAuE;AACvE,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,2FAA2F;IAC3F,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IACjC,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;CACxB;AAED,wCAAwC;AACxC,MAAM,WAAW,iBAAiB;IAChC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,kFAAkF;IAClF,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,kFAAkF;AAClF,MAAM,WAAW,gBAAgB;IAC/B,KAAK,CAAC,EAAE,eAAe,EAAE,CAAC;IAC1B,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,wBAAwB;IACxB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,kCAAkC;IAClC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,wBAAwB;IACxB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,qEAAqE;IACrE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yCAAyC;AACzC,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,gBAAgB,EAAE,CAAC;CACpC;AAED,0BAA0B;AAC1B,MAAM,WAAW,wBAAwB;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,gBAAgB,CAAC;CAChC;AAED,wEAAwE;AACxE,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,wBAAwB,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,aAAa,CAAC,EAAE,iBAAiB,EAAE,CAAC;IACpC,SAAS,CAAC,EAAE,cAAc,EAAE,CAAC;IAC7B,cAAc,CAAC,EAAE,kBAAkB,EAAE,CAAC;CACvC;AAED,yDAAyD;AACzD,eAAO,MAAM,qBAAqB,qFAAsF,CAAC;AAEzH,2EAA2E;AAC3E,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,cAAc,CAOzE;AAED,0EAA0E;AAC1E,wBAAgB,2BAA2B,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,kBAAkB,CASvF"}

package/dist/okf/index.md

@@ -0,0 +1,34 @@
+---
+okf_version: '0.2'
+---
+
+# Resource types
+
+* [AlertmanagerSettings](/types/AlertmanagerSettings.md) - Prometheus::Alertmanager::Settings
+* [InhibitRule](/types/InhibitRule.md) - Prometheus::Alertmanager::InhibitRule
+* [Receiver](/types/Receiver.md) - Prometheus::Alertmanager::Receiver
+* [Route](/types/Route.md) - Prometheus::Alertmanager::Route
+* [RuleGroup](/types/RuleGroup.md) - Prometheus::Rules::RuleGroup
+* [TimeInterval](/types/TimeInterval.md) - Prometheus::Alertmanager::TimeInterval
+
+# Rules
+
+* [PROM001](/rules/PROM001.md) - a credential written as a literal in a `Receiver` or
+* [PROM002](/rules/PROM002.md) - a rule's `expr`, written as a string literal inside a
+* [PROM003](/rules/PROM003.md) - an `Slo` whose literal objective, window or SLI expression can
+* [PROM101](/rules/PROM101.md) - Two rule groups in one rule file share a name
+* [PROM102](/rules/PROM102.md) - Two rules share a name and label set
+* [PROM103](/rules/PROM103.md) - A rule or group duration is not a Prometheus duration
+* [PROM104](/rules/PROM104.md) - A rule expression is not valid PromQL
+* [PROM105](/rules/PROM105.md) - A rule or group is malformed
+* [PROM106](/rules/PROM106.md) - An alerting rule has no severity label
+* [PROM107](/rules/PROM107.md) - An alerting rule has no summary or description annotation
+* [PROM201](/rules/PROM201.md) - A route sends to a receiver that is not declared
+* [PROM202](/rules/PROM202.md) - An alert severity is not routed by any route
+* [PROM203](/rules/PROM203.md) - Two receivers or two time intervals share a name
+* [PROM204](/rules/PROM204.md) - A route names a time interval that is not declared
+* [PROM205](/rules/PROM205.md) - The root route is missing, has no receiver, or has matchers
+* [PROM206](/rules/PROM206.md) - A route or inhibit rule matcher does not parse
+* [PROM207](/rules/PROM207.md) - A receiver is declared but no route sends to it
+* [PROM208](/rules/PROM208.md) - An Alertmanager duration is not a duration
+* [PROM209](/rules/PROM209.md) - A receiver integration is missing its destination or credential

package/dist/okf/rules/PROM001.md

@@ -0,0 +1,16 @@
+---
+type: lint-rule
+title: PROM001
+description: a credential written as a literal in a `Receiver` or
+id: PROM001
+severity: error
+category: security
+lexicon: prometheus
+docs: https://intentius.io/chant/lexicons/prometheus/rules/
+---
+a credential written as a literal in a `Receiver` or
+
+## Applies to
+
+- [AlertmanagerSettings](/types/AlertmanagerSettings.md)
+- [Receiver](/types/Receiver.md)

package/dist/okf/rules/PROM002.md

@@ -0,0 +1,15 @@
+---
+type: lint-rule
+title: PROM002
+description: a rule's `expr`, written as a string literal inside a
+id: PROM002
+severity: error
+category: correctness
+lexicon: prometheus
+docs: https://intentius.io/chant/lexicons/prometheus/rules/
+---
+a rule's `expr`, written as a string literal inside a
+
+## Applies to
+
+- [RuleGroup](/types/RuleGroup.md)

package/dist/okf/rules/PROM003.md

@@ -0,0 +1,11 @@
+---
+type: lint-rule
+title: PROM003
+description: an `Slo` whose literal objective, window or SLI expression can
+id: PROM003
+severity: error
+category: correctness
+lexicon: prometheus
+docs: https://intentius.io/chant/lexicons/prometheus/rules/
+---
+an `Slo` whose literal objective, window or SLI expression can

package/dist/okf/rules/PROM101.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: PROM101
+description: Two rule groups in one rule file share a name
+id: PROM101
+severity: error
+category: post-synth
+lexicon: prometheus
+docs: https://intentius.io/chant/lexicons/prometheus/rules/
+---
+Two rule groups in one rule file share a name

package/dist/okf/rules/PROM102.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: PROM102
+description: Two rules share a name and label set
+id: PROM102
+severity: error
+category: post-synth
+lexicon: prometheus
+docs: https://intentius.io/chant/lexicons/prometheus/rules/
+---
+Two rules share a name and label set

package/dist/okf/rules/PROM103.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: PROM103
+description: A rule or group duration is not a Prometheus duration
+id: PROM103
+severity: error
+category: post-synth
+lexicon: prometheus
+docs: https://intentius.io/chant/lexicons/prometheus/rules/
+---
+A rule or group duration is not a Prometheus duration

package/dist/okf/rules/PROM104.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: PROM104
+description: A rule expression is not valid PromQL
+id: PROM104
+severity: error
+category: post-synth
+lexicon: prometheus
+docs: https://intentius.io/chant/lexicons/prometheus/rules/
+---
+A rule expression is not valid PromQL

package/dist/okf/rules/PROM105.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: PROM105
+description: A rule or group is malformed
+id: PROM105
+severity: error
+category: post-synth
+lexicon: prometheus
+docs: https://intentius.io/chant/lexicons/prometheus/rules/
+---
+A rule or group is malformed

package/dist/okf/rules/PROM106.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: PROM106
+description: An alerting rule has no severity label
+id: PROM106
+severity: error
+category: post-synth
+lexicon: prometheus
+docs: https://intentius.io/chant/lexicons/prometheus/rules/
+---
+An alerting rule has no severity label

package/dist/okf/rules/PROM107.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: PROM107
+description: An alerting rule has no summary or description annotation
+id: PROM107
+severity: error
+category: post-synth
+lexicon: prometheus
+docs: https://intentius.io/chant/lexicons/prometheus/rules/
+---
+An alerting rule has no summary or description annotation

package/dist/okf/rules/PROM201.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: PROM201
+description: A route sends to a receiver that is not declared
+id: PROM201
+severity: error
+category: post-synth
+lexicon: prometheus
+docs: https://intentius.io/chant/lexicons/prometheus/rules/
+---
+A route sends to a receiver that is not declared

package/dist/okf/rules/PROM202.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: PROM202
+description: An alert severity is not routed by any route
+id: PROM202
+severity: error
+category: post-synth
+lexicon: prometheus
+docs: https://intentius.io/chant/lexicons/prometheus/rules/
+---
+An alert severity is not routed by any route

package/dist/okf/rules/PROM203.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: PROM203
+description: Two receivers or two time intervals share a name
+id: PROM203
+severity: error
+category: post-synth
+lexicon: prometheus
+docs: https://intentius.io/chant/lexicons/prometheus/rules/
+---
+Two receivers or two time intervals share a name

package/dist/okf/rules/PROM204.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: PROM204
+description: A route names a time interval that is not declared
+id: PROM204
+severity: error
+category: post-synth
+lexicon: prometheus
+docs: https://intentius.io/chant/lexicons/prometheus/rules/
+---
+A route names a time interval that is not declared

package/dist/okf/rules/PROM205.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: PROM205
+description: The root route is missing, has no receiver, or has matchers
+id: PROM205
+severity: error
+category: post-synth
+lexicon: prometheus
+docs: https://intentius.io/chant/lexicons/prometheus/rules/
+---
+The root route is missing, has no receiver, or has matchers

package/dist/okf/rules/PROM206.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: PROM206
+description: A route or inhibit rule matcher does not parse
+id: PROM206
+severity: error
+category: post-synth
+lexicon: prometheus
+docs: https://intentius.io/chant/lexicons/prometheus/rules/
+---
+A route or inhibit rule matcher does not parse

package/dist/okf/rules/PROM207.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: PROM207
+description: A receiver is declared but no route sends to it
+id: PROM207
+severity: error
+category: post-synth
+lexicon: prometheus
+docs: https://intentius.io/chant/lexicons/prometheus/rules/
+---
+A receiver is declared but no route sends to it

package/dist/okf/rules/PROM208.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: PROM208
+description: An Alertmanager duration is not a duration
+id: PROM208
+severity: error
+category: post-synth
+lexicon: prometheus
+docs: https://intentius.io/chant/lexicons/prometheus/rules/
+---
+An Alertmanager duration is not a duration

package/dist/okf/rules/PROM209.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: PROM209
+description: A receiver integration is missing its destination or credential
+id: PROM209
+severity: error
+category: post-synth
+lexicon: prometheus
+docs: https://intentius.io/chant/lexicons/prometheus/rules/
+---
+A receiver integration is missing its destination or credential

package/dist/okf/types/AlertmanagerSettings.md

@@ -0,0 +1,13 @@
+---
+type: resource-type
+title: AlertmanagerSettings
+description: prometheus resource type Prometheus::Alertmanager::Settings
+name: AlertmanagerSettings
+lexicon: prometheus
+resource_type: Prometheus::Alertmanager::Settings
+---
+`Prometheus::Alertmanager::Settings`, a resource type of the prometheus lexicon.
+
+## Governed by
+
+- [PROM001](/rules/PROM001.md): a credential written as a literal in a `Receiver` or

package/dist/okf/types/InhibitRule.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: InhibitRule
+description: prometheus resource type Prometheus::Alertmanager::InhibitRule
+name: InhibitRule
+lexicon: prometheus
+resource_type: Prometheus::Alertmanager::InhibitRule
+---
+`Prometheus::Alertmanager::InhibitRule`, a resource type of the prometheus lexicon.

package/dist/okf/types/Receiver.md

@@ -0,0 +1,13 @@
+---
+type: resource-type
+title: Receiver
+description: prometheus resource type Prometheus::Alertmanager::Receiver
+name: Receiver
+lexicon: prometheus
+resource_type: Prometheus::Alertmanager::Receiver
+---
+`Prometheus::Alertmanager::Receiver`, a resource type of the prometheus lexicon.
+
+## Governed by
+
+- [PROM001](/rules/PROM001.md): a credential written as a literal in a `Receiver` or

package/dist/okf/types/Route.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: Route
+description: prometheus resource type Prometheus::Alertmanager::Route
+name: Route
+lexicon: prometheus
+resource_type: Prometheus::Alertmanager::Route
+---
+`Prometheus::Alertmanager::Route`, a resource type of the prometheus lexicon.

package/dist/okf/types/RuleGroup.md

@@ -0,0 +1,13 @@
+---
+type: resource-type
+title: RuleGroup
+description: prometheus resource type Prometheus::Rules::RuleGroup
+name: RuleGroup
+lexicon: prometheus
+resource_type: Prometheus::Rules::RuleGroup
+---
+`Prometheus::Rules::RuleGroup`, a resource type of the prometheus lexicon.
+
+## Governed by
+
+- [PROM002](/rules/PROM002.md): a rule's `expr`, written as a string literal inside a

package/dist/okf/types/TimeInterval.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: TimeInterval
+description: prometheus resource type Prometheus::Alertmanager::TimeInterval
+name: TimeInterval
+lexicon: prometheus
+resource_type: Prometheus::Alertmanager::TimeInterval
+---
+`Prometheus::Alertmanager::TimeInterval`, a resource type of the prometheus lexicon.

package/dist/package-cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env tsx
+export {};
+//# sourceMappingURL=package-cli.d.ts.map

package/dist/package-cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-cli.d.ts","sourceRoot":"","sources":["../src/package-cli.ts"],"names":[],"mappings":""}

package/dist/pin.d.ts

@@ -0,0 +1,20 @@
+/**
+ * The upstream releases this lexicon's hand-written types follow.
+ *
+ * Neither Prometheus nor Alertmanager publishes a machine-readable schema for
+ * its config files, so the types in `model.ts` are written against the Go
+ * structs of these releases (`prometheus/model/rulefmt`,
+ * `alertmanager/config`). Moving a version is a lexicon change like any
+ * other, released with this package.
+ */
+export declare const PROMETHEUS_PIN: Readonly<{
+    prometheus: Readonly<{
+        source: "github.com/prometheus/prometheus";
+        version: "v3.15.0";
+    }>;
+    alertmanager: Readonly<{
+        source: "github.com/prometheus/alertmanager";
+        version: "v0.34.1";
+    }>;
+}>;
+//# sourceMappingURL=pin.d.ts.map