354 lines
11 KiB
Python
354 lines
11 KiB
Python
"""
|
|
|
|
AUTHOR:
|
|
|
|
Khushal P Soonderji
|
|
|
|
DATE:
|
|
|
|
Wednesday, 25th Dec., 2024.
|
|
|
|
OBJECTIVE:
|
|
|
|
To provide a structure to work with enlisting servers and maintaining their status.
|
|
|
|
REFERENCES:
|
|
|
|
N/A
|
|
|
|
DOWNLOADS:
|
|
|
|
N/A
|
|
|
|
"""
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** IMPORT ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# To make sibling directories accessible for imports:
|
|
import sys
|
|
sys.path.append(".")
|
|
sys.path.append("..")
|
|
|
|
# For making data behaviour_models:
|
|
from pydantic import BaseModel, Field, field_validator, PastDatetime, model_validator, AwareDatetime, computed_field
|
|
from typing import Optional, Literal, Union
|
|
|
|
# My utils:
|
|
from utils_v2.string import json
|
|
from utils_v2.string import regex
|
|
from utils_v2.date_time import date_time
|
|
|
|
# To work with MongoDB:
|
|
from bson import ObjectId
|
|
|
|
# To work with date and time:
|
|
import datetime
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** MACROS / ONE-TIME INIT ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# --- Nothing Yet
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** VARIABLES ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# --- Nothing Yet
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** FUNCTIONS ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
class CoreServerInfoModel(BaseModel):
|
|
|
|
serverId: ObjectId | None = Field(
|
|
description = "the id of the document in mongodb that holds the info. about this server",
|
|
default = None,
|
|
frozen = True,
|
|
exclude = True,
|
|
alias = "_id"
|
|
)
|
|
|
|
hostname: str = Field(
|
|
description = "the hostname to identify the server",
|
|
frozen = True
|
|
)
|
|
|
|
os: str = Field(
|
|
description = "the os the server is running",
|
|
frozen = True
|
|
)
|
|
|
|
cpu: str = Field(
|
|
description = "the cpu that the server has in it",
|
|
frozen = True
|
|
)
|
|
|
|
pid: str | int = Field(
|
|
description = "the process id that registered the details of this server",
|
|
frozen = True
|
|
)
|
|
|
|
ppid: str | int = Field(
|
|
description = "the parent process id that registered the details of this server",
|
|
frozen = True
|
|
)
|
|
|
|
ipAddr: str | None = Field(
|
|
description = "the ip address of the server",
|
|
frozen = True
|
|
)
|
|
|
|
portNo: int = Field(
|
|
description = "the port no. that this service is running on",
|
|
default = None,
|
|
frozen = True
|
|
)
|
|
|
|
project: str = Field(
|
|
description = "the name of the project that this server is running",
|
|
frozen = True
|
|
)
|
|
|
|
service: str = Field(
|
|
description = "the service in the said project that this server is running",
|
|
frozen = True
|
|
)
|
|
|
|
description: str = Field(
|
|
description = "a brief description about this service",
|
|
max_length = 350,
|
|
frozen = True
|
|
)
|
|
|
|
healthCheckUrl: str = Field(
|
|
description = "a get request will be sent to this url to see if the server is up",
|
|
frozen = True
|
|
)
|
|
|
|
healthCheckInterval: int = Field(
|
|
description = "the seconds after which to check for the service being up",
|
|
ge = 30,
|
|
frozen = True
|
|
)
|
|
|
|
healthAlertUrl: str = Field(
|
|
description = "a get request will be sent to this url when the server goes offline",
|
|
frozen = True
|
|
)
|
|
|
|
online: bool = Field(
|
|
description = "whether this service is online or not",
|
|
default = False,
|
|
frozen = False
|
|
)
|
|
|
|
batchId: ObjectId | str | None = Field(
|
|
description = "set some value here when checking the status of this server, set it to null once done",
|
|
default = None,
|
|
frozen = False
|
|
)
|
|
|
|
batchTs: AwareDatetime | None = Field(
|
|
description = "set the time (utc) when checking the status of this server, set it to null once done",
|
|
default = None,
|
|
frozen = False
|
|
)
|
|
|
|
firstRegTs: AwareDatetime = Field(
|
|
description = "the first time (utc) this server was registered in the database",
|
|
default_factory = lambda: date_time.get_current_utc_date_time(as_string = False),
|
|
frozen = True
|
|
)
|
|
|
|
lastRegTs: AwareDatetime = Field(
|
|
description = "the last time (utc) this server was registered in the database",
|
|
default_factory = lambda: date_time.get_current_utc_date_time(as_string=False),
|
|
frozen = True
|
|
)
|
|
|
|
lastCheckTs: AwareDatetime | None = Field(
|
|
description = "the last time (utc) this server was checked for being online",
|
|
default = None,
|
|
frozen = True
|
|
)
|
|
|
|
@computed_field
|
|
def checkAfterTs(self) -> datetime.datetime:
|
|
if self.lastCheckTs is None: return date_time.get_current_utc_date_time(as_string = False)
|
|
else: return self.lastCheckTs + datetime.timedelta(seconds = self.healthCheckInterval)
|
|
|
|
# ┏┓ ┏•
|
|
# ┃ ┏┓┏┓╋┓┏┓
|
|
# ┗┛┗┛┛┗┛┗┗┫
|
|
# ┛
|
|
|
|
class Config:
|
|
extra = "ignore"
|
|
arbitrary_types_allowed = True
|
|
|
|
# ┓┏ ┓• ┓ •
|
|
# ┃┃┏┓┃┓┏┫┏┓╋┓┏┓┏┓
|
|
# ┗┛┗┻┗┗┗┻┗┻┗┗┗┛┛┗
|
|
|
|
@staticmethod
|
|
def parse_date_time(value):
|
|
|
|
# If a null value was given,
|
|
# we can't do anything:
|
|
if not value: value = None
|
|
|
|
# If the input is a string:
|
|
if isinstance(value, str):
|
|
value = value.strip()
|
|
value = date_time.parse_date_time(
|
|
input_value = value,
|
|
timezone = date_time.TIMEZONE_UTC,
|
|
date_formats = [
|
|
"%Y-%m-%d",
|
|
"%Y-%m-%d %M:%H:%S",
|
|
"%Y%m%d",
|
|
"%Y%m%d %M:%H:%S",
|
|
]
|
|
)
|
|
|
|
# If the input is already a date-time object,
|
|
# we just normalize the timestamp:
|
|
if isinstance(value, datetime.datetime):
|
|
value = date_time.to_timezone(
|
|
value,
|
|
timezone = date_time.TIMEZONE_UTC
|
|
)
|
|
|
|
# Done here:
|
|
return value
|
|
|
|
@field_validator(
|
|
"batchTs",
|
|
"firstRegTs", "lastRegTs",
|
|
"lastCheckTs",
|
|
mode = "before"
|
|
)
|
|
def parse_given_date_time(cls, value):
|
|
return cls.parse_date_time(value)
|
|
|
|
|
|
# ---------------------------------------------------------------------------------------------------------------------
|
|
|
|
|
|
class CoreServerCheckLogModel(BaseModel):
|
|
|
|
serverCheckId: ObjectId | None = Field(
|
|
description = "the id of the document in mongodb that holds the info. about this check",
|
|
default = None,
|
|
frozen = True,
|
|
exclude = True,
|
|
alias = "_id"
|
|
)
|
|
|
|
serverId: ObjectId = Field(
|
|
description = "the id of the server that we checked",
|
|
frozen = True
|
|
)
|
|
|
|
ts: AwareDatetime = Field(
|
|
description = "the time at which this check was made",
|
|
default_factory = lambda: date_time.get_current_utc_date_time(as_string = False),
|
|
frozen = True
|
|
)
|
|
|
|
latency: float | None = Field(
|
|
description = "the time the server took to respond to the health check",
|
|
default = None,
|
|
frozen = False
|
|
)
|
|
|
|
online: bool = Field(
|
|
description = "whether, or not, the server was online during this check",
|
|
default = False,
|
|
frozen = False
|
|
)
|
|
|
|
alertRaised: bool | None = Field(
|
|
description = "whether, or not, the alert url was successfully called (200 response)",
|
|
default = None,
|
|
frozen = False
|
|
)
|
|
|
|
message: str | None = Field(
|
|
description = "any additional message about this check",
|
|
default = None,
|
|
frozen = False
|
|
)
|
|
|
|
# ┏┓ ┏•
|
|
# ┃ ┏┓┏┓╋┓┏┓
|
|
# ┗┛┗┛┛┗┛┗┗┫
|
|
# ┛
|
|
|
|
class Config:
|
|
extra = "ignore"
|
|
arbitrary_types_allowed = True
|
|
|
|
# ┓┏ ┓• ┓ •
|
|
# ┃┃┏┓┃┓┏┫┏┓╋┓┏┓┏┓
|
|
# ┗┛┗┻┗┗┗┻┗┻┗┗┗┛┛┗
|
|
|
|
pass
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** MAIN PROGRAM ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
test_json = {
|
|
"hostname": "kbprod",
|
|
"os": "Ubuntu 22.04.5 LTS",
|
|
"cpu": "x86_64 (x86_64)",
|
|
"pid": 456,
|
|
"ppid": 123,
|
|
"ipAddr": "127.0.0.1",
|
|
"portNo": 5000,
|
|
"project": "Bicree",
|
|
"service": "user",
|
|
"description": "This is Bicree's user module.",
|
|
"healthCheckUrl": "https://v2.api.bicree.com/user/metrics/memory",
|
|
"healthCheckInterval": 30,
|
|
"healthAlertUrl": (
|
|
"https://nexcom.ditscentre.in/wtt/webhook/telegram/out"
|
|
"?appKey=9999999"
|
|
"&chatId=1275560043"
|
|
"&message=%F0%9F%9A%A8%20Bicree%27s%20user%20module%20is%20down%21%20Please%20check%20it%20urgently%21"
|
|
),
|
|
"online": True,
|
|
"batchId": None,
|
|
"batchTs": None
|
|
}
|
|
|
|
test_model = CoreServerInfoModel(**test_json)
|
|
print("TEST MODEL:", json.to_string(test_model.model_dump(), default = str))
|