glances_cpu.py 6.6 KB
Newer Older
A
Alessio Sergi 已提交
1 2
# -*- coding: utf-8 -*-
#
3
# This file is part of Glances.
A
Alessio Sergi 已提交
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
#
# Copyright (C) 2014 Nicolargo <nicolas@nicolargo.com>
#
# Glances is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Glances is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
19 20 21
"""
Glances CPU plugin
"""
A
Alessio Sergi 已提交
22

A
Alessio Sergi 已提交
23
import psutil
A
Alessio Sergi 已提交
24

25
from glances.plugins.glances_plugin import GlancesPlugin
A
Alessio Sergi 已提交
26

N
Nicolargo 已提交
27 28 29 30 31 32
# SNMP OID
# percentage of user CPU time: .1.3.6.1.4.1.2021.11.9.0
# percentages of system CPU time: .1.3.6.1.4.1.2021.11.10.0
# percentages of idle CPU time: .1.3.6.1.4.1.2021.11.11.0
snmp_oid = { 'user': '1.3.6.1.4.1.2021.11.9.0',
             'system': '1.3.6.1.4.1.2021.11.10.0',
N
Nicolargo 已提交
33
             'idle': '1.3.6.1.4.1.2021.11.11.0' }
A
Alessio Sergi 已提交
34 35 36 37 38 39 40 41

class Plugin(GlancesPlugin):
    """
    Glances' Cpu Plugin

    stats is a dict
    """

42 43
    def __init__(self, args=None):
        GlancesPlugin.__init__(self, args=args)
A
Alessio Sergi 已提交
44 45 46 47 48 49 50 51 52 53

        # We want to display the stat in the curse interface
        self.display_curse = True
        # Set the message position
        # It is NOT the curse position but the Glances column/line
        # Enter -1 to right align
        self.column_curse = 0
        # Enter -1 to diplay bottom
        self.line_curse = 1

54 55
        # Init stats
        self.first_call = True
N
Nicolargo 已提交
56 57 58 59 60 61
        self.reset()        

    def reset(self):
        """
        Reset/init the stats
        """
62 63
        self.stats = {}

N
Nicolargo 已提交
64
    def update(self, input='local'):
A
Alessio Sergi 已提交
65
        """
N
Nicolargo 已提交
66 67
        Update CPU stats using the input method
        Input method could be: local (mandatory) or snmp (optionnal)
A
Alessio Sergi 已提交
68 69
        """

N
Nicolargo 已提交
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 98 99 100
        # Reset stats
        self.reset()

        if input == 'local':
            # Update stats using the standard system lib

            # Grab CPU using the PSUtil cpu_times_percent method
            cputimespercent = psutil.cpu_times_percent(interval=0.0, percpu=False)

            # Get all possible value for CPU stats
            # user
            # system
            # idle
            # nice (UNIX)
            # iowait (Linux)
            # irq (Linux, FreeBSD)
            # softirq (Linux)
            # steal (Linux >= 2.6.11)
            # The following stats are returned by the API but not displayed in the UI:
            # guest (Linux >= 2.6.24)
            # guest_nice (Linux >= 3.2.0)
            for cpu in ['user', 'system', 'idle', 'nice',
                        'iowait', 'irq', 'softirq', 'steal',
                        'guest', 'guest_nice']:
                if hasattr(cputimespercent, cpu):
                    self.stats[cpu] = getattr(cputimespercent, cpu)
        elif input == 'snmp':
            # Update stats using SNMP
            self.stats = self.set_stats_snmp(snmp_oid=snmp_oid)
            for key in self.stats.iterkeys():
                self.stats[key] = float(self.stats[key])
A
Alessio Sergi 已提交
101 102 103 104 105

        return self.stats

    def msg_curse(self, args=None):
        """
106
        Return the list to display in the curse interface
A
Alessio Sergi 已提交
107
        """
108

A
Alessio Sergi 已提交
109 110 111
        # Init the return message
        ret = []

N
Nicolas Hennion 已提交
112
        # Only process if stats exist...
