greatbody
/
glances
mirror of https://github.com/nicolargo/glances
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge branch 'pydantic_events' into develop

pull/2712/head
nicolargo 2024-03-17 17:07:40 +01:00
parent 272dc23443 40f06b9570
commit b11e085dc5
10 changed files with 156 additions and 111 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.rst
View File

@ -79,9 +79,12 @@ Requirements
============
- ``python>=3.8`` (use Glances 3.4.x for lower Python version)
- ``psutil>=5.3.0`` (better with latest version)
- ``psutil`` (better with latest version)
- ``defusedxml`` (in order to monkey patch xmlrpc)
- ``packaging`` (for the version comparison)
- ``ujson`` (an optimized alternative to the standard json module)
- ``pytz`` (for the timezone support)
- ``pydantic`` (for the data validation support)
*Note for Python 2 users*

89
glances/event.py Normal file
View File

@ -0,0 +1,89 @@
# -*- coding: utf-8 -*-
#
# This file is part of Glances.
#
# SPDX-FileCopyrightText: 2022 Nicolas Hennion <nicolas@nicolargo.com>
#
# SPDX-License-Identifier: LGPL-3.0-only
#
"""Manage Glances event class
This class is a Pydantic data class for the Glances event.
event_state = "OK|CAREFUL|WARNING|CRITICAL"
event_type = "CPU*|LOAD|MEM|MON"
event_value = value
Item (or event) is defined by:
{
"begin": "begin",
"end": "end",
"state": "WARNING|CRITICAL",
"type": "CPU|LOAD|MEM",
"max": MAX,
"avg": AVG,
"min": MIN,
"sum": SUM,
"count": COUNT,
"top": [top 3 process name],
"desc": "Processes description",
"sort": "top sort key",
"global": "global alert message"
}
"""
from pydantic.dataclasses import dataclass
from glances.processes import sort_stats
@dataclass
class GlancesEvent:
begin: int
state: str
type: str
min: float
max: float
sum: float
count: int
avg: float
top: list[str]
desc: str
sort: str
global_msg: str
end: int = -1
def is_ongoing(self):
"""Return True if the event is ongoing"""
return self.end == -1
def is_finished(self):
"""Return True if the event is finished"""
return self.end != -1
def update(self, state: str, value: float,
sort_key: str = None, proc_list: list = None,
proc_desc: str = None, global_msg: str = None):
"""Update an ongoing event"""
self.end = -1
self.min = min(self.min, value)
self.max = max(self.max, value)
self.sum += value
self.count += 1
self.avg = self.sum / self.count
if state == "CRITICAL":
# Avoid to change from CRITICAL to WARNING
# If an events have reached the CRITICAL state, it can't go back to WARNING
self.state = state
# TOP PROCESS LIST (only for CRITICAL ALERT)
self.sort = sort_key
self.top = [p['name'] for p in sort_stats(proc_list, sort_key)[0:3]]
# MONITORED PROCESSES DESC
self.desc = proc_desc
# Global message
self.global_msg = global_msg

150
glances/events.py → glances/events_list.py
View File

