Files
pgadmin4/web/pgadmin/dashboard/__init__.py
Aditya Toshniwal 862f101772 Significant changes to use ReactJS extensively.
1. Replace the current layout library wcDocker with ReactJS based rc-dock. #6479
2. Have close buttons on individual panel tabs instead of common. #2821
3. Changes in the context menu on panel tabs - Add close, close all and close others menu items. #5394
4. Allow closing all the tabs, including SQL and Properties. #4733
5. Changes in docking behaviour of different tabs based on user requests and remove lock layout menu.
6. Fix an issue where the scroll position of panels was not remembered on Firefox. #2986
7. Reset layout now will not require page refresh and is done spontaneously.
8. Use the zustand store for storing preferences instead of plain JS objects. This will help reflecting preferences immediately.
9. The above fix incorrect format (no indent) of SQL stored functions/procedures. #6720
10. New version check is moved to an async request now instead of app start to improve startup performance.
11. Remove jQuery and Bootstrap completely.
12. Replace jasmine and karma test runner with jest. Migrate all the JS test cases to jest. This will save time in writing and debugging JS tests.
13. Other important code improvements and cleanup.
2023-10-23 17:43:17 +05:30

657 lines
22 KiB
Python

##########################################################################
#
# pgAdmin 4 - PostgreSQL Tools
#
# Copyright (C) 2013 - 2023, The pgAdmin Development Team
# This software is released under the PostgreSQL Licence
#
##########################################################################
"""A blueprint module implementing the dashboard frame."""
import math
from functools import wraps
from flask import render_template, url_for, Response, g, request
from flask_babel import gettext
from flask_security import login_required
import json
from pgadmin.utils import PgAdminModule
from pgadmin.utils.ajax import make_response as ajax_response,\
internal_server_error
from pgadmin.utils.ajax import precondition_required
from pgadmin.utils.driver import get_driver
from pgadmin.utils.menu import Panel
from pgadmin.utils.preferences import Preferences
from pgadmin.utils.constants import PREF_LABEL_DISPLAY, MIMETYPE_APP_JS, \
PREF_LABEL_REFRESH_RATES
from config import PG_DEFAULT_DRIVER
MODULE_NAME = 'dashboard'
class DashboardModule(PgAdminModule):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
def get_own_menuitems(self):
return {}
def get_own_stylesheets(self):
"""
Returns:
list: the stylesheets used by this module.
"""
stylesheets = []
return stylesheets
def register_preferences(self):
"""
register_preferences
Register preferences for this module.
"""
help_string = gettext('The number of seconds between graph samples.')
# Register options for Dashboards
self.dashboard_preference = Preferences(
'dashboards', gettext('Dashboards')
)
self.session_stats_refresh = self.dashboard_preference.register(
'dashboards', 'session_stats_refresh',
gettext("Session statistics refresh rate"), 'integer',
5, min_val=1, max_val=999999,
category_label=PREF_LABEL_REFRESH_RATES,
help_str=help_string
)
self.tps_stats_refresh = self.dashboard_preference.register(
'dashboards', 'tps_stats_refresh',
gettext("Transaction throughput refresh rate"), 'integer',
5, min_val=1, max_val=999999,
category_label=PREF_LABEL_REFRESH_RATES,
help_str=help_string
)
self.ti_stats_refresh = self.dashboard_preference.register(
'dashboards', 'ti_stats_refresh',
gettext("Tuples in refresh rate"), 'integer',
5, min_val=1, max_val=999999,
category_label=PREF_LABEL_REFRESH_RATES,
help_str=help_string
)
self.to_stats_refresh = self.dashboard_preference.register(
'dashboards', 'to_stats_refresh',
gettext("Tuples out refresh rate"), 'integer',
5, min_val=1, max_val=999999,
category_label=PREF_LABEL_REFRESH_RATES,
help_str=help_string
)
self.bio_stats_refresh = self.dashboard_preference.register(
'dashboards', 'bio_stats_refresh',
gettext("Block I/O statistics refresh rate"), 'integer',
5, min_val=1, max_val=999999,
category_label=PREF_LABEL_REFRESH_RATES,
help_str=help_string
)
self.hpc_stats_refresh = self.dashboard_preference.register(
'dashboards', 'hpc_stats_refresh',
gettext("Handle & Process count statistics refresh rate"),
'integer', 5, min_val=1, max_val=999999,
category_label=PREF_LABEL_REFRESH_RATES,
help_str=help_string
)
self.cpu_stats_refresh = self.dashboard_preference.register(
'dashboards', 'cpu_stats_refresh',
gettext(
"Percentage of CPU time used by different process \
modes statistics refresh rate"
), 'integer', 5, min_val=1, max_val=999999,
category_label=PREF_LABEL_REFRESH_RATES,
help_str=help_string
)
self.la_stats_refresh = self.dashboard_preference.register(
'dashboards', 'la_stats_refresh',
gettext("Average load statistics refresh rate"), 'integer',
5, min_val=1, max_val=999999,
category_label=PREF_LABEL_REFRESH_RATES,
help_str=help_string
)
self.pcpu_stats_refresh = self.dashboard_preference.register(
'dashboards', 'pcpu_stats_refresh',
gettext("CPU usage per process statistics refresh rate"),
'integer', 5, min_val=1, max_val=999999,
category_label=PREF_LABEL_REFRESH_RATES,
help_str=help_string
)
self.m_stats_refresh = self.dashboard_preference.register(
'dashboards', 'm_stats_refresh',
gettext("Memory usage statistics refresh rate"), 'integer',
5, min_val=1, max_val=999999,
category_label=PREF_LABEL_REFRESH_RATES,
help_str=help_string
)
self.sm_stats_refresh = self.dashboard_preference.register(
'dashboards', 'sm_stats_refresh',
gettext("Swap memory usage statistics refresh rate"), 'integer',
5, min_val=1, max_val=999999,
category_label=PREF_LABEL_REFRESH_RATES,
help_str=help_string
)
self.pmu_stats_refresh = self.dashboard_preference.register(
'dashboards', 'pmu_stats_refresh',
gettext("Memory usage per process statistics refresh rate"),
'integer', 5, min_val=1, max_val=999999,
category_label=PREF_LABEL_REFRESH_RATES,
help_str=help_string
)
self.io_stats_refresh = self.dashboard_preference.register(
'dashboards', 'io_stats_refresh',
gettext("I/O analysis statistics refresh rate"), 'integer',
5, min_val=1, max_val=999999,
category_label=PREF_LABEL_REFRESH_RATES,
help_str=help_string
)
self.display_graphs = self.dashboard_preference.register(
'display', 'show_graphs',
gettext("Show graphs?"), 'boolean', True,
category_label=PREF_LABEL_DISPLAY,
help_str=gettext('If set to True, graphs '
'will be displayed on dashboards.')
)
self.display_server_activity = self.dashboard_preference.register(
'display', 'show_activity',
gettext("Show activity?"), 'boolean', True,
category_label=PREF_LABEL_DISPLAY,
help_str=gettext('If set to True, activity tables '
'will be displayed on dashboards.')
)
self.long_running_query_threshold = self.dashboard_preference.register(
'display', 'long_running_query_threshold',
gettext('Long running query thresholds'), 'threshold',
'2|5', category_label=PREF_LABEL_DISPLAY,
help_str=gettext('Set the warning and alert threshold value to '
'highlight the long-running queries on the '
'dashboard.')
)
# Register options for Graphs
self.graphs_preference = Preferences(
'graphs', gettext('Graphs')
)
self.graph_data_points = self.graphs_preference.register(
'graphs', 'graph_data_points',
gettext("Show graph data points?"), 'boolean', False,
category_label=PREF_LABEL_DISPLAY,
help_str=gettext('If set to True, data points will be '
'visible on graph lines.')
)
self.use_diff_point_style = self.graphs_preference.register(
'graphs', 'use_diff_point_style',
gettext("Use different data point styles?"), 'boolean', False,
category_label=PREF_LABEL_DISPLAY,
help_str=gettext('If set to True, data points will be visible '
'in a different style on each graph lines.')
)
self.graph_mouse_track = self.graphs_preference.register(
'graphs', 'graph_mouse_track',
gettext("Show mouse hover tooltip?"), 'boolean', True,
category_label=PREF_LABEL_DISPLAY,
help_str=gettext('If set to True, tooltip will appear on mouse '
'hover on the graph lines giving the data point '
'details')
)
self.graph_line_border_width = self.graphs_preference.register(
'graphs', 'graph_line_border_width',
gettext("Chart line width"), 'integer',
1, min_val=1, max_val=10,
category_label=PREF_LABEL_DISPLAY,
help_str=gettext('Set the width of the lines on the line chart.')
)
def get_exposed_url_endpoints(self):
"""
Returns:
list: a list of url endpoints exposed to the client.
"""
return [
'dashboard.index', 'dashboard.get_by_sever_id',
'dashboard.get_by_database_id',
'dashboard.dashboard_stats',
'dashboard.dashboard_stats_sid',
'dashboard.dashboard_stats_did',
'dashboard.activity',
'dashboard.get_activity_by_server_id',
'dashboard.get_activity_by_database_id',
'dashboard.locks',
'dashboard.get_locks_by_server_id',
'dashboard.get_locks_by_database_id',
'dashboard.prepared',
'dashboard.get_prepared_by_server_id',
'dashboard.get_prepared_by_database_id',
'dashboard.config',
'dashboard.get_config_by_server_id',
'dashboard.check_system_statistics',
'dashboard.check_system_statistics_sid',
'dashboard.check_system_statistics_did',
'dashboard.system_statistics',
'dashboard.system_statistics_sid',
'dashboard.system_statistics_did',
]
blueprint = DashboardModule(MODULE_NAME, __name__)
def check_precondition(f):
"""
This function will behave as a decorator which will check
database connection before running view, it also adds
manager, conn & template_path properties to self
"""
@wraps(f)
def wrap(*args, **kwargs):
# Here args[0] will hold self & kwargs will hold gid,sid,did
g.manager = get_driver(
PG_DEFAULT_DRIVER).connection_manager(
kwargs['sid']
)
def get_error(i_node_type):
stats_type = ('activity', 'prepared', 'locks', 'config')
if f.__name__ in stats_type:
return precondition_required(
gettext("Please connect to the selected {0}"
" to view the table.".format(i_node_type))
)
else:
return precondition_required(
gettext("Please connect to the selected {0}"
" to view the graph.".format(i_node_type))
)
# Below check handle the case where existing server is deleted
# by user and python server will raise exception if this check
# is not introduce.
if g.manager is None:
return get_error('server')
if 'did' in kwargs:
g.conn = g.manager.connection(did=kwargs['did'])
node_type = 'database'
else:
g.conn = g.manager.connection()
node_type = 'server'
# If not connected then return error to browser
if not g.conn.connected():
return get_error(node_type)
# Set template path for sql scripts
g.server_type = g.manager.server_type
g.version = g.manager.version
# Include server_type in template_path
g.template_path = 'dashboard/sql/' + (
'#{0}#'.format(g.version)
)
return f(*args, **kwargs)
return wrap
@blueprint.route("/dashboard.js")
@login_required
def script():
"""render the required javascript"""
return Response(
response=render_template(
"dashboard/js/dashboard.js",
_=gettext
),
status=200,
mimetype=MIMETYPE_APP_JS
)
@blueprint.route('/', endpoint='index')
@blueprint.route('/<int:sid>', endpoint='get_by_sever_id')
@blueprint.route('/<int:sid>/<int:did>', endpoint='get_by_database_id')
@login_required
def index(sid=None, did=None):
"""
Renders the welcome, server or database dashboard
Args:
sid: Server ID
did: Database ID
Returns: Welcome/Server/database dashboard
"""
rates = {}
# Get the server version
if sid is not None:
g.manager = get_driver(
PG_DEFAULT_DRIVER).connection_manager(sid)
g.conn = g.manager.connection()
g.version = g.manager.version
if not g.conn.connected():
g.version = 0
# Show the appropriate dashboard based on the identifiers passed to us
if sid is None and did is None:
return render_template('/dashboard/welcome_dashboard.html')
if did is None:
return render_template(
'/dashboard/server_dashboard.html',
sid=sid,
rates=rates,
version=g.version
)
else:
return render_template(
'/dashboard/database_dashboard.html',
sid=sid,
did=did,
rates=rates,
version=g.version
)
def get_data(sid, did, template, check_long_running_query=False):
"""
Generic function to get server stats based on an SQL template
Args:
sid: The server ID
did: The database ID
template: The SQL template name
check_long_running_query:
Returns:
"""
# Allow no server ID to be specified (so we can generate a route in JS)
# but throw an error if it's actually called.
if not sid:
return internal_server_error(errormsg='Server ID not specified.')
sql = render_template(
"/".join([g.template_path, template]), did=did
)
status, res = g.conn.execute_dict(sql)
if not status:
return internal_server_error(errormsg=res)
# Check the long running query status and set the row type.
if check_long_running_query:
get_long_running_query_status(res['rows'])
return ajax_response(
response=res['rows'],
status=200
)
def get_long_running_query_status(activities):
"""
This function is used to check the long running query and set the
row type to highlight the row color accordingly
"""
dash_preference = Preferences.module('dashboards')
long_running_query_threshold = \
dash_preference.preference('long_running_query_threshold').get()
if long_running_query_threshold is not None:
long_running_query_threshold = long_running_query_threshold.split('|')
warning_value = float(long_running_query_threshold[0]) \
if long_running_query_threshold[0] != '' else math.inf
alert_value = float(long_running_query_threshold[1]) \
if long_running_query_threshold[1] != '' else math.inf
for row in activities:
row['row_type'] = None
# We care for only those queries which are in active state and
# have active_since parameter and not None
if row['state'] == 'active' and 'active_since' in row and \
row['active_since'] is not None:
active_since = float(row['active_since'])
if active_since > warning_value:
row['row_type'] = 'warning'
if active_since > alert_value:
row['row_type'] = 'alert'
@blueprint.route('/dashboard_stats',
endpoint='dashboard_stats')
@blueprint.route('/dashboard_stats/<int:sid>',
endpoint='dashboard_stats_sid')
@blueprint.route('/dashboard_stats/<int:sid>/<int:did>',
endpoint='dashboard_stats_did')
@login_required
@check_precondition
def dashboard_stats(sid=None, did=None):
resp_data = {}
if request.args['chart_names'] != '':
chart_names = request.args['chart_names'].split(',')
if not sid:
return internal_server_error(errormsg='Server ID not specified.')
sql = render_template(
"/".join([g.template_path, 'dashboard_stats.sql']), did=did,
chart_names=chart_names,
)
status, res = g.conn.execute_dict(sql)
for chart_row in res['rows']:
resp_data[chart_row['chart_name']] = json.loads(
chart_row['chart_data'])
return ajax_response(
response=resp_data,
status=200
)
@blueprint.route('/activity/', endpoint='activity')
@blueprint.route('/activity/<int:sid>', endpoint='get_activity_by_server_id')
@blueprint.route(
'/activity/<int:sid>/<int:did>', endpoint='get_activity_by_database_id'
)
@login_required
@check_precondition
def activity(sid=None, did=None):
"""
This function returns server activity information
:param sid: server id
:return:
"""
return get_data(sid, did, 'activity.sql', True)
@blueprint.route('/locks/', endpoint='locks')
@blueprint.route('/locks/<int:sid>', endpoint='get_locks_by_server_id')
@blueprint.route(
'/locks/<int:sid>/<int:did>', endpoint='get_locks_by_database_id'
)
@login_required
@check_precondition
def locks(sid=None, did=None):
"""
This function returns server lock information
:param sid: server id
:return:
"""
return get_data(sid, did, 'locks.sql')
@blueprint.route('/prepared/', endpoint='prepared')
@blueprint.route('/prepared/<int:sid>', endpoint='get_prepared_by_server_id')
@blueprint.route(
'/prepared/<int:sid>/<int:did>', endpoint='get_prepared_by_database_id'
)
@login_required
@check_precondition
def prepared(sid=None, did=None):
"""
This function returns prepared XACT information
:param sid: server id
:return:
"""
return get_data(sid, did, 'prepared.sql')
@blueprint.route('/config/', endpoint='config')
@blueprint.route('/config/<int:sid>', endpoint='get_config_by_server_id')
@login_required
@check_precondition
def config(sid=None):
"""
This function returns server config information
:param sid: server id
:return:
"""
return get_data(sid, None, 'config.sql')
@blueprint.route(
'/cancel_query/<int:sid>/<int:pid>', methods=['DELETE']
)
@blueprint.route(
'/cancel_query/<int:sid>/<int:did>/<int:pid>', methods=['DELETE']
)
@login_required
@check_precondition
def cancel_query(sid=None, did=None, pid=None):
"""
This function cancel the specific session
:param sid: server id
:param did: database id
:param pid: session/process id
:return: Response
"""
sql = "SELECT pg_catalog.pg_cancel_backend({0});".format(pid)
status, res = g.conn.execute_scalar(sql)
if not status:
return internal_server_error(errormsg=res)
return ajax_response(
response=gettext("Success") if res else gettext("Failed"),
status=200
)
@blueprint.route(
'/terminate_session/<int:sid>/<int:pid>', methods=['DELETE']
)
@blueprint.route(
'/terminate_session/<int:sid>/<int:did>/<int:pid>', methods=['DELETE']
)
@login_required
@check_precondition
def terminate_session(sid=None, did=None, pid=None):
"""
This function terminate the specific session
:param sid: server id
:param did: database id
:param pid: session/process id
:return: Response
"""
sql = "SELECT pg_catalog.pg_terminate_backend({0});".format(pid)
status, res = g.conn.execute_scalar(sql)
if not status:
return internal_server_error(errormsg=res)
return ajax_response(
response=gettext("Success") if res else gettext("Failed"),
status=200
)
# To check whether system stats extesion is present or not
@blueprint.route('check_extension/system_statistics',
endpoint='check_system_statistics', methods=['GET'])
@blueprint.route('check_extension/system_statistics/<int:sid>',
endpoint='check_system_statistics_sid', methods=['GET'])
@blueprint.route('check_extension/system_statistics/<int:sid>/<int:did>',
endpoint='check_system_statistics_did', methods=['GET'])
@login_required
@check_precondition
def check_system_statistics(sid=None, did=None):
sql = "SELECT * FROM pg_extension WHERE extname = 'system_stats';"
status, res = g.conn.execute_scalar(sql)
if not status:
return internal_server_error(errormsg=res)
data = {}
if res is not None:
data['ss_present'] = True
else:
data['ss_present'] = False
return ajax_response(
response=data,
status=200
)
# System Statistics Backend
@blueprint.route('/system_statistics',
endpoint='system_statistics', methods=['GET'])
@blueprint.route('/system_statistics/<int:sid>',
endpoint='system_statistics_sid', methods=['GET'])
@blueprint.route('/system_statistics/<int:sid>/<int:did>',
endpoint='system_statistics_did', methods=['GET'])
@login_required
@check_precondition
def system_statistics(sid=None, did=None):
resp_data = {}
if request.args['chart_names'] != '':
chart_names = request.args['chart_names'].split(',')
if not sid:
return internal_server_error(errormsg='Server ID not specified.')
sql = render_template(
"/".join([g.template_path, 'system_statistics.sql']), did=did,
chart_names=chart_names,
)
status, res = g.conn.execute_dict(sql)
if not status:
return internal_server_error(errormsg=str(res))
for chart_row in res['rows']:
resp_data[chart_row['chart_name']] = json.loads(
chart_row['chart_data'])
return ajax_response(
response=resp_data,
status=200
)