kiwi-simple-metrics/kiwi_simple_metrics/settings.py

import math
from typing import Literal

from pydantic import BaseModel, DirectoryPath, Field
from pydantic_settings import BaseSettings, SettingsConfigDict


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

    # metric will be reported
    enabled: bool = True

    # format string to report the metric
    report: str = "{name}: {value:.2f}%"

    # 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


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


class MultiMS(MetricSettings):
    # outer format string for reporting
    report_outer: str = "{name}: [{inner}]"


class MemoryMS(MultiMS):
    name: str = "Memory"
    threshold: float = 90
    report_outer: str = "{inner}"

    # 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(MultiMS):
    name: str = "Disk Used"
    threshold: float = 85

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

    # include only `count` many of the paths with the least free space
    count: int = 1


class Settings(BaseSettings):
    model_config = SettingsConfigDict(
        env_prefix="METRIC_",
        env_nested_delimiter="__",
    )

    cpu: CpuMS = CpuMS()
    memory: MemoryMS = MemoryMS()
    disk: DiskMS = DiskMS()


SETTINGS = Settings()