|
| 1 | +#!/usr/bin/env python3 |
| 2 | +# Copyright (C) NIWA & British Crown (Met Office) & Contributors. |
| 3 | +# |
| 4 | +# This program is free software: you can redistribute it and/or modify |
| 5 | +# it under the terms of the GNU General Public License as published by |
| 6 | +# the Free Software Foundation, either version 3 of the License, or |
| 7 | +# (at your option) any later version. |
| 8 | +# |
| 9 | +# This program is distributed in the hope that it will be useful, |
| 10 | +# but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | +# GNU General Public License for more details. |
| 13 | +# |
| 14 | +# You should have received a copy of the GNU General Public License |
| 15 | +# along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 16 | + |
| 17 | +"""Profilers for the ServerApp instance. |
| 18 | +
|
| 19 | +This is effectively a cut-down version of the cylc.flow.main_loop plugin |
| 20 | +system. It's only intended for developer use. |
| 21 | +
|
| 22 | +NOTE: All profiler specific imports are handled in their `__init__` methods |
| 23 | +to avoid importing profiler code when not requested. |
| 24 | +""" |
| 25 | + |
| 26 | +from time import time |
| 27 | +from types import SimpleNamespace |
| 28 | + |
| 29 | +from cylc.uiserver.config_util import USER_CONF_ROOT |
| 30 | + |
| 31 | + |
| 32 | +class Profiler: |
| 33 | + def __init__(self, app): |
| 34 | + self.app = app |
| 35 | + self.app.log.warning(f'Starting profiler: {self.__class__.__name__}') |
| 36 | + |
| 37 | + def periodic(self): |
| 38 | + pass |
| 39 | + |
| 40 | + def shutdown(self): |
| 41 | + pass |
| 42 | + |
| 43 | + |
| 44 | +class CProfiler(Profiler): |
| 45 | + """Invoke cprofile via the cylc.flow.profiler interface.""" |
| 46 | + |
| 47 | + def __init__(self, app): |
| 48 | + Profiler.__init__(self, app) |
| 49 | + |
| 50 | + from cylc.flow.profiler import Profiler as CylcCProfiler |
| 51 | + |
| 52 | + self.cprofiler = CylcCProfiler( |
| 53 | + # the profiler is designed to attach to a Cylc scheduler |
| 54 | + schd=SimpleNamespace(workflow_log_dir=USER_CONF_ROOT), |
| 55 | + enabled=True, |
| 56 | + ) |
| 57 | + |
| 58 | + self.cprofiler.start() |
| 59 | + |
| 60 | + def periodic(self): |
| 61 | + pass |
| 62 | + |
| 63 | + def shutdown(self): |
| 64 | + self.cprofiler.stop() |
| 65 | + |
| 66 | + |
| 67 | +class TrackObjects(Profiler): |
| 68 | + """Invoke pympler.asized via the cylc.main_loop.log_memory interface.""" |
| 69 | + |
| 70 | + def __init__(self, app): |
| 71 | + Profiler.__init__(self, app) |
| 72 | + |
| 73 | + from cylc.flow.main_loop.log_memory import ( |
| 74 | + _compute_sizes, |
| 75 | + _plot, |
| 76 | + _transpose, |
| 77 | + ) |
| 78 | + |
| 79 | + self._compute_sizes = _compute_sizes |
| 80 | + self._transpose = _transpose |
| 81 | + self._plot = _plot |
| 82 | + self.data = [] |
| 83 | + self.min_size = 100 |
| 84 | + self.obj = app |
| 85 | + |
| 86 | + def periodic(self): |
| 87 | + self.data.append( |
| 88 | + ( |
| 89 | + time(), |
| 90 | + self._compute_sizes(self.obj, min_size=self.min_size), |
| 91 | + ) |
| 92 | + ) |
| 93 | + |
| 94 | + def shutdown(self): |
| 95 | + self.periodic() |
| 96 | + fields, times = self._transpose(self.data) |
| 97 | + self._plot( |
| 98 | + fields, |
| 99 | + times, |
| 100 | + USER_CONF_ROOT, |
| 101 | + f'{self.obj} attrs > {self.min_size / 1000}kb', |
| 102 | + ) |
| 103 | + |
| 104 | + |
| 105 | +class TrackDataStore(TrackObjects): |
| 106 | + """Like TrackObjects but for the Data Store.""" |
| 107 | + |
| 108 | + def __init__(self, app): |
| 109 | + TrackObjects.__init__(self, app) |
| 110 | + self.obj = self.app.data_store_mgr |
| 111 | + |
| 112 | + |
| 113 | +PROFILERS = { |
| 114 | + 'cprofile': CProfiler, |
| 115 | + 'track_objects': TrackObjects, |
| 116 | + 'track_data_store': TrackDataStore, |
| 117 | +} |
| 118 | + |
| 119 | + |
| 120 | +def get_profiler(profiler: str): |
| 121 | + if not profiler: |
| 122 | + return None |
| 123 | + try: |
| 124 | + return PROFILERS[profiler] |
| 125 | + except KeyError: |
| 126 | + raise Exception( |
| 127 | + f'Unknown profiler: {profiler}' |
| 128 | + f'\nValid options: {", ".join(PROFILERS)}' |
| 129 | + ) |
0 commit comments