@ -7,14 +7,15 @@
# SPDX-License-Identifier: LGPL-3.0-only
#
"""Manage Glances events (previously Glances logs in Glances < 3.1)."""
"""Manage Glances events list (previously Glances logs in Glances < 3.1)."""
import time
from datetime import datetime
from pydantic import RootModel
from glances.logger import logger
from glances.processes import glances_processes, sort_stats
from glances.processes import glances_processes
from glances.thresholds import glances_thresholds
from glances.event import GlancesEvent
# Static decision tree for the global alert message
# - msg: Message to be displayed (result of the decision tree)
@ -25,7 +26,7 @@ from glances.thresholds import glances_thresholds
# - 2: WARNING
# - 3: CRITICAL
tree = [
{'msg': 'No warning or critical alert detected', 'thresholds': [], 'thresholds_min': 0},
{'msg': 'EVENTS history', 'thresholds': [], 'thresholds_min': 0},
{'msg': 'High CPU user mode', 'thresholds': ['cpu_user'], 'thresholds_min': 2},
{'msg': 'High CPU kernel usage', 'thresholds': ['cpu_system'], 'thresholds_min': 2},
{'msg': 'High CPU I/O waiting', 'thresholds': ['cpu_iowait'], 'thresholds_min': 2},
@ -161,31 +162,11 @@ def build_global_message():
return tree[0]['msg']
class GlancesEvents(object):
class GlancesEventsList(object):
"""This class manages events inside the Glances software.
Events is a list of event (stored in the self.events_list var)
event_state = "OK|CAREFUL|WARNING|CRITICAL"
event_type = "CPU*|LOAD|MEM|MON"
event_value = value
Item (or event) is defined by:
{
"begin": "begin",
"end": "end",
"state": "WARNING|CRITICAL",
"type": "CPU|LOAD|MEM",
"max": MAX,
"avg": AVG,
"min": MIN,
"sum": SUM,
"count": COUNT,
"top": [top 3 process name],
"desc": "Processes description",
"sort": "top sort key",
"global": "global alert message"
}
GlancesEventsList is a list of GlancesEvent.
GlancesEvent is defined in the event.py file
"""
def __init__(self, max_events=10, min_duration=6, min_interval=6):
@ -220,8 +201,8 @@ class GlancesEvents(object):
self.min_interval = min_interval
def get(self):
"""Return the raw events list."""
return self.events_list
"""Return the RAW events list."""
return [RootModel[GlancesEvent](e).model_dump() for e in self.events_list]
def len(self):
"""Return the number of events in the logs list."""
@ -234,9 +215,9 @@ class GlancesEvents(object):
Return -1 if the item is not found.
"""
for i in range(self.len()):
if ((self.events_list[i]['end'] < 0) or
(event_time - self.events_list[i]['end'] < self.min_interval)) and \
self.events_list[i]['type'] == event_type:
if (self.events_list[i].is_ongoing() or
(event_time - self.events_list[i].end < self.min_interval)) and \
self.events_list[i].type == event_type:
return i
return -1
@ -264,7 +245,7 @@ class GlancesEvents(object):
if glances_processes.auto_sort:
glances_processes.set_sort_key('auto')
def add(self, event_state, event_type, event_value, proc_list=None, proc_desc="", min_duration=None):
def add(self, event_state, event_type, event_value, proc_list=None, proc_desc=""):
"""Add a new item to the logs list.
event_state = "OK|CAREFUL|WARNING|CRITICAL"
@ -301,81 +282,52 @@ class GlancesEvents(object):
Item is added only if the criticality (event_state) is WARNING or CRITICAL.
"""
if event_state == "WARNING" or event_state == "CRITICAL":
# Define the automatic process sort key
self.set_process_sort(event_type)
if event_state not in ('WARNING', 'CRITICAL'):
return
# Create the new log item
# Time is stored in Epoch format
# Epoch -> DMYHMS = datetime.fromtimestamp(epoch)
item = {
"begin": event_time,
"end": -1,
"state": event_state,
"type": event_type,
"max": event_value,
"avg": event_value,
"min": event_value,
"sum": event_value,
"count": 1,
"top": [],
"desc": proc_desc,
"sort": glances_processes.sort_key,
"global": global_message,
}
# Define the automatic process sort key
self.set_process_sort(event_type)
# Add the item to the list
self.events_list.insert(0, item)
# Create the new log item
# Time is stored in Epoch format
# Epoch -> DMYHMS = datetime.fromtimestamp(epoch)
event = GlancesEvent(begin=event_time,
state=event_state,
type=event_type,
min=event_value, max=event_value, sum=event_value, count=1, avg=event_value,
top=[],
desc=proc_desc,
sort=glances_processes.sort_key,
global_msg=global_message)
# Limit the list to 'max_events' items
if self.len() > self.max_events:
self.events_list.pop()
return True
else:
return False
# Add the event to the list
self.events_list.insert(0, event)
# Limit the list to 'max_events' items
if self.len() > self.max_events:
self.events_list.pop()
def _update_event(self, event_time, event_index, event_state, event_type, event_value,
proc_list, proc_desc, global_message):
"""Update an event in the list"""
if event_state in ('OK', 'CAREFUL') and self.events_list[event_index]['end'] < 0:
if event_state in ('OK', 'CAREFUL') and self.events_list[event_index].is_ongoing():
# Close the event
self._close_event(event_time, event_index)
elif event_state in ('OK', 'CAREFUL') and self.events_list[event_index]['end'] >= 0:
elif event_state in ('OK', 'CAREFUL') and self.events_list[event_index].is_finished():
# Event is already closed, do nothing
pass
else: # event_state == "WARNING" or event_state == "CRITICAL"
# Set process sort key
self.set_process_sort(event_type)
# It's an ongoing event, set the end time to -1
self.events_list[event_index]['end'] = -1
# Min/Max/Sum/Count/Avergae value
self.events_list[event_index]['min'] = min(self.events_list[event_index]['min'], event_value)
self.events_list[event_index]['max'] = max(self.events_list[event_index]['max'], event_value)
self.events_list[event_index]['sum'] += event_value
self.events_list[event_index]['count'] += 1
self.events_list[event_index]['avg'] = self.events_list[event_index]['sum'] / self.events_list[event_index]['count']
if event_state == "CRITICAL":
# Avoid to change from CRITICAL to WARNING
# If an events have reached the CRITICAL state, it can't go back to WARNING
self.events_list[event_index]['state'] = event_state
# TOP PROCESS LIST (only for CRITICAL ALERT)
events_sort_key = self.get_event_sort_key(event_type)
# Sort the current process list to retrieve the TOP 3 processes
self.events_list[event_index]['top'] = [p['name'] for p in sort_stats(proc_list, events_sort_key)[0:3]]
self.events_list[event_index]['sort'] = events_sort_key
# MONITORED PROCESSES DESC
self.events_list[event_index]['desc'] = proc_desc
# Global message:
self.events_list[event_index]['global'] = global_message
return True
# Update an ongoing event
self.events_list[event_index].update(
state=event_state,
value=event_value,
sort_key=self.get_event_sort_key(event_type),
proc_list=proc_list,
proc_desc=proc_desc,
global_msg=global_message)
def _close_event(self, event_time, event_index):
"""Close an event in the list"""
@ -383,9 +335,9 @@ class GlancesEvents(object):
self.reset_process_sort()
# Set the end of the events
if event_time - self.events_list[event_index]['begin'] >= self.min_duration:
if event_time - self.events_list[event_index].begin >= self.min_duration:
# If event is >= min_duration seconds
self.events_list[event_index]['end'] = event_time
self.events_list[event_index].end = event_time
else:
# If event < min_duration seconds, ignore
self.events_list.remove(self.events_list[event_index])
@ -399,12 +351,12 @@ class GlancesEvents(object):
# Create a new clean list
clean_events_list = []
while self.len() > 0:
item = self.events_list.pop()
if item['end'] < 0 or (not critical and item['state'].startswith("CRITICAL")):
clean_events_list.insert(0, item)
event = self.events_list.pop()
if event.end < 0 or (not critical and event.state.startswith("CRITICAL")):
clean_events_list.insert(0, event)
# The list is now the clean one
self.events_list = clean_events_list
return self.len()
glances_events = GlancesEvents()
glances_events = GlancesEventsList()

2
glances/outputs/glances_curses.py
View File

@ -14,7 +14,7 @@ import sys
from glances.globals import MACOS, WINDOWS, nativestr, u, itervalues, enable, disable
from glances.logger import logger
from glances.events import glances_events
from glances.events_list import glances_events
from glances.processes import glances_processes, sort_processes_key_list
from glances.outputs.glances_unicode import unicode_message
from glances.timer import Timer

1
glances/outputs/static/js/components/plugin-alert.vue
View File

@ -53,7 +53,6 @@ export default {
alert.avg = alertalertStats.avg;
alert.max = alertalertStats.max;
alert.top = alertalertStats.top.join(', ');
alert.global = alertalertStats.global;
if (!alert.ongoing) {
const duration = alert.end - alert.begin;

2
glances/outputs/static/public/glances.js vendored
View File

File diff suppressed because one or more lines are too long

11
glances/plugins/alert/__init__.py
View File

@ -13,7 +13,7 @@ from datetime import datetime
from time import tzname
import pytz
from glances.events import glances_events
from glances.events_list import glances_events
# from glances.logger import logger
from glances.plugins.plugin.model import GlancesPluginModel
@ -88,7 +88,7 @@ fields_description = {
'description': 'Sort key of the top processes',
'unit': 'string',
},
'global': {
'global_msg': {
'description': 'Global alert message',
'unit': 'string',
}
@ -137,10 +137,11 @@ class PluginModel(GlancesPluginModel):
# Build the string message
# Header with the global message
if len(self.stats) > 0 and self.stats[0]['end'] < 0 and 'global' in self.stats[0]:
ret.append(self.curse_add_line(self.stats[0]['global'], "TITLE"))
global_message = [e['global_msg'] for e in self.stats if (e['end'] == -1 and 'global_msg' in e)]
if len(global_message) > 0:
ret.append(self.curse_add_line(global_message[0], "TITLE"))
else:
ret.append(self.curse_add_line("ALERTS", "TITLE"))
ret.append(self.curse_add_line("EVENTS history", "TITLE"))
# Loop over alerts
for alert in self.stats:
# New line

2
glances/plugins/plugin/model.py
View File

@ -20,7 +20,7 @@ from glances.globals import iterkeys, itervalues, listkeys, mean, nativestr, jso
from glances.actions import GlancesActions
from glances.history import GlancesHistory
from glances.logger import logger
from glances.events import glances_events
from glances.events_list import glances_events
from glances.thresholds import glances_thresholds
from glances.timer import Counter, Timer, getTimeSinceLastUpdate
from glances.outputs.glances_unicode import unicode_message

1
requirements.txt
View File

@ -3,3 +3,4 @@ defusedxml
packaging
ujson>=5.4.0
pytz
pydantic

4
unitest.py
View File

@ -32,7 +32,7 @@ from glances.thresholds import GlancesThresholds
from glances.plugins.plugin.model import GlancesPluginModel
from glances.programs import processes_to_programs
from glances.secure import secure_popen
from glances.events import GlancesEvents
from glances.events_list import GlancesEventsList
# Global variables
# =================
@ -298,7 +298,7 @@ class TestGlances(unittest.TestCase):
"""Test events class"""
print('INFO: [TEST_019] Test events')
# Init events
events = GlancesEvents(max_events=5, min_duration=1, min_interval=3)
events = GlancesEventsList(max_events=5, min_duration=1, min_interval=3)
# Minimal event duration not reached
events.add('WARNING', 'LOAD', 4)
events.add('CRITICAL', 'LOAD', 5)