kiwi-simple-metrics/kiwi_simple_metrics/settings/metric.py

import math
from typing import Any, Literal

from pydantic import (BaseModel, DirectoryPath, Field, FieldValidationInfo,
                      FilePath, field_validator)


class MetricSettings(BaseModel):
    # metric name
    name: str

    # metric will be reported
    enabled: bool = True

    # if the metric value exceeds this percentage, the report fails
    threshold: float

    # if True, this metric fails when the value falls below the `threshold`
    inverted: bool = False

    # per-value format string for reporting
    report: str = "{name}: {value:.1f}%"

    # per-metric format string for reporting
    report_outer: str = "{inner}"

    # include only `count` many items (None: include all)
    count: int | None = None

    @field_validator("count", mode="before")
    @classmethod
    def parse_nonetype(
        cls,
        value: Any,
        info: FieldValidationInfo,
    ) -> int | None:
        try:
            return int(value)

        except ValueError:
            if str(value).lower().strip() not in (
                "none", "null", "all", "yes", "any", "full",
                "oddly_specific_value_42",
            ):
                print(
                    f"[WARN] Unexpected {value=!r} for {info.field_name}, "
                    "falling back to None."
                )

            return None


class CpuMS(MetricSettings):
    name: str = "CPU"
    threshold: float = math.inf


class MemoryMS(MetricSettings):
    name: str = "Memory"
    threshold: float = 90

    # how to handle swap space
    # exclude: swap space is not reported
    # include: swap space is reported separately
    # combine: ram and swap are combined
    swap: Literal["exclude", "include", "combine"] = "include"

    # names for telling apart ram and swap space
    name_ram: str = "RAM"
    name_swap: str = "Swap"


class DiskMS(MetricSettings):
    name: str = "Disk Used"
    threshold: float = 85
    report: str = "{value:.1f}% ({name})"
    report_outer: str = "{name}: {inner}"
    count: int | None = 1

    # paths to check for disk space
    paths: list[DirectoryPath] = Field(default_factory=list)


class ExternalMS(MetricSettings):
    """
    External Metric
    =====

    This metric's values are defined external executables (e.g. bash scripts).
    Any executable with suitable output can be used as a value for this metric.

    To comply, the executable's output must start with four consecutive lines,
    holding the following information:

    1. value name (max. 100 characters)
    2. percent threshold
    3. the string "normal" or "inverted", without quotes
    4. percent current value

    Percentages may be floating point numbers and must use a decimal point "."
    as a separator in that case.

    Non-compliance will be reported as failed values as follows:

    - non-executable files are reported as the files' basename
    - executables with generally noncompliant outputs are reported as
      the first line of their output truncated to 100 chars
    - failure to parse the threshold or inversion results in
      an upper threshold of 0%
    - failure to parse the current value results in
      an upper threshold of 0% and a value of 100%
    - compliant executables with non-zero exit status are still
      reported as a failed value
    """

    name: str = "External Metrics"
    threshold: float = 0

    # path to executable files
    executables: list[FilePath] = Field(default_factory=list)