Skip to content

System info

System info adapter class for the ODIN server.

This class implements a system information adapter for the ODIN server, providing system-level information about the system to clients.

Tim Nicholls, STFC Application Engineering

SystemInfoAdapter

Bases: ApiAdapter

System info adapter class for the ODIN server.

This adapter provides ODIN clients with information about the server and the system that it is running on.

Source code in src/odin_control/adapters/system_info.py 
 99
100
101
102
103
104
105
106
107
108
class SystemInfoAdapter(ApiAdapter):
    """System info adapter class for the ODIN server.

    This adapter provides ODIN clients with information about the server and the system that it is
    running on.
    """

    version = __version__
    controller_cls = SystemInfoController
    error_cls = ParameterTreeError

SystemInfoController

Bases: BaseController

SystemInfoController class that extracts and stores system-level parameters.

Source code in src/odin_control/adapters/system_info.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
class SystemInfoController(BaseController):
    """SystemInfoController class that extracts and stores system-level parameters."""

    def __init__(self, options=None):
        """Initialise the SystemInfo object.

        This constructor initlialises the SystemInfo object, extracting various system-level
        parameters and storing them in a parameter tree to be accessible to clients.
        """
        # Store initialisation time
        self.init_time = time.time()

        # Extract platform information and store in parameter tree
        (system, node, release, version, _, processor) = platform.uname()
        platform_tree = ParameterTree({
            'name': 'platform',
            'description': "Information about the underlying platform",
            'system': (lambda: system, {
                "name": "system",
                "description": "operating system name",
            }),
            'node': (lambda: node, {
                "name": "node",
                "description": "node (host) name",
            }),
            'release': (lambda: release, {
                "name": "release",
                "description": "operating system release",
            }),
            'version': (lambda: version, {
                "name": "version",
                "description": "operating system version",
            }),
            'processor': (lambda: processor, {
                "name": "processor",
                "description": "processor (CPU) name",
            }),
        })

        # Store all information in a parameter tree
        self.param_tree = ParameterTree({
            'name': 'system_info',
            'description': 'Information about the system hosting this odin server instance',
            'odin_version': (lambda: __version__, {
                "name": "odin version",
                "description": "ODIN server version",
            }),
            'tornado_version': (lambda: tornado.version, {
                "name": "tornado version",
                "description": "version of tornado used in this server",
            }),
            'python_version': (lambda: platform.python_version(), {
                "name": "python version",
                "description": "version of python running this server",
            }),
            'platform': platform_tree,
            'server_uptime': (self.get_server_uptime, {
                "name": "server uptime",
                "description": "time since the ODIN server started",
                "units": "s",
                "display_precision": 2,
            }),
        })

    def get_server_uptime(self):
        """Get the uptime for the ODIN server.

        This method returns the current uptime for the ODIN server.
        """
        return time.time() - self.init_time

    def get(self, path, with_metadata=False):
        """Get the parameter tree.

        This method returns the parameter tree for use by clients via the SystemInfo adapter.

        :param path: path to retrieve from tree
        """
        return self.param_tree.get(path, with_metadata)

__init__(options=None)

Initialise the SystemInfo object.

This constructor initlialises the SystemInfo object, extracting various system-level parameters and storing them in a parameter tree to be accessible to clients.

Source code in src/odin_control/adapters/system_info.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
def __init__(self, options=None):
    """Initialise the SystemInfo object.

    This constructor initlialises the SystemInfo object, extracting various system-level
    parameters and storing them in a parameter tree to be accessible to clients.
    """
    # Store initialisation time
    self.init_time = time.time()

    # Extract platform information and store in parameter tree
    (system, node, release, version, _, processor) = platform.uname()
    platform_tree = ParameterTree({
        'name': 'platform',
        'description': "Information about the underlying platform",
        'system': (lambda: system, {
            "name": "system",
            "description": "operating system name",
        }),
        'node': (lambda: node, {
            "name": "node",
            "description": "node (host) name",
        }),
        'release': (lambda: release, {
            "name": "release",
            "description": "operating system release",
        }),
        'version': (lambda: version, {
            "name": "version",
            "description": "operating system version",
        }),
        'processor': (lambda: processor, {
            "name": "processor",
            "description": "processor (CPU) name",
        }),
    })

    # Store all information in a parameter tree
    self.param_tree = ParameterTree({
        'name': 'system_info',
        'description': 'Information about the system hosting this odin server instance',
        'odin_version': (lambda: __version__, {
            "name": "odin version",
            "description": "ODIN server version",
        }),
        'tornado_version': (lambda: tornado.version, {
            "name": "tornado version",
            "description": "version of tornado used in this server",
        }),
        'python_version': (lambda: platform.python_version(), {
            "name": "python version",
            "description": "version of python running this server",
        }),
        'platform': platform_tree,
        'server_uptime': (self.get_server_uptime, {
            "name": "server uptime",
            "description": "time since the ODIN server started",
            "units": "s",
            "display_precision": 2,
        }),
    })

get(path, with_metadata=False)

Get the parameter tree.

This method returns the parameter tree for use by clients via the SystemInfo adapter.

Parameters:

Name Type Description Default
path

path to retrieve from tree

 required
Source code in src/odin_control/adapters/system_info.py 
90
91
92
93
94
95
96
97
def get(self, path, with_metadata=False):
    """Get the parameter tree.

    This method returns the parameter tree for use by clients via the SystemInfo adapter.

    :param path: path to retrieve from tree
    """
    return self.param_tree.get(path, with_metadata)

get_server_uptime()

Get the uptime for the ODIN server.

This method returns the current uptime for the ODIN server.

Source code in src/odin_control/adapters/system_info.py 
83
84
85
86
87
88
def get_server_uptime(self):
    """Get the uptime for the ODIN server.

    This method returns the current uptime for the ODIN server.
    """
    return time.time() - self.init_time