diff --git a/docs/genindex.html b/docs/genindex.html index a7e0833..fd9d9c9 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -217,6 +217,8 @@

G

  • get_container_status() (in module pyninja.dockerized)
  • get_cpu_load_avg() (in module pyninja.routes) +
    • +
  • get_cpu_percent() (in module pyninja.squire)
  • get_cpu_utilization() (in module pyninja.routes)
    • @@ -266,6 +268,8 @@

    G

  • (in module pyninja.service)
    • +
  • get_system_metrics() (in module pyninja.squire) +
    • diff --git a/docs/index.html b/docs/index.html index 0090580..b3b72e9 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1349,21 +1349,55 @@

    Models +
    +
    +pyninja.squire.get_cpu_percent(cpu_interval: int) → List[float]
    +

    Get CPU usage percentage.

    +
    +
    Parameters:
    +

    cpu_interval – System CPU times elapsed before and after the interval.

    +
    +
    Returns:
    +

    Returns a list of CPU percentages.

    +
    +
    Return type:
    +

    List[float]

    +
    +
    +
    +
    -pyninja.squire.get_docker_stats() → Generator[Dict[str, str]]
    -

    Run the docker stats command and parse the output into a list of key-value pairs.

    +async pyninja.squire.get_docker_stats() → List[Dict[str, str]] +

    Run the docker stats command asynchronously and parse the output.

    -
    Yields:
    -

    Dict[str, str] – Yields key-value pairs with the container stat and value.

    +
    Returns:
    +

    Returns a list of key-value pairs with the container stat and value.

    +
    +
    Return type:
    +

    List[Dict[str, str]]

    +
    +
    +
    + +
    +
    +async pyninja.squire.get_system_metrics() → Dict[str, dict]
    +

    Async handler for virtual memory, swap memory disk usage and CPU load averages.

    +
    +
    Returns:
    +

    Returns a nested dictionary.

    +
    +
    Return type:
    +

    Dict[str, dict]

    -pyninja.squire.system_resources(cpu_interval: int) → Dict[str, dict]
    -

    Get system resources like CPU, virtual memory and swap memory information.

    +async pyninja.squire.system_resources(cpu_interval: int) → Dict[str, dict] +

    Gather system resources including Docker stats asynchronously.

    Parameters:

    cpu_interval – Interval in seconds is used to compare CPU times elapsed before and after.

    diff --git a/docs/objects.inv b/docs/objects.inv index b0f7167..0540e22 100644 Binary files a/docs/objects.inv and b/docs/objects.inv differ diff --git a/docs/searchindex.js b/docs/searchindex.js index b80fbd2..c57cd3a 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["README", "index"], "filenames": ["README.md", "index.rst"], "titles": ["PyNinja", "Welcome to PyNinja\u2019s documentation!"], "terms": {"lightweight": 0, "o": [0, 1], "agnost": 0, "servic": 0, "monitor": 0, "api": [0, 1], "platform": 0, "support": [0, 1], "deploy": 0, "recommend": 0, "instal": [0, 1], "python": 0, "3": [0, 1], "10": [0, 1], "11": [0, 1], "us": [0, 1], "dedic": [0, 1], "virtual": [0, 1], "m": 0, "pip": 0, "initi": 0, "id": [0, 1], "import": 0, "__name__": 0, "__main__": 0, "start": [0, 1], "cli": 0, "help": 0, "usag": [0, 1], "instruct": 0, "sourc": 0, "from": [0, 1], "an": [0, 1], "env": [0, 1], "file": [0, 1], "By": 0, "default": [0, 1], "look": 0, "current": [0, 1], "work": [0, 1], "directori": 0, "ninja": 0, "_": 0, "host": [0, 1], "hostnam": [0, 1], "server": [0, 1], "port": [0, 1], "number": [0, 1], "worker": [0, 1], "uvicorn": [0, 1], "remot": [0, 1], "execut": [0, 1], "boolean": [0, 1], "flag": [0, 1], "enabl": [0, 1], "secret": [0, 1], "access": [0, 1], "kei": [0, 1], "run": [0, 1], "command": [0, 1], "usernam": [0, 1], "authent": 0, "page": [0, 1], "password": [0, 1], "session": [0, 1], "timeout": [0, 1], "max": [0, 1], "connect": [0, 1], "maximum": [0, 1], "allow": [0, 1], "parallel": 0, "manag": [0, 1], "filepath": [0, 1], "handl": [0, 1], "statu": [0, 1], "request": [0, 1], "databas": 0, "store": [0, 1], "auth": [0, 1], "error": [0, 1], "rate": [0, 1], "limit": [0, 1], "list": [0, 1], "dictionari": [0, 1], "max_request": [0, 1], "second": [0, 1], "appli": [0, 1], "apikei": [0, 1], "can": 0, "extrem": 0, "riski": 0, "major": 0, "secur": 0, "threat": 0, "so": [0, 1], "caution": 0, "set": [0, 1], "strong": [0, 1], "valu": [0, 1], "refer": [0, 1], "sampl": 0, "exampl": [0, 1], "docstr": 0, "format": [0, 1], "googl": 0, "style": 0, "convent": 0, "pep": 0, "8": 0, "isort": 0, "requir": [0, 1], "gitvers": 0, "revers": 0, "f": 0, "release_not": 0, "rst": 0, "t": [0, 1], "pre": 0, "commit": 0, "ensur": 0, "pytest": 0, "gener": [0, 1], "valid": [0, 1], "hyperlink": 0, "all": [0, 1], "markdown": 0, "includ": 0, "wiki": 0, "sphinx": 0, "5": [0, 1], "1": [0, 1], "recommonmark": 0, "http": [0, 1], "org": 0, "project": 0, "thevickypedia": 0, "github": 0, "io": 0, "vignesh": 0, "rao": 0, "under": 0, "mit": 0, "kick": 1, "off": 1, "environ": 1, "variabl": 1, "code": 1, "standard": 1, "releas": 1, "note": 1, "lint": 1, "pypi": 1, "packag": 1, "runbook": 1, "licens": 1, "copyright": 1, "get_desc": 1, "remote_flag": 1, "bool": 1, "monitor_flag": 1, "str": 1, "construct": 1, "detail": 1, "descript": 1, "doc": 1, "paramet": 1, "state": 1, "return": 1, "string": 1, "type": 1, "async": 1, "redirect_exception_handl": 1, "redirectexcept": 1, "jsonrespons": 1, "custom": 1, "handler": 1, "redirect": 1, "take": 1, "object": 1, "argument": 1, "inherit": 1, "cooki": 1, "kwarg": 1, "none": 1, "starter": 1, "function": 1, "which": 1, "trigger": 1, "keyword": 1, "env_fil": 1, "load": 1, "ninja_host": 1, "ninja_port": 1, "remote_execut": 1, "api_secret": 1, "monitor_usernam": 1, "monitor_password": 1, "monitor_sess": 1, "service_manag": 1, "rate_limit": 1, "log_config": 1, "log": 1, "dict": 1, "yaml": 1, "yml": 1, "json": 1, "ini": 1, "epoch": 1, "forbidden": 1, "i": 1, "part": 1, "fastapi": 1, "rais": 1, "apirespons": 1, "403": 1, "If": 1, "address": 1, "level_1": 1, "httpauthorizationcredenti": 1, "httpbearer": 1, "author": 1, "header": 1, "token": 1, "basic": 1, "401": 1, "invalid": 1, "level_2": 1, "addition": 1, "addit": 1, "critic": 1, "increment": 1, "attempt": 1, "int": 1, "block": 1, "time": 1, "base": 1, "fail": 1, "login": 1, "appropri": 1, "minut": 1, "handle_auth_error": 1, "filebrows": 1, "The": 1, "incom": 1, "get_ip_address": 1, "public": 1, "fals": 1, "depend": 1, "get": 1, "local": 1, "ip": 1, "devic": 1, "arg": 1, "httpstatu": 1, "privat": 1, "respons": 1, "get_cpu_util": 1, "interv": 1, "float": 1, "2": 1, "per_cpu": 1, "true": 1, "cpu": 1, "util": 1, "each": 1, "get_memory_util": 1, "memori": 1, "get_cpu_load_avg": 1, "system": 1, "queue": 1, "averag": 1, "over": 1, "last": 1, "15": 1, "respect": 1, "get_disk_util": 1, "disk": 1, "get_all_disk": 1, "attach": 1, "run_command": 1, "payload": 1, "option": 1, "machin": 1, "receiv": 1, "bodi": 1, "get_process_statu": 1, "process_nam": 1, "cpu_interv": 1, "union": 1, "name": 1, "check": 1, "get_service_statu": 1, "service_nam": 1, "get_docker_contain": 1, "container_nam": 1, "get_al": 1, "get_run": 1, "contain": 1, "inform": 1, "get_docker_imag": 1, "imag": 1, "get_docker_volum": 1, "volum": 1, "get_docker_stat": 1, "stat": 1, "get_processor_nam": 1, "redirectrespons": 1, "user": 1, "health": 1, "200": 1, "get_all_rout": 1, "apirout": 1, "ad": 1, "get_container_statu": 1, "get_running_contain": 1, "yield": 1, "correspond": 1, "metric": 1, "get_all_contain": 1, "get_all_imag": 1, "get_all_volum": 1, "perform": 1, "report": 1, "given": 1, "get_perform": 1, "thread": 1, "open": 1, "pair": 1, "servicestatu": 1, "stop": 1, "501": 1, "unknown": 1, "503": 1, "unavail": 1, "404": 1, "instanc": 1, "get_record": 1, "particular": 1, "until": 1, "when": 1, "should": 1, "put_record": 1, "block_until": 1, "insert": 1, "remove_record": 1, "delet": 1, "record": 1, "relat": 1, "class": 1, "rp": 1, "implement": 1, "init": 1, "call": 1, "exce": 1, "identifi": 1, "429": 1, "too": 1, "mani": 1, "status_cod": 1, "ani": 1, "httpexcept": 1, "wrap": 1, "unsupportedo": 1, "unsupport": 1, "locat": 1, "within": 1, "sinc": 1, "doesn": 1, "html": 1, "demand": 1, "case": 1, "where": 1, "solut": 1, "There": 1, "ar": 1, "altern": 1, "our": 1, "javascript": 1, "thi": 1, "wai": 1, "come": 1, "handi": 1, "unexpect": 1, "scenario": 1, "tiangolo": 1, "com": 1, "tutori": 1, "sessionerror": 1, "raise_os_error": 1, "operating_system": 1, "noreturn": 1, "oper": 1, "validationerror": 1, "overridden": 1, "pydant": 1, "basemodel": 1, "input": 1, "data": 1, "disklib": 1, "librari": 1, "linux": 1, "path": 1, "darwin": 1, "window": 1, "servicelib": 1, "processorlib": 1, "processor": 1, "wsset": 1, "websocket": 1, "refresh_interv": 1, "auth_count": 1, "forbid": 1, "info": 1, "allowed_origin": 1, "envconfig": 1, "max_connect": 1, "disk_lib": 1, "service_lib": 1, "processor_lib": 1, "classmethod": 1, "parse_api_secret": 1, "pars": 1, "complex": 1, "from_env_fil": 1, "creat": 1, "config": 1, "extra": 1, "ignor": 1, "hide_input_in_error": 1, "complexity_check": 1, "verifi": 1, "strength": 1, "A": 1, "consid": 1, "least": 1, "ha": 1, "32": 1, "charact": 1, "digit": 1, "symbol": 1, "uppercas": 1, "letter": 1, "lowercas": 1, "assertionerror": 1, "abov": 1, "condit": 1, "match": 1, "wssession": 1, "client_auth": 1, "_abc_impl": 1, "_abc": 1, "_abc_data": 1, "model_computed_field": 1, "classvar": 1, "computedfieldinfo": 1, "comput": 1, "field": 1, "model_config": 1, "configdict": 1, "conform": 1, "model_field": 1, "fieldinfo": 1, "annot": 1, "metadata": 1, "about": 1, "defin": 1, "map": 1, "replac": 1, "__fields__": 1, "v1": 1, "get_librari": 1, "referenc": 1, "datastor": 1, "sqlite3": 1, "create_t": 1, "table_nam": 1, "column": 1, "tupl": 1, "public_ip_address": 1, "differ": 1, "endpoint": 1, "private_ip_address": 1, "simpl": 1, "network": 1, "see": 1, "output": 1, "system_resourc": 1, "resourc": 1, "like": 1, "swap": 1, "compar": 1, "elaps": 1, "befor": 1, "after": 1, "nest": 1, "format_no": 1, "input_": 1, "remov": 1, "0": 1, "integ": 1, "end": 1, "found": 1, "els": 1, "format_timedelta": 1, "td": 1, "timedelta": 1, "convert": 1, "human": 1, "readabl": 1, "non": 1, "zero": 1, "alwai": 1, "two": 1, "dai": 1, "hour": 1, "23": 1, "size_convert": 1, "byte_s": 1, "consum": 1, "friendli": 1, "byte": 1, "size": 1, "understand": 1, "process_command": 1, "result": 1, "stdout": 1, "stderr": 1, "envfile_load": 1, "filenam": 1, "pathlik": 1, "filetyp": 1, "var": 1, "have": 1, "load_env": 1, "merg": 1, "give": 1, "prioriti": 1, "partial": 1, "through": 1, "keygen": 1, "modul": 1, "forc": 1, "restart": 1, "url": 1, "safe": 1, "64": 1, "bit": 1, "dynamic_numb": 1, "dynam": 1, "failed_auth_count": 1, "keep": 1, "track": 1, "more": 1, "raise_error": 1, "unauthor": 1, "bad": 1, "credenti": 1, "extract_credenti": 1, "extract": 1, "decod": 1, "verify_login": 1, "generate_cooki": 1, "auth_payload": 1, "timestamp": 1, "session_error": 1, "htmlrespons": 1, "render": 1, "messag": 1, "templat": 1, "jinja2": 1, "validate_sess": 1, "cookie_str": 1, "summari": 1, "capwords_filt": 1, "capit": 1, "filter": 1, "clear_sess": 1, "clear": 1, "get_expiri": 1, "lease_start": 1, "lease_dur": 1, "expiri": 1, "datetim": 1, "ag": 1, "wa": 1, "made": 1, "date": 1, "gmt": 1, "error_endpoint": 1, "logout_endpoint": 1, "out": 1, "login_endpoint": 1, "session_token": 1, "redirect_url": 1, "monitor_endpoint": 1, "ui": 1, "websocket_endpoint": 1, "fetch": 1, "live": 1, "calculate_hash": 1, "hash": 1, "base64_encod": 1, "base64": 1, "encod": 1, "base64_decod": 1, "hex_decod": 1, "hex": 1, "hex_encod": 1, "index": 1, "search": 1}, "objects": {"pyninja": [[1, 0, 0, "-", "auth"], [1, 0, 0, "-", "database"], [1, 0, 0, "-", "dockerized"], [1, 0, 0, "-", "exceptions"], [1, 0, 0, "-", "main"], [1, 0, 0, "-", "models"], [1, 0, 0, "-", "process"], [1, 0, 0, "-", "rate_limit"], [1, 0, 0, "-", "routes"], [1, 0, 0, "-", "service"], [1, 0, 0, "-", "squire"]], "pyninja.auth": [[1, 1, 1, "", "EPOCH"], [1, 1, 1, "", "forbidden"], [1, 1, 1, "", "handle_auth_error"], [1, 1, 1, "", "incrementer"], [1, 1, 1, "", "level_1"], [1, 1, 1, "", "level_2"]], "pyninja.database": [[1, 1, 1, "", "get_record"], [1, 1, 1, "", "put_record"], [1, 1, 1, "", "remove_record"]], "pyninja.dockerized": [[1, 1, 1, "", "get_all_containers"], [1, 1, 1, "", "get_all_images"], [1, 1, 1, "", "get_all_volumes"], [1, 1, 1, "", "get_container_status"], [1, 1, 1, "", "get_running_containers"]], "pyninja.exceptions": [[1, 2, 1, "", "APIResponse"], [1, 2, 1, "", "RedirectException"], [1, 2, 1, "", "SessionError"], [1, 2, 1, "", "UnSupportedOS"], [1, 1, 1, "", "raise_os_error"]], "pyninja.main": [[1, 1, 1, "", "get_desc"], [1, 1, 1, "", "redirect_exception_handler"], [1, 1, 1, "", "start"]], "pyninja.models": [[1, 3, 1, "", "Database"], [1, 3, 1, "", "DiskLib"], [1, 3, 1, "", "EnvConfig"], [1, 3, 1, "", "Payload"], [1, 3, 1, "", "ProcessorLib"], [1, 3, 1, "", "RateLimit"], [1, 3, 1, "", "ServiceLib"], [1, 3, 1, "", "ServiceStatus"], [1, 3, 1, "", "Session"], [1, 3, 1, "", "WSSession"], [1, 3, 1, "", "WSSettings"], [1, 1, 1, "", "complexity_checker"], [1, 1, 1, "", "get_library"]], "pyninja.models.Database": [[1, 4, 1, "", "create_table"]], "pyninja.models.DiskLib": [[1, 5, 1, "", "darwin"], [1, 5, 1, "", "linux"], [1, 5, 1, "", "windows"]], "pyninja.models.EnvConfig": [[1, 3, 1, "", "Config"], [1, 5, 1, "", "api_secret"], [1, 5, 1, "", "apikey"], [1, 5, 1, "", "database"], [1, 5, 1, "", "disk_lib"], [1, 4, 1, "", "from_env_file"], [1, 5, 1, "", "log_config"], [1, 5, 1, "", "max_connections"], [1, 5, 1, "", "monitor_password"], [1, 5, 1, "", "monitor_session"], [1, 5, 1, "", "monitor_username"], [1, 5, 1, "", "ninja_host"], [1, 5, 1, "", "ninja_port"], [1, 4, 1, "", "parse_api_secret"], [1, 5, 1, "", "processor_lib"], [1, 5, 1, "", "rate_limit"], [1, 5, 1, "", "remote_execution"], [1, 5, 1, "", "service_lib"], [1, 5, 1, "", "workers"]], "pyninja.models.EnvConfig.Config": [[1, 5, 1, "", "extra"], [1, 5, 1, "", "hide_input_in_errors"]], "pyninja.models.Payload": [[1, 5, 1, "", "command"], [1, 5, 1, "", "timeout"]], "pyninja.models.ProcessorLib": [[1, 5, 1, "", "darwin"], [1, 5, 1, "", "linux"], [1, 5, 1, "", "windows"]], "pyninja.models.RateLimit": [[1, 5, 1, "", "max_requests"], [1, 5, 1, "", "seconds"]], "pyninja.models.ServiceLib": [[1, 5, 1, "", "darwin"], [1, 5, 1, "", "linux"], [1, 5, 1, "", "windows"]], "pyninja.models.ServiceStatus": [[1, 5, 1, "", "description"], [1, 5, 1, "", "status_code"]], "pyninja.models.Session": [[1, 5, 1, "", "allowed_origins"], [1, 5, 1, "", "auth_counter"], [1, 5, 1, "", "forbid"], [1, 5, 1, "", "info"], [1, 5, 1, "", "rps"]], "pyninja.models.WSSession": [[1, 5, 1, "", "_abc_impl"], [1, 5, 1, "", "client_auth"], [1, 5, 1, "", "invalid"], [1, 5, 1, "", "model_computed_fields"], [1, 5, 1, "", "model_config"], [1, 5, 1, "", "model_fields"]], "pyninja.models.WSSettings": [[1, 5, 1, "", "cpu_interval"], [1, 5, 1, "", "refresh_interval"]], "pyninja.monitor": [[1, 0, 0, "-", "authenticator"], [1, 0, 0, "-", "config"], [1, 0, 0, "-", "routes"], [1, 0, 0, "-", "secure"]], "pyninja.monitor.authenticator": [[1, 1, 1, "", "extract_credentials"], [1, 1, 1, "", "failed_auth_counter"], [1, 1, 1, "", "generate_cookie"], [1, 1, 1, "", "raise_error"], [1, 1, 1, "", "session_error"], [1, 1, 1, "", "validate_session"], [1, 1, 1, "", "verify_login"]], "pyninja.monitor.config": [[1, 1, 1, "", "capwords_filter"], [1, 1, 1, "", "clear_session"], [1, 1, 1, "", "get_expiry"]], "pyninja.monitor.routes": [[1, 1, 1, "", "error_endpoint"], [1, 1, 1, "", "login_endpoint"], [1, 1, 1, "", "logout_endpoint"], [1, 1, 1, "", "monitor_endpoint"], [1, 1, 1, "", "websocket_endpoint"]], "pyninja.monitor.secure": [[1, 1, 1, "", "base64_decode"], [1, 1, 1, "", "base64_encode"], [1, 1, 1, "", "calculate_hash"], [1, 1, 1, "", "hex_decode"], [1, 1, 1, "", "hex_encode"]], "pyninja.process": [[1, 1, 1, "", "get_performance"], [1, 1, 1, "", "get_process_status"]], "pyninja.rate_limit": [[1, 3, 1, "", "RateLimiter"]], "pyninja.rate_limit.RateLimiter": [[1, 4, 1, "", "init"]], "pyninja.routes": [[1, 1, 1, "", "docs"], [1, 1, 1, "", "get_all_disks"], [1, 1, 1, "", "get_all_routes"], [1, 1, 1, "", "get_cpu_load_avg"], [1, 1, 1, "", "get_cpu_utilization"], [1, 1, 1, "", "get_disk_utilization"], [1, 1, 1, "", "get_docker_containers"], [1, 1, 1, "", "get_docker_images"], [1, 1, 1, "", "get_docker_stats"], [1, 1, 1, "", "get_docker_volumes"], [1, 1, 1, "", "get_ip_address"], [1, 1, 1, "", "get_memory_utilization"], [1, 1, 1, "", "get_process_status"], [1, 1, 1, "", "get_processor_name"], [1, 1, 1, "", "get_service_status"], [1, 1, 1, "", "health"], [1, 1, 1, "", "run_command"]], "pyninja.service": [[1, 1, 1, "", "get_service_status"], [1, 1, 1, "", "running"], [1, 1, 1, "", "stopped"], [1, 1, 1, "", "unavailable"], [1, 1, 1, "", "unknown"]], "pyninja.squire": [[1, 1, 1, "", "dynamic_numbers"], [1, 1, 1, "", "envfile_loader"], [1, 1, 1, "", "format_nos"], [1, 1, 1, "", "format_timedelta"], [1, 1, 1, "", "get_docker_stats"], [1, 1, 1, "", "keygen"], [1, 1, 1, "", "load_env"], [1, 1, 1, "", "private_ip_address"], [1, 1, 1, "", "process_command"], [1, 1, 1, "", "public_ip_address"], [1, 1, 1, "", "size_converter"], [1, 1, 1, "", "system_resources"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:exception", "3": "py:class", "4": "py:method", "5": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "exception", "Python exception"], "3": ["py", "class", "Python class"], "4": ["py", "method", "Python method"], "5": ["py", "attribute", "Python attribute"]}, "titleterms": {"pyninja": [0, 1], "kick": 0, "off": 0, "environ": 0, "variabl": 0, "code": 0, "standard": 0, "releas": 0, "note": 0, "lint": 0, "pypi": 0, "packag": 0, "runbook": 0, "licens": 0, "copyright": 0, "welcom": 1, "": 1, "document": 1, "content": 1, "main": 1, "authent": 1, "rout": 1, "monitor": 1, "docker": 1, "process": 1, "servic": 1, "databas": 1, "ratelimit": 1, "except": 1, "model": 1, "squir": 1, "configur": 1, "secur": 1, "indic": 1, "tabl": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}}) \ No newline at end of file +Search.setIndex({"docnames": ["README", "index"], "filenames": ["README.md", "index.rst"], "titles": ["PyNinja", "Welcome to PyNinja\u2019s documentation!"], "terms": {"lightweight": 0, "o": [0, 1], "agnost": 0, "servic": 0, "monitor": 0, "api": [0, 1], "platform": 0, "support": [0, 1], "deploy": 0, "recommend": 0, "instal": [0, 1], "python": 0, "3": [0, 1], "10": [0, 1], "11": [0, 1], "us": [0, 1], "dedic": [0, 1], "virtual": [0, 1], "m": 0, "pip": 0, "initi": 0, "id": [0, 1], "import": 0, "__name__": 0, "__main__": 0, "start": [0, 1], "cli": 0, "help": 0, "usag": [0, 1], "instruct": 0, "sourc": 0, "from": [0, 1], "an": [0, 1], "env": [0, 1], "file": [0, 1], "By": 0, "default": [0, 1], "look": 0, "current": [0, 1], "work": [0, 1], "directori": 0, "ninja": 0, "_": 0, "host": [0, 1], "hostnam": [0, 1], "server": [0, 1], "port": [0, 1], "number": [0, 1], "worker": [0, 1], "uvicorn": [0, 1], "remot": [0, 1], "execut": [0, 1], "boolean": [0, 1], "flag": [0, 1], "enabl": [0, 1], "secret": [0, 1], "access": [0, 1], "kei": [0, 1], "run": [0, 1], "command": [0, 1], "usernam": [0, 1], "authent": 0, "page": [0, 1], "password": [0, 1], "session": [0, 1], "timeout": [0, 1], "max": [0, 1], "connect": [0, 1], "maximum": [0, 1], "allow": [0, 1], "parallel": 0, "manag": [0, 1], "filepath": [0, 1], "handl": [0, 1], "statu": [0, 1], "request": [0, 1], "databas": 0, "store": [0, 1], "auth": [0, 1], "error": [0, 1], "rate": [0, 1], "limit": [0, 1], "list": [0, 1], "dictionari": [0, 1], "max_request": [0, 1], "second": [0, 1], "appli": [0, 1], "apikei": [0, 1], "can": 0, "extrem": 0, "riski": 0, "major": 0, "secur": 0, "threat": 0, "so": [0, 1], "caution": 0, "set": [0, 1], "strong": [0, 1], "valu": [0, 1], "refer": [0, 1], "sampl": 0, "exampl": [0, 1], "docstr": 0, "format": [0, 1], "googl": 0, "style": 0, "convent": 0, "pep": 0, "8": 0, "isort": 0, "requir": [0, 1], "gitvers": 0, "revers": 0, "f": 0, "release_not": 0, "rst": 0, "t": [0, 1], "pre": 0, "commit": 0, "ensur": 0, "pytest": 0, "gener": [0, 1], "valid": [0, 1], "hyperlink": 0, "all": [0, 1], "markdown": 0, "includ": [0, 1], "wiki": 0, "sphinx": 0, "5": [0, 1], "1": [0, 1], "recommonmark": 0, "http": [0, 1], "org": 0, "project": 0, "thevickypedia": 0, "github": 0, "io": 0, "vignesh": 0, "rao": 0, "under": 0, "mit": 0, "kick": 1, "off": 1, "environ": 1, "variabl": 1, "code": 1, "standard": 1, "releas": 1, "note": 1, "lint": 1, "pypi": 1, "packag": 1, "runbook": 1, "licens": 1, "copyright": 1, "get_desc": 1, "remote_flag": 1, "bool": 1, "monitor_flag": 1, "str": 1, "construct": 1, "detail": 1, "descript": 1, "doc": 1, "paramet": 1, "state": 1, "return": 1, "string": 1, "type": 1, "async": 1, "redirect_exception_handl": 1, "redirectexcept": 1, "jsonrespons": 1, "custom": 1, "handler": 1, "redirect": 1, "take": 1, "object": 1, "argument": 1, "inherit": 1, "cooki": 1, "kwarg": 1, "none": 1, "starter": 1, "function": 1, "which": 1, "trigger": 1, "keyword": 1, "env_fil": 1, "load": 1, "ninja_host": 1, "ninja_port": 1, "remote_execut": 1, "api_secret": 1, "monitor_usernam": 1, "monitor_password": 1, "monitor_sess": 1, "service_manag": 1, "rate_limit": 1, "log_config": 1, "log": 1, "dict": 1, "yaml": 1, "yml": 1, "json": 1, "ini": 1, "epoch": 1, "forbidden": 1, "i": 1, "part": 1, "fastapi": 1, "rais": 1, "apirespons": 1, "403": 1, "If": 1, "address": 1, "level_1": 1, "httpauthorizationcredenti": 1, "httpbearer": 1, "author": 1, "header": 1, "token": 1, "basic": 1, "401": 1, "invalid": 1, "level_2": 1, "addition": 1, "addit": 1, "critic": 1, "increment": 1, "attempt": 1, "int": 1, "block": 1, "time": 1, "base": 1, "fail": 1, "login": 1, "appropri": 1, "minut": 1, "handle_auth_error": 1, "filebrows": 1, "The": 1, "incom": 1, "get_ip_address": 1, "public": 1, "fals": 1, "depend": 1, "get": 1, "local": 1, "ip": 1, "devic": 1, "arg": 1, "httpstatu": 1, "privat": 1, "respons": 1, "get_cpu_util": 1, "interv": 1, "float": 1, "2": 1, "per_cpu": 1, "true": 1, "cpu": 1, "util": 1, "each": 1, "get_memory_util": 1, "memori": 1, "get_cpu_load_avg": 1, "system": 1, "queue": 1, "averag": 1, "over": 1, "last": 1, "15": 1, "respect": 1, "get_disk_util": 1, "disk": 1, "get_all_disk": 1, "attach": 1, "run_command": 1, "payload": 1, "option": 1, "machin": 1, "receiv": 1, "bodi": 1, "get_process_statu": 1, "process_nam": 1, "cpu_interv": 1, "union": 1, "name": 1, "check": 1, "get_service_statu": 1, "service_nam": 1, "get_docker_contain": 1, "container_nam": 1, "get_al": 1, "get_run": 1, "contain": 1, "inform": 1, "get_docker_imag": 1, "imag": 1, "get_docker_volum": 1, "volum": 1, "get_docker_stat": 1, "stat": 1, "get_processor_nam": 1, "redirectrespons": 1, "user": 1, "health": 1, "200": 1, "get_all_rout": 1, "apirout": 1, "ad": 1, "get_container_statu": 1, "get_running_contain": 1, "yield": 1, "correspond": 1, "metric": 1, "get_all_contain": 1, "get_all_imag": 1, "get_all_volum": 1, "perform": 1, "report": 1, "given": 1, "get_perform": 1, "thread": 1, "open": 1, "pair": 1, "servicestatu": 1, "stop": 1, "501": 1, "unknown": 1, "503": 1, "unavail": 1, "404": 1, "instanc": 1, "get_record": 1, "particular": 1, "until": 1, "when": 1, "should": 1, "put_record": 1, "block_until": 1, "insert": 1, "remove_record": 1, "delet": 1, "record": 1, "relat": 1, "class": 1, "rp": 1, "implement": 1, "init": 1, "call": 1, "exce": 1, "identifi": 1, "429": 1, "too": 1, "mani": 1, "status_cod": 1, "ani": 1, "httpexcept": 1, "wrap": 1, "unsupportedo": 1, "unsupport": 1, "locat": 1, "within": 1, "sinc": 1, "doesn": 1, "html": 1, "demand": 1, "case": 1, "where": 1, "solut": 1, "There": 1, "ar": 1, "altern": 1, "our": 1, "javascript": 1, "thi": 1, "wai": 1, "come": 1, "handi": 1, "unexpect": 1, "scenario": 1, "tiangolo": 1, "com": 1, "tutori": 1, "sessionerror": 1, "raise_os_error": 1, "operating_system": 1, "noreturn": 1, "oper": 1, "validationerror": 1, "overridden": 1, "pydant": 1, "basemodel": 1, "input": 1, "data": 1, "disklib": 1, "librari": 1, "linux": 1, "path": 1, "darwin": 1, "window": 1, "servicelib": 1, "processorlib": 1, "processor": 1, "wsset": 1, "websocket": 1, "refresh_interv": 1, "auth_count": 1, "forbid": 1, "info": 1, "allowed_origin": 1, "envconfig": 1, "max_connect": 1, "disk_lib": 1, "service_lib": 1, "processor_lib": 1, "classmethod": 1, "parse_api_secret": 1, "pars": 1, "complex": 1, "from_env_fil": 1, "creat": 1, "config": 1, "extra": 1, "ignor": 1, "hide_input_in_error": 1, "complexity_check": 1, "verifi": 1, "strength": 1, "A": 1, "consid": 1, "least": 1, "ha": 1, "32": 1, "charact": 1, "digit": 1, "symbol": 1, "uppercas": 1, "letter": 1, "lowercas": 1, "assertionerror": 1, "abov": 1, "condit": 1, "match": 1, "wssession": 1, "client_auth": 1, "_abc_impl": 1, "_abc": 1, "_abc_data": 1, "model_computed_field": 1, "classvar": 1, "computedfieldinfo": 1, "comput": 1, "field": 1, "model_config": 1, "configdict": 1, "conform": 1, "model_field": 1, "fieldinfo": 1, "annot": 1, "metadata": 1, "about": 1, "defin": 1, "map": 1, "replac": 1, "__fields__": 1, "v1": 1, "get_librari": 1, "referenc": 1, "datastor": 1, "sqlite3": 1, "create_t": 1, "table_nam": 1, "column": 1, "tupl": 1, "public_ip_address": 1, "differ": 1, "endpoint": 1, "private_ip_address": 1, "simpl": 1, "network": 1, "see": 1, "get_cpu_perc": 1, "percentag": 1, "elaps": 1, "befor": 1, "after": 1, "asynchron": 1, "output": 1, "get_system_metr": 1, "swap": 1, "nest": 1, "system_resourc": 1, "gather": 1, "resourc": 1, "compar": 1, "format_no": 1, "input_": 1, "remov": 1, "0": 1, "integ": 1, "end": 1, "found": 1, "els": 1, "format_timedelta": 1, "td": 1, "timedelta": 1, "convert": 1, "human": 1, "readabl": 1, "non": 1, "zero": 1, "alwai": 1, "two": 1, "dai": 1, "hour": 1, "23": 1, "size_convert": 1, "byte_s": 1, "consum": 1, "friendli": 1, "byte": 1, "size": 1, "understand": 1, "process_command": 1, "result": 1, "stdout": 1, "stderr": 1, "envfile_load": 1, "filenam": 1, "pathlik": 1, "filetyp": 1, "var": 1, "have": 1, "load_env": 1, "merg": 1, "give": 1, "prioriti": 1, "partial": 1, "through": 1, "keygen": 1, "modul": 1, "forc": 1, "restart": 1, "url": 1, "safe": 1, "64": 1, "bit": 1, "dynamic_numb": 1, "dynam": 1, "failed_auth_count": 1, "keep": 1, "track": 1, "more": 1, "raise_error": 1, "unauthor": 1, "bad": 1, "credenti": 1, "extract_credenti": 1, "extract": 1, "decod": 1, "verify_login": 1, "generate_cooki": 1, "auth_payload": 1, "timestamp": 1, "session_error": 1, "htmlrespons": 1, "render": 1, "messag": 1, "templat": 1, "jinja2": 1, "validate_sess": 1, "cookie_str": 1, "summari": 1, "capwords_filt": 1, "capit": 1, "filter": 1, "clear_sess": 1, "clear": 1, "get_expiri": 1, "lease_start": 1, "lease_dur": 1, "expiri": 1, "datetim": 1, "ag": 1, "wa": 1, "made": 1, "date": 1, "gmt": 1, "error_endpoint": 1, "logout_endpoint": 1, "out": 1, "login_endpoint": 1, "session_token": 1, "redirect_url": 1, "monitor_endpoint": 1, "ui": 1, "websocket_endpoint": 1, "fetch": 1, "live": 1, "calculate_hash": 1, "hash": 1, "base64_encod": 1, "base64": 1, "encod": 1, "base64_decod": 1, "hex_decod": 1, "hex": 1, "hex_encod": 1, "index": 1, "search": 1}, "objects": {"pyninja": [[1, 0, 0, "-", "auth"], [1, 0, 0, "-", "database"], [1, 0, 0, "-", "dockerized"], [1, 0, 0, "-", "exceptions"], [1, 0, 0, "-", "main"], [1, 0, 0, "-", "models"], [1, 0, 0, "-", "process"], [1, 0, 0, "-", "rate_limit"], [1, 0, 0, "-", "routes"], [1, 0, 0, "-", "service"], [1, 0, 0, "-", "squire"]], "pyninja.auth": [[1, 1, 1, "", "EPOCH"], [1, 1, 1, "", "forbidden"], [1, 1, 1, "", "handle_auth_error"], [1, 1, 1, "", "incrementer"], [1, 1, 1, "", "level_1"], [1, 1, 1, "", "level_2"]], "pyninja.database": [[1, 1, 1, "", "get_record"], [1, 1, 1, "", "put_record"], [1, 1, 1, "", "remove_record"]], "pyninja.dockerized": [[1, 1, 1, "", "get_all_containers"], [1, 1, 1, "", "get_all_images"], [1, 1, 1, "", "get_all_volumes"], [1, 1, 1, "", "get_container_status"], [1, 1, 1, "", "get_running_containers"]], "pyninja.exceptions": [[1, 2, 1, "", "APIResponse"], [1, 2, 1, "", "RedirectException"], [1, 2, 1, "", "SessionError"], [1, 2, 1, "", "UnSupportedOS"], [1, 1, 1, "", "raise_os_error"]], "pyninja.main": [[1, 1, 1, "", "get_desc"], [1, 1, 1, "", "redirect_exception_handler"], [1, 1, 1, "", "start"]], "pyninja.models": [[1, 3, 1, "", "Database"], [1, 3, 1, "", "DiskLib"], [1, 3, 1, "", "EnvConfig"], [1, 3, 1, "", "Payload"], [1, 3, 1, "", "ProcessorLib"], [1, 3, 1, "", "RateLimit"], [1, 3, 1, "", "ServiceLib"], [1, 3, 1, "", "ServiceStatus"], [1, 3, 1, "", "Session"], [1, 3, 1, "", "WSSession"], [1, 3, 1, "", "WSSettings"], [1, 1, 1, "", "complexity_checker"], [1, 1, 1, "", "get_library"]], "pyninja.models.Database": [[1, 4, 1, "", "create_table"]], "pyninja.models.DiskLib": [[1, 5, 1, "", "darwin"], [1, 5, 1, "", "linux"], [1, 5, 1, "", "windows"]], "pyninja.models.EnvConfig": [[1, 3, 1, "", "Config"], [1, 5, 1, "", "api_secret"], [1, 5, 1, "", "apikey"], [1, 5, 1, "", "database"], [1, 5, 1, "", "disk_lib"], [1, 4, 1, "", "from_env_file"], [1, 5, 1, "", "log_config"], [1, 5, 1, "", "max_connections"], [1, 5, 1, "", "monitor_password"], [1, 5, 1, "", "monitor_session"], [1, 5, 1, "", "monitor_username"], [1, 5, 1, "", "ninja_host"], [1, 5, 1, "", "ninja_port"], [1, 4, 1, "", "parse_api_secret"], [1, 5, 1, "", "processor_lib"], [1, 5, 1, "", "rate_limit"], [1, 5, 1, "", "remote_execution"], [1, 5, 1, "", "service_lib"], [1, 5, 1, "", "workers"]], "pyninja.models.EnvConfig.Config": [[1, 5, 1, "", "extra"], [1, 5, 1, "", "hide_input_in_errors"]], "pyninja.models.Payload": [[1, 5, 1, "", "command"], [1, 5, 1, "", "timeout"]], "pyninja.models.ProcessorLib": [[1, 5, 1, "", "darwin"], [1, 5, 1, "", "linux"], [1, 5, 1, "", "windows"]], "pyninja.models.RateLimit": [[1, 5, 1, "", "max_requests"], [1, 5, 1, "", "seconds"]], "pyninja.models.ServiceLib": [[1, 5, 1, "", "darwin"], [1, 5, 1, "", "linux"], [1, 5, 1, "", "windows"]], "pyninja.models.ServiceStatus": [[1, 5, 1, "", "description"], [1, 5, 1, "", "status_code"]], "pyninja.models.Session": [[1, 5, 1, "", "allowed_origins"], [1, 5, 1, "", "auth_counter"], [1, 5, 1, "", "forbid"], [1, 5, 1, "", "info"], [1, 5, 1, "", "rps"]], "pyninja.models.WSSession": [[1, 5, 1, "", "_abc_impl"], [1, 5, 1, "", "client_auth"], [1, 5, 1, "", "invalid"], [1, 5, 1, "", "model_computed_fields"], [1, 5, 1, "", "model_config"], [1, 5, 1, "", "model_fields"]], "pyninja.models.WSSettings": [[1, 5, 1, "", "cpu_interval"], [1, 5, 1, "", "refresh_interval"]], "pyninja.monitor": [[1, 0, 0, "-", "authenticator"], [1, 0, 0, "-", "config"], [1, 0, 0, "-", "routes"], [1, 0, 0, "-", "secure"]], "pyninja.monitor.authenticator": [[1, 1, 1, "", "extract_credentials"], [1, 1, 1, "", "failed_auth_counter"], [1, 1, 1, "", "generate_cookie"], [1, 1, 1, "", "raise_error"], [1, 1, 1, "", "session_error"], [1, 1, 1, "", "validate_session"], [1, 1, 1, "", "verify_login"]], "pyninja.monitor.config": [[1, 1, 1, "", "capwords_filter"], [1, 1, 1, "", "clear_session"], [1, 1, 1, "", "get_expiry"]], "pyninja.monitor.routes": [[1, 1, 1, "", "error_endpoint"], [1, 1, 1, "", "login_endpoint"], [1, 1, 1, "", "logout_endpoint"], [1, 1, 1, "", "monitor_endpoint"], [1, 1, 1, "", "websocket_endpoint"]], "pyninja.monitor.secure": [[1, 1, 1, "", "base64_decode"], [1, 1, 1, "", "base64_encode"], [1, 1, 1, "", "calculate_hash"], [1, 1, 1, "", "hex_decode"], [1, 1, 1, "", "hex_encode"]], "pyninja.process": [[1, 1, 1, "", "get_performance"], [1, 1, 1, "", "get_process_status"]], "pyninja.rate_limit": [[1, 3, 1, "", "RateLimiter"]], "pyninja.rate_limit.RateLimiter": [[1, 4, 1, "", "init"]], "pyninja.routes": [[1, 1, 1, "", "docs"], [1, 1, 1, "", "get_all_disks"], [1, 1, 1, "", "get_all_routes"], [1, 1, 1, "", "get_cpu_load_avg"], [1, 1, 1, "", "get_cpu_utilization"], [1, 1, 1, "", "get_disk_utilization"], [1, 1, 1, "", "get_docker_containers"], [1, 1, 1, "", "get_docker_images"], [1, 1, 1, "", "get_docker_stats"], [1, 1, 1, "", "get_docker_volumes"], [1, 1, 1, "", "get_ip_address"], [1, 1, 1, "", "get_memory_utilization"], [1, 1, 1, "", "get_process_status"], [1, 1, 1, "", "get_processor_name"], [1, 1, 1, "", "get_service_status"], [1, 1, 1, "", "health"], [1, 1, 1, "", "run_command"]], "pyninja.service": [[1, 1, 1, "", "get_service_status"], [1, 1, 1, "", "running"], [1, 1, 1, "", "stopped"], [1, 1, 1, "", "unavailable"], [1, 1, 1, "", "unknown"]], "pyninja.squire": [[1, 1, 1, "", "dynamic_numbers"], [1, 1, 1, "", "envfile_loader"], [1, 1, 1, "", "format_nos"], [1, 1, 1, "", "format_timedelta"], [1, 1, 1, "", "get_cpu_percent"], [1, 1, 1, "", "get_docker_stats"], [1, 1, 1, "", "get_system_metrics"], [1, 1, 1, "", "keygen"], [1, 1, 1, "", "load_env"], [1, 1, 1, "", "private_ip_address"], [1, 1, 1, "", "process_command"], [1, 1, 1, "", "public_ip_address"], [1, 1, 1, "", "size_converter"], [1, 1, 1, "", "system_resources"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:exception", "3": "py:class", "4": "py:method", "5": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "exception", "Python exception"], "3": ["py", "class", "Python class"], "4": ["py", "method", "Python method"], "5": ["py", "attribute", "Python attribute"]}, "titleterms": {"pyninja": [0, 1], "kick": 0, "off": 0, "environ": 0, "variabl": 0, "code": 0, "standard": 0, "releas": 0, "note": 0, "lint": 0, "pypi": 0, "packag": 0, "runbook": 0, "licens": 0, "copyright": 0, "welcom": 1, "": 1, "document": 1, "content": 1, "main": 1, "authent": 1, "rout": 1, "monitor": 1, "docker": 1, "process": 1, "servic": 1, "databas": 1, "ratelimit": 1, "except": 1, "model": 1, "squir": 1, "configur": 1, "secur": 1, "indic": 1, "tabl": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}}) \ No newline at end of file diff --git a/pyninja/monitor/routes.py b/pyninja/monitor/routes.py index a67fe6d..f21fc2f 100644 --- a/pyninja/monitor/routes.py +++ b/pyninja/monitor/routes.py @@ -263,12 +263,16 @@ async def websocket_endpoint(websocket: WebSocket, session_token: str = Cookie(N # This can be gathered in the background, # but it will no longer be realtime data # making it useless for long intervals - data = squire.system_resources(models.ws_settings.cpu_interval) + data = await squire.system_resources(models.ws_settings.cpu_interval) try: await websocket.send_json(data) # There is no point in gathering data, when it is not propagated - # So instead of repeat iterations, simply sleep until next refresh - await asyncio.sleep(models.ws_settings.refresh_interval) + # So instead of repeat iterations, simply sleep until next_refresh - cpu_interval + # Eg: If refresh_interval is 10s and cpu_interval is 3s, the sleep time will be 7s + # This will ensure the data is always current, and always updating right before each push to the UI + await asyncio.sleep( + models.ws_settings.refresh_interval - models.ws_settings.cpu_interval + ) except WebSocketDisconnect: break except KeyboardInterrupt: diff --git a/pyninja/monitor/templates/main.html b/pyninja/monitor/templates/main.html index 7b93cc8..e6a6057 100644 --- a/pyninja/monitor/templates/main.html +++ b/pyninja/monitor/templates/main.html @@ -425,7 +425,7 @@

    Docker Stats

    // CPU Load Avg Graph const loadAverages = data.load_averages; if (loadChartInstance) { - loadChartInstance.data.datasets[0].data = [loadAverages["1m"], loadAverages["5m"], loadAverages["15m"]]; + loadChartInstance.data.datasets[0].data = [loadAverages["m1"], loadAverages["m5"], loadAverages["m15"]]; loadChartInstance.update(); } else { const ctx = document.getElementById('loadChart').getContext('2d'); @@ -435,7 +435,7 @@

    Docker Stats

    labels: ['1 minute', '5 minutes', '15 minutes'], datasets: [{ label: 'Load Average', - data: [loadAverages["1m"], loadAverages["5m"], loadAverages["15m"]], + data: [loadAverages["m1"], loadAverages["m5"], loadAverages["m15"]], backgroundColor: [ 'rgba(75, 192, 192, 0.2)', 'rgba(153, 102, 255, 0.2)', diff --git a/pyninja/routes.py b/pyninja/routes.py index 454bec9..ec535c7 100644 --- a/pyninja/routes.py +++ b/pyninja/routes.py @@ -132,7 +132,7 @@ async def get_cpu_load_avg( m1, m5, m15 = psutil.getloadavg() or (None, None, None) raise exceptions.APIResponse( status_code=HTTPStatus.OK.real, - detail={"1m": m1, "5m": m5, "15m": m15}, + detail=dict(m1=m1, m5=m5, m15=m15), ) diff --git a/pyninja/squire.py b/pyninja/squire.py index b88ffac..3293df9 100644 --- a/pyninja/squire.py +++ b/pyninja/squire.py @@ -1,3 +1,4 @@ +import asyncio import json import logging import math @@ -8,7 +9,7 @@ import shutil import socket import subprocess -from collections.abc import Generator +from concurrent.futures import ThreadPoolExecutor from datetime import timedelta from typing import Dict, List @@ -23,6 +24,8 @@ IP_REGEX = re.compile( r"""^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$""" # noqa: E501 ) +# Use a ThreadPoolExecutor to run blocking functions in separate threads +EXECUTOR = ThreadPoolExecutor(max_workers=2) def public_ip_address() -> str: @@ -72,31 +75,41 @@ def private_ip_address() -> str | None: return ip_address_ -def get_docker_stats() -> Generator[Dict[str, str]]: - """Run the docker stats command and parse the output into a list of key-value pairs. +def get_cpu_percent(cpu_interval: int) -> List[float]: + """Get CPU usage percentage. - Yields: - Dict[str, str]: - Yields key-value pairs with the container stat and value. + Args: + cpu_interval: System CPU times elapsed before and after the interval. + + Returns: + List[float]: + Returns a list of CPU percentages. """ - docker_stats_command = 'docker stats --no-stream --format "{{json .}}"' - try: - result = subprocess.run( - docker_stats_command, shell=True, capture_output=True, text=True - ) - except subprocess.CalledProcessError as error: - LOGGER.error(error) + return psutil.cpu_percent(interval=cpu_interval, percpu=True) + + +async def get_docker_stats() -> List[Dict[str, str]]: + """Run the docker stats command asynchronously and parse the output. + + Returns: + List[Dict[str, str]]: + Returns a list of key-value pairs with the container stat and value. + """ + process = await asyncio.create_subprocess_shell( + 'docker stats --no-stream --format "{{json .}}"', + stdout=asyncio.subprocess.PIPE, + stderr=asyncio.subprocess.PIPE, + ) + stdout, stderr = await process.communicate() + if stderr: + LOGGER.error(stderr.decode()) return [] - for line in result.stdout.strip().splitlines(): - yield json.loads(line) + return [json.loads(line) for line in stdout.decode().strip().splitlines()] # noinspection PyProtectedMember -def system_resources(cpu_interval: int) -> Dict[str, dict]: - """Get system resources like CPU, virtual memory and swap memory information. - - Args: - cpu_interval: Interval in seconds is used to compare CPU times elapsed before and after. +async def get_system_metrics() -> Dict[str, dict]: + """Async handler for virtual memory, swap memory disk usage and CPU load averages. Returns: Dict[str, dict]: @@ -104,16 +117,40 @@ def system_resources(cpu_interval: int) -> Dict[str, dict]: """ m1, m5, m15 = os.getloadavg() or (None, None, None) return dict( - cpu_usage=psutil.cpu_percent(interval=cpu_interval, percpu=True), memory_info=psutil.virtual_memory()._asdict(), swap_info=psutil.swap_memory()._asdict(), disk_info=shutil.disk_usage("/")._asdict(), - load_averages={"1m": m1, "5m": m5, "15m": m15}, + load_averages=dict(m1=m1, m5=m5, m15=m15), refresh_interval=models.ws_settings.refresh_interval, - docker_stats=list(get_docker_stats()), ) +async def system_resources(cpu_interval: int) -> Dict[str, dict]: + """Gather system resources including Docker stats asynchronously. + + Args: + cpu_interval: Interval in seconds is used to compare CPU times elapsed before and after. + + Returns: + Dict[str, dict]: + Returns a nested dictionary. + """ + system_metrics_task = asyncio.create_task(get_system_metrics()) + docker_stats_task = asyncio.create_task(get_docker_stats()) + + # CPU percent check is a blocking call and cannot be awaited, so run it in a separate thread + loop = asyncio.get_event_loop() + cpu_usage_task = loop.run_in_executor(EXECUTOR, get_cpu_percent, cpu_interval) + + system_metrics = await system_metrics_task + docker_stats = await docker_stats_task + cpu_usage = await cpu_usage_task + + system_metrics["cpu_usage"] = cpu_usage + system_metrics["docker_stats"] = docker_stats + return system_metrics + + def format_nos(input_: float) -> int | float: """Removes ``.0`` float values.