status_page.analytics package¶

Submodules¶

status_page.analytics.ping module¶

status_page.analytics.ping.ping(address: str) → bool¶: Pings an address and checks whether or not the address responds :param address: The address to ping :return: Whether or not the device responds to the ping

status_page.analytics.ping.port_ping(address: str, port: int) → bool¶: Pings an address at a specific port using nmap and checks whether or not the address responds :param address: The address to ping :param port: The port to ping :return: Whether or not the device responds to the ping

status_page.analytics.version module¶

status_page.analytics.version.get_gitlab_version(address: str, token: str) → str¶: Gets the version of a gitlab instance :param address: The address of the gitlab instance (excluding https) :param token: The API token used for authentication :return: The version, minus any

status_page.analytics.version.get_version_from_version_file(version_file: str) → str¶: Retrieves the version based on a version file :param version_file: The version file to read :return: The version

status_page.analytics.web module¶

status_page.analytics.web.test_webpage(address: str) → bool¶: Checks whether or not a web page is accesible :param address: The address to check :return: True if the web page is accessible (Code 200), else False.

Module contents¶

status_page.analytics.generate_analytics_data(server_list_config: Dict[str, Dict[str, Any]]) → Dict[str, Dict[str, Any]]¶: Analyzes the servers provided as argument and generates a dictionary containing data which can be visualized. :param server_list_config: The config to analyze :return: The analyzed data