113
        if self.stats == {}:
N
Nicolas Hennion 已提交
114 115
            return ret

A
Alessio Sergi 已提交
116 117 118 119 120 121 122 123
        # Build the string message
        # Header
        msg = "{0:8}".format(_("CPU"))
        ret.append(self.curse_add_line(msg, "TITLE"))
        # Total CPU usage
        msg = "{0}".format(format((100 - self.stats['idle']) / 100, '>6.1%'))
        ret.append(self.curse_add_line(msg))
        # Steal CPU usage
124
        # ret.append(self.curse_add_line("  ", optional=True))
125
        if 'steal' in self.stats:
126
            msg = "  {0:8}".format(_("steal:"))
A
Alessio Sergi 已提交
127 128 129 130 131 132
            ret.append(self.curse_add_line(msg, optional=True))
            msg = "{0}".format(format(self.stats['steal'] / 100, '>6.1%'))
            ret.append(self.curse_add_line(msg, self.get_alert(self.stats['steal'], header="steal"), optional=True))
        # New line
        ret.append(self.curse_new_line())
        # User CPU
133
        if 'user' in self.stats:
A
Alessio Sergi 已提交
134 135 136 137 138
            msg = "{0:8}".format(_("user:"))
            ret.append(self.curse_add_line(msg))
            msg = "{0}".format(format(self.stats['user'] / 100, '>6.1%'))
            ret.append(self.curse_add_line(msg, self.get_alert_log(self.stats['user'], header="user")))
        # IOWait CPU
139
        # ret.append(self.curse_add_line("  ", optional=True))
140
        if 'iowait' in self.stats:
141
            msg = "  {0:8}".format(_("iowait:"))
A
Alessio Sergi 已提交
142 143 144 145 146 147
            ret.append(self.curse_add_line(msg, optional=True))
            msg = "{0}".format(format(self.stats['iowait'] / 100, '>6.1%'))
            ret.append(self.curse_add_line(msg, self.get_alert_log(self.stats['iowait'], header="iowait"), optional=True))
        # New line
        ret.append(self.curse_new_line())
        # System CPU
148
        if 'system' in self.stats:
A
Alessio Sergi 已提交
149 150 151 152 153
            msg = "{0:8}".format(_("system:"))
            ret.append(self.curse_add_line(msg))
            msg = "{0}".format(format(self.stats['system'] / 100, '>6.1%'))
            ret.append(self.curse_add_line(msg, self.get_alert_log(self.stats['system'], header="system")))
        # IRQ CPU
154
        # ret.append(self.curse_add_line("  ", optional=True))
155
        if 'irq' in self.stats:
156 157 158
            msg = "  {0:8}".format(_("irq:"))
            ret.append(self.curse_add_line(msg, optional=True))
            msg = "{0}".format(format(self.stats['irq'] / 100, '>6.1%'))
A
Alessio Sergi 已提交
159 160 161 162
            ret.append(self.curse_add_line(msg, optional=True))
        # New line
        ret.append(self.curse_new_line())
        # Nice CPU
163
        if 'nice' in self.stats:
164 165 166 167
            msg = "{0:8}".format(_("nice:"))
            ret.append(self.curse_add_line(msg))
            msg = "{0}".format(format(self.stats['nice'] / 100, '>6.1%'))
            ret.append(self.curse_add_line(msg))
A
Alessio Sergi 已提交
168
        # Idles CPU
169
        # ret.append(self.curse_add_line("  ", optional=True))
170
        if 'idle' in self.stats:
N
Nicolargo 已提交
171 172 173 174
            msg = ""
            if 'nice' in self.stats:
                msg = "  "            
            msg += "{0:8}".format(_("idle:"))
175 176 177
            ret.append(self.curse_add_line(msg, optional=True))
            msg = "{0}".format(format(self.stats['idle'] / 100, '>6.1%'))
            ret.append(self.curse_add_line(msg, optional=True))
A
Alessio Sergi 已提交
178 179 180

        # Return the message with decoration
        return ret