summaryrefslogtreecommitdiffstats
path: root/tools/collectors/collector/collector.py
blob: 27a072022577f909ee55824d06c9f0dc4100168b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# Copyright 2015 Intel Corporation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Abstract "system metrics logger" model.
"""

CMD_PREFIX = 'metricscmd : '

class ICollector(object):
    """This is an abstract class for system metrics loggers.
    """

    def log_mem_stats(self):
        """Log memory statistics.

        Where implemented, this function should raise an exception on
        failure.
        """
        raise NotImplementedError('Please call an implementation.')

    def log_cpu_stats(self):
        """Log cpu statistics.

        Where implemented, this function should raise an exception on
        failure.
        """
        raise NotImplementedError('Please call an implementation.')