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 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 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
|
from __future__ import annotations
import functools
import inspect
import itertools
from collections.abc import Callable, Iterable, Iterator, Sequence
from textwrap import TextWrapper, dedent
from typing import Any, Literal
from blessed import Terminal
from . import colors, utils
from .activities import sorted as sorted_processes
from .compat import link
from .keys import (
BINDINGS,
EXIT_KEY,
)
from .keys import HELP as HELP_KEY
from .keys import (
KEYS_BY_QUERYMODE,
MODES,
PAUSE_KEY,
PROCESS_CANCEL,
PROCESS_KILL,
PROCESS_PIN,
Key,
)
from .types import (
UI,
ActivityStats,
Column,
Host,
IOCounter,
Pct,
SelectableProcesses,
ServerInformation,
SystemInfo,
)
class line_counter:
def __init__(self, start: int) -> None:
self.value = start
def __repr__(self) -> str:
return f"{self.__class__.__name__}({self.value})"
def __next__(self) -> int:
current_value = self.value
self.value -= 1
return current_value
@functools.lru_cache(maxsize=512)
def shorten(term: Terminal, text: str, width: int | None = None) -> str:
r"""Truncate 'text' to fit in the given 'width' (or term.width).
This is similar to textwrap.shorten() but sequence-aware.
>>> term = Terminal()
>>> text = f"{term.green('hello')}, world"
>>> text
'hello, world'
>>> shorten(term, text, 6)
'hello,'
>>> shorten(term, text, 3)
'hel'
>>> shorten(term, "", 3)
''
"""
if not text:
return ""
wrapped = term.wrap(text, width=width, max_lines=1)
return wrapped[0] + term.normal
def limit(func: Callable[..., Iterable[str]]) -> Callable[..., None]:
"""View decorator handling screen height limit.
>>> term = Terminal()
>>> def view(term, n, *, prefix="line"):
... for i in range(n):
... yield f"{prefix} #{i}"
>>> count = line_counter(2)
>>> limit(view)(term, 3, lines_counter=count)
line #0
line #1
>>> count
line_counter(0)
>>> count = line_counter(3)
>>> limit(view)(term, 2, lines_counter=count)
line #0
line #1
>>> count
line_counter(1)
>>> limit(view)(term, 3, prefix="row")
row #0
row #1
row #2
A single line is displayed with an EOL as well:
>>> count = line_counter(10)
>>> limit(view)(term, 1, lines_counter=count) or print("<--", end="")
line #0
<--
>>> count
line_counter(9)
"""
@functools.wraps(func)
def wrapper(term: Terminal, *args: Any, **kwargs: Any) -> None:
counter = kwargs.pop("lines_counter", None)
width = kwargs.pop("width", None)
signature = inspect.signature(func)
if "width" in signature.parameters:
kwargs["width"] = width
for line in func(term, *args, **kwargs):
print(shorten(term, line, width) + term.clear_eol)
if counter is not None and next(counter) == 1:
break
return wrapper
@limit
def help(term: Terminal, version: str, is_local: bool) -> Iterable[str]:
"""Render help menu."""
project_url = "https://github.com/dalibo/pg_activity"
intro = dedent(
f"""\
{term.bold_green}pg_activity {version} - {link(term, project_url, project_url)}
{term.normal}Released under PostgreSQL License.
"""
)
def key_mappings(keys: Iterable[Key]) -> Iterable[str]:
for key in keys:
key_name = key.name or key.value
yield f"{term.bright_cyan}{key_name.rjust(10)}{term.normal}: {key.description}"
footer = "Press any key to exit."
yield from intro.splitlines()
yield ""
bindings = BINDINGS
if not is_local:
bindings = [b for b in bindings if not b.local_only]
yield from key_mappings(bindings)
yield "Mode"
yield from key_mappings(MODES)
yield ""
yield footer
@limit
def header(
term: Terminal,
ui: UI,
*,
host: Host,
pg_version: str,
server_information: ServerInformation,
system_info: SystemInfo | None = None,
) -> Iterator[str]:
@functools.singledispatch
def render(x: Any) -> str:
if x is None:
return "-"
raise AssertionError(f"not implemented for type '{type(x).__name__}'")
@render.register(str)
def render_str(s: str) -> str:
return term.bold_green(s)
@render.register(int)
def render_int(n: int) -> str:
return term.bold_green(str(n))
@render.register(Pct)
def render_pct(n: Pct) -> str:
return term.bold_green(f"{n:.2f}%")
@render.register(float)
def render_float(n: float) -> str:
return term.bold_green(f"{n:.2f}")
@render.register(IOCounter)
def render_iocounter(i: IOCounter) -> str:
hbytes = utils.naturalsize(i.bytes) + "/s"
counts = str(i.count) + "/s"
return f"{term.bold_green(hbytes)} - {term.bold_green(counts)}"
def render_columns(
columns: Sequence[list[str]], *, delimiter: str = f"{term.blue(',')} "
) -> Iterator[str]:
column_widths = [
max(len(column_row) for column_row in column) for column in columns
]
def indent(text: str) -> str:
return " " + text
for row in itertools.zip_longest(*columns, fillvalue=""):
yield indent(
"".join(
(cell + delimiter).ljust(width + len(delimiter))
for width, cell in zip(column_widths, row)
)
).rstrip().rstrip(delimiter.strip())
si = server_information
"""Return window header lines."""
pg_host = f"{host.user}@{host.host}:{host.port}/{host.dbname}"
yield (
" - ".join(
[
pg_version,
f"{term.bold}{host.hostname}{term.normal}",
f"{term.cyan}{pg_host}{term.normal}",
f"Ref.: {term.yellow}{ui.refresh_time}s{term.normal}",
f"Duration mode: {term.yellow}{ui.duration_mode.name}{term.normal}",
]
+ (
[f"Min. duration: {term.yellow}{ui.min_duration}s{term.normal}"]
if ui.min_duration
else []
)
)
)
total_size = utils.naturalsize(si.total_size)
size_ev = f"{utils.naturalsize(si.size_evolution)}/s"
uptime = utils.naturaltimedelta(si.uptime)
if ui.header.show_instance:
# First rows are always displayed, as the underlying data is always available.
columns = [
[f"* Global: {render(uptime)} uptime"],
[f"{render(total_size)} dbs size - {render(size_ev)} growth"],
[f"{render(si.cache_hit_ratio_last_snap)} cache hit ratio"],
[f"{render(si.rollback_ratio_last_snap)} rollback ratio"],
]
yield from render_columns(columns)
columns = [
[f" Sessions: {render(si.total)}/{render(si.max_connections)} total"],
[f"{render(si.active_connections)} active"],
[f"{render(si.idle)} idle"],
[f"{render(si.idle_in_transaction)} idle in txn"],
[f"{render(si.idle_in_transaction_aborted)} idle in txn abrt"],
[f"{render(si.waiting)} waiting"],
]
yield from render_columns(columns)
if si.temporary_file is not None:
temp_files = si.temporary_file.temp_files
temp_size = utils.naturalsize(si.temporary_file.temp_bytes)
else:
temp_files = None
temp_size = None
columns = [
[f" Activity: {render(si.tps)} tps"],
[f"{render(si.insert_per_second)} insert/s"],
[f"{render(si.update_per_second)} update/s"],
[f"{render(si.delete_per_second)} delete/s"],
[f"{render(si.tuples_returned_per_second)} tuples returned/s"],
[f"{render(temp_files)} temp files"],
[f"{render(temp_size)} temp size"],
]
yield from render_columns(columns)
if ui.header.show_workers:
columns = [
[
f"* Worker processes: {render(si.worker_processes)}/{render(si.max_worker_processes)} total"
],
[
f"{render(si.logical_replication_workers)}/{render(si.max_logical_replication_workers)} logical workers"
],
[
f"{render(si.parallel_workers)}/{render(si.max_parallel_workers)} parallel workers"
],
]
yield from render_columns(columns)
columns = [
[
f" Other processes & info: {render(si.autovacuum_workers)}/{render(si.autovacuum_max_workers)} autovacuum workers"
],
[f"{render(si.wal_senders)}/{render(si.max_wal_senders)} wal senders"],
[f"{render(si.wal_receivers)} wal receivers"],
[
f"{render(si.replication_slots)}/{render(si.max_replication_slots)} repl. slots"
],
]
yield from render_columns(columns)
# System information, only available in "local" mode.
if system_info is not None and ui.header.show_system:
used, bc, free, total = (
utils.naturalsize(system_info.memory.used),
utils.naturalsize(system_info.memory.buff_cached),
utils.naturalsize(system_info.memory.free),
utils.naturalsize(system_info.memory.total),
)
system_columns = [
[f"* Mem.: {render(total)} total"],
[f"{render(free)} ({render(system_info.memory.pct_free)}) free"],
[f"{render(used)} ({render(system_info.memory.pct_used)}) used"],
[f"{render(bc)} ({render(system_info.memory.pct_bc)}) buff+cached"],
]
yield from render_columns(system_columns)
used, free, total = (
utils.naturalsize(system_info.swap.used),
utils.naturalsize(system_info.swap.free),
utils.naturalsize(system_info.swap.total),
)
system_columns = [
[f" Swap: {render(total)} total"],
[f"{render(free)} ({render(system_info.swap.pct_free)}) free"],
[f"{render(used)} ({render(system_info.swap.pct_used)}) used"],
]
yield from render_columns(system_columns)
iops = f"{system_info.max_iops}/s"
system_columns = [
[f" IO: {render(iops)} max iops"],
[f"{render(system_info.io_read)} read"],
[f"{render(system_info.io_write)} write"],
]
yield from render_columns(system_columns)
load = system_info.load
system_columns = [
[
f" Load average: {render(load.avg1)} {render(load.avg5)} {render(load.avg15)}"
],
]
yield from render_columns(system_columns)
@limit
def query_mode(term: Terminal, ui: UI) -> Iterator[str]:
r"""Display query mode title.
>>> from pgactivity.types import QueryMode, UI
>>> term = Terminal()
>>> ui = UI.make(query_mode=QueryMode.blocking)
>>> query_mode(term, ui)
BLOCKING QUERIES
>>> ui = UI.make(query_mode=QueryMode.activities, in_pause=True)
>>> query_mode(term, ui) # doctest: +NORMALIZE_WHITESPACE
PAUSE
"""
if ui.in_pause:
yield term.black_on_yellow(term.center("PAUSE", fillchar=" "))
else:
yield term.green_bold(
term.center(ui.query_mode.value.upper(), fillchar=" ").rstrip()
)
@limit
def columns_header(term: Terminal, ui: UI) -> Iterator[str]:
"""Yield columns header lines."""
htitles = []
for column in ui.columns():
color = getattr(term, f"black_on_{column.title_color(ui.sort_key)}")
htitles.append(f"{color}{column.title_render()}")
yield term.ljust(" ".join(htitles), fillchar=" ") + term.normal
def get_indent(ui: UI) -> str:
"""Return indentation for Query column.
>>> from pgactivity.config import Flag
>>> from pgactivity.types import UI
>>> ui = UI.make(flag=Flag.CPU)
>>> get_indent(ui)
' '
>>> ui = UI.make(flag=Flag.PID | Flag.DATABASE | Flag.APPNAME | Flag.RELATION)
>>> get_indent(ui)
' '
"""
return " " * sum(c.min_width + 1 for c in ui.columns() if c.name != "Query")
def format_query(query: str, is_parallel_worker: bool) -> str:
r"""Return the query string formatted.
>>> print(format_query("SELECT 1", True))
\_ SELECT 1
>>> format_query("SELECT 1", False)
'SELECT 1'
"""
prefix = r"\_ " if is_parallel_worker else ""
return prefix + utils.clean_str(query)
@limit
def processes_rows(
term: Terminal,
ui: UI,
processes: SelectableProcesses,
maxlines: int,
width: int | None,
) -> Iterator[str]:
"""Display table rows with processes information."""
if width is None:
width = term.width
def cell(
value: Any,
column: Column,
cursor: Literal["pinned", "focused"] | None,
) -> None:
if cursor is not None:
if cursor == "pinned":
color_name = colors.PINNED_COLOR
elif cursor == "focused":
color_name = colors.FOCUSED_COLOR
else:
raise AssertionError(cursor)
else:
color_name = column.color(value) or "normal"
color = getattr(term, color_name or "normal")
# We also restore 'normal' style so that the next item does not
# inherit from that of the previous one.
text.append(f"{color}{column.render(value)}{term.normal}")
position = processes.position()
if position is None:
display_processes = iter(processes)
else:
# Scrolling is handled here. We just have to manage the start position of the
# display. the length is managed by @limit.
if ui.wrap_query:
# When the query is wrapped, we always display selected process first (sort
# of relative scrolling).
start = position
else:
# Otherwise, we compute the start position of the table and try to have a 5 lines
# leeway at the bottom of the page to increase readability.
start = 0
bottom = int(maxlines // 5)
if position is not None and position >= maxlines - bottom:
start = position - maxlines + 1 + bottom
display_processes = itertools.chain(
iter(processes[-(len(processes) - start) :]), iter(processes[:start])
)
focused, pinned = processes.focused, processes.pinned
for process in display_processes:
cursor: Literal["focused", "pinned"] | None = None
if process.pid == focused:
cursor = "focused"
elif process.pid in pinned:
cursor = "pinned"
text: list[str] = []
for column in ui.columns():
field = column.key
if field != "query":
cell(getattr(process, field), column, cursor=cursor)
indent = get_indent(ui) + " "
qwidth = width - len(indent)
if qwidth > 0 and process.query is not None:
query = format_query(process.query, process.is_parallel_worker)
if not ui.wrap_query:
query_value = query[:qwidth]
else:
wrapped_lines = TextWrapper(qwidth).wrap(query)
query_value = f"\n{indent}".join(wrapped_lines)
cell(query_value, ui.column("query"), cursor=cursor)
yield from (" ".join(text) + term.normal).splitlines()
def footer_message(term: Terminal, message: str, width: int | None = None) -> None:
if width is None:
width = term.width
print(term.center(message[:width]) + term.normal, end="")
def footer_help(term: Terminal, width: int | None = None) -> None:
"""Footer line with help keys."""
query_modes_help = [
("/".join(keys[:-1]), qm.value) for qm, keys in KEYS_BY_QUERYMODE.items()
]
assert PAUSE_KEY.name is not None
footer_values = query_modes_help + [
(PAUSE_KEY.name, PAUSE_KEY.description),
(EXIT_KEY.value, EXIT_KEY.description),
(HELP_KEY, "help"),
]
render_footer(term, footer_values, width)
def render_footer(
term: Terminal, footer_values: list[tuple[str, str]], width: int | None
) -> None:
if width is None:
width = term.width
ncols = len(footer_values)
column_width = (width - ncols - 1) // ncols
def render_column(key: str, desc: str) -> str:
col_width = column_width - term.length(key) - 1
if col_width <= 0:
return ""
desc = term.ljust(desc[:col_width], width=col_width, fillchar=" ")
return f"{key} {term.cyan_reverse(desc)}"
row = " ".join(
[render_column(key, desc.capitalize()) for key, desc in footer_values]
)
assert term.length(row) <= width, (term.length(row), width, ncols)
print(term.ljust(row, width=width, fillchar=term.cyan_reverse(" ")), end="")
def footer_interative_help(term: Terminal, width: int | None = None) -> None:
"""Footer line with help keys for interactive mode."""
assert PROCESS_PIN.name is not None
footer_values = [
(PROCESS_CANCEL, "cancel current query"),
(PROCESS_KILL, "terminate underlying session"),
(PROCESS_PIN.name, PROCESS_PIN.description),
("Other", "back to activities"),
(EXIT_KEY.value, EXIT_KEY.description),
]
return render_footer(term, footer_values, width)
def screen(
term: Terminal,
ui: UI,
*,
host: Host,
pg_version: str,
server_information: ServerInformation,
activity_stats: ActivityStats,
message: str | None,
render_header: bool = True,
render_footer: bool = True,
width: int | None = None,
) -> None:
"""Display the screen."""
system_info: SystemInfo | None
if isinstance(activity_stats, tuple):
processes, system_info = activity_stats
else:
processes, system_info = activity_stats, None
processes.set_items(sorted_processes(processes, key=ui.sort_key, reverse=True))
print(term.home, end="")
top_height = term.height - (1 if render_footer else 0)
lines_counter = line_counter(top_height)
if render_header:
header(
term,
ui,
host=host,
pg_version=pg_version,
server_information=server_information,
system_info=system_info,
lines_counter=lines_counter,
width=width,
)
query_mode(term, ui, lines_counter=lines_counter, width=width)
columns_header(term, ui, lines_counter=lines_counter, width=width)
processes_rows(
term,
ui,
processes,
maxlines=lines_counter.value, # Used by process_rows
lines_counter=lines_counter, # Used by @limit
width=width,
)
# Clear remaining lines in screen until footer (or EOS)
print(f"{term.clear_eol}\n" * lines_counter.value, end="")
if render_footer:
with term.location(x=0, y=top_height):
if message is not None:
footer_message(term, message, width)
elif ui.interactive():
footer_interative_help(term, width)
else:
footer_help(term, width)
|