Skip to content

Commit 631d140

Browse files
gaoxueyugaoxueyu
authored
Merge pull request #222 from jiaoshuntian/master
add ecosystem components pg_stat_monitor
2 parents 6012d00 + 7b57b2e commit 631d140

File tree

6 files changed

+200
-0
lines changed

6 files changed

+200
-0
lines changed

‎CN/modules/ROOT/nav.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
**** xref:master/ecosystem_components/pgrouting.adoc[pgrouting]
3838
**** xref:master/ecosystem_components/system_stats.adoc[system_stats]
3939
**** xref:master/ecosystem_components/wal2json.adoc[wal2json]
40+
**** xref:master/ecosystem_components/pg_stat_monitor.adoc[pg_stat_monitor]
4041
** IvorySQL架构设计
4142
*** 查询处理
4243
**** xref:master/architecture/dual_parser.adoc[双parser]

‎CN/modules/ROOT/pages/master/ecosystem_components/ecosystem_overview.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ IvorySQL 作为一款兼容 Oracle 且基于 PostgreSQL 的高级开源数据库
2222
| 9 | xref:master/ecosystem_components/pgrouting.adoc[pgrouting] | 3.8.0 | 提供地理空间数据的路由计算功能，支持多种算法和数据格式 | 地理空间分析、路径规划、物流优化
2323
| 10 | xref:master/ecosystem_components/system_stats.adoc[system_stats] | 3.2 | 提供用于访问系统级统计信息的函数 | 系统监控
2424
| 11 | xref:master/ecosystem_components/pg_ai_query.adoc[pg_ai_query] | 0.1.1 | AI驱动的自然语言转SQL扩展，支持多种大语言模型 | AI辅助查询、自然语言数据库交互
25+
| 12 | xref:master/ecosystem_components/pg_stat_monitor.adoc[pg_stat_monitor] | 2.3.1 | 收集性能统计数据，并通过统一视图和直方图形式直观展示查询性能指标。 | 性能监控
2526
|====
2627

2728
这些插件均经过 IvorySQL 团队的测试和适配，确保在 IvorySQL 环境下稳定运行。用户可以根据业务需求选择合适的插件，进一步提升数据库系统的能力和灵活性。

‎CN/modules/ROOT/pages/master/ecosystem_components/pg_stat_monitor.adoc‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
:sectnums:
2+
:sectnumlevels: 5
3+
4+
= pg_stat_monitor
5+
6+
== 概述
7+
8+
pg_stat_monitor 是 PostgreSQL 的查询性能监控工具。它能收集性能统计数据，并通过统一视图和直方图形式直观展示查询性能指标。
9+
10+
该工具可帮助数据库用户全面掌握查询来源、执行情况、计划统计与详细信息，以及查询元数据。这极大地提升了可观测性，使用户能够有效调试和优化查询性能。
11+
12+
== 安装
13+
14+
IvorySQL的安装包里已经集成了pg_stat_monitor插件，如果使用安装包安装的IvorySQL，通常不需要再手动安装pg_stat_monitor。如您使用源码方式安装了IvorySQL，可以继续通过源码方式继续安装pg_stat_monitor插件，IvorySQL社区为您提供了源码安装步骤：
15+
16+
要从源代码构建 pg_stat_monitor，您需要以下组件:
17+
18+
* git
19+
* make
20+
* gcc
21+
* pg_config
22+
23+
您可以从 https://github.com/Percona/pg_stat_monitor/releases[GitHub 上的发布页面] 下载 pg_stat_monitor 指定版本的源代码，或者使用 git 命令：
24+
25+
[source,bash]
26+
----
27+
git clone https://github.com/percona/pg_stat_monitor.git
28+
----
29+
30+
编译并安装扩展程序，假如环境中已经安装了IvorySQL，安装路径为/usr/ivory-5
31+
32+
[source,bash]
33+
----
34+
cd pg_stat_monitor
35+
export PG_CONFIG=/usr/ivory-5/bin/pg_config
36+
make USE_PGXS=1
37+
make USE_PGXS=1 install
38+
----
39+
40+
== 加载模块
41+
42+
在启动时，将 pg_stat_monitor 添加到 shared_preload_libraries 配置参数中，以加载该库。这是因为 pg_stat_monitor 需要额外的共享内存。
43+
44+
修改 shared_preload_libraries 参数：
45+
46+
[source,conf]
47+
----
48+
shared_preload_libraries = 'pg_stat_monitor';
49+
----
50+
51+
注意：若 shared_preload_libraries 参数中已存在其他模块（例如 pg_stat_statements），需用逗号分隔全部列出。pg_stat_monitor 必须排在 pg_stat_statements 之后，例如：
52+
53+
[source,conf]
54+
----
55+
shared_preload_libraries = 'liboracle_parser, ivorysql_ora, pg_stat_statements, pg_stat_monitor';
56+
----
57+
58+
配置完成后，重启 IvorySQL实例使配置生效。
59+
60+
[source,bash]
61+
----
62+
pg_ctl restart -D data
63+
----
64+
65+
将 pg_stat_monitor 添加至 shared_preload_libraries 后，该扩展会立即开始收集所有现有数据库的统计信息。要查看监控数据，需在每个待监控的数据库中创建视图。
66+
67+
== 创建扩展视图
68+
69+
请使用具有超级用户或数据库所有者权限的账户执行以下操作。以超级用户身份连接至目标数据库，运行以下命令创建扩展：
70+
71+
[source,sql]
72+
----
73+
CREATE EXTENSION pg_stat_monitor;
74+
----
75+
76+
完成设置后，即可查看pg_stat_monitor收集的统计信息。
77+
78+
== 使用
79+
80+
以获取查询执行时间信息为例，连接数据库执行以下SQL：
81+
82+
[source,sql]
83+
----
84+
SELECT userid, total_exec_time, min_exec_time, max_exec_time, mean_exec_time, query FROM pg_stat_monitor;
85+
----
86+
87+
[source,text]
88+
----
89+
userid | total_exec_time | min_exec_time | max_exec_time | mean_exec_time | query
90+
--------+-----------------+---------------+---------------+----------------+----------------------------------------------------------------------------------------------
91+
10 | 1.532168 | 0.749108 | 0.78306 | 0.766084 | SELECT userid, datname, queryid, substr(query,$1, $2) AS query, calls FROM pg_stat_monitor
92+
10 | 0.755857 | 0.755857 | 0.755857 | 0.755857 | SELECT application_name, client_ip, substr(query,$1,$2) as query FROM pg_stat_monitor
93+
10 | 0 | 0 | 0 | 0 | SELECT userid, total_time, min_time, max_time, mean_time, query FROM pg_stat_monitor;
94+
10 | 0 | 0 | 0 | 0 | SELECT userid, total_exec_time, min_time, max_time, mean_time, query FROM pg_stat_monitor;
95+
(4 rows)
96+
----
97+
98+
更多关于pg_stat_monitor的使用，请参阅 pg_stat_monitor https://docs.percona.com/pg-stat-monitor/user_guide.html[官方文档]

‎EN/modules/ROOT/nav.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
*** xref:master/ecosystem_components/pgrouting.adoc[pgrouting]
3737
*** xref:master/ecosystem_components/system_stats.adoc[system_stats]
3838
*** xref:master/ecosystem_components/wal2json.adoc[wal2json]
39+
*** xref:master/ecosystem_components/pg_stat_monitor.adoc[pg_stat_monitor]
3940
* IvorySQL Architecture Design
4041
** Query Processing
4142
*** xref:master/architecture/dual_parser.adoc[Dual Parser]

‎EN/modules/ROOT/pages/master/ecosystem_components/ecosystem_overview.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ IvorySQL, as an advanced open-source database compatible with Oracle and based o
2323
|*9*| xref:master/ecosystem_components/pgrouting.adoc[pgrouting] | 3.8.0 | Provides routing computation for geospatial data, supporting multiple algorithms and data formats | Geospatial analysis, route planning, logistics optimization
2424
|*10*| xref:master/ecosystem_components/system_stats.adoc[system_stats] | 3.2 | Provide functions for accessing system-level statistics. | system monitor
2525
|*11*| xref:master/ecosystem_components/pg_ai_query.adoc[pg_ai_query] | 0.1.1 | AI-driven natural language to SQL extension supporting multiple LLMs | AI-assisted querying, natural language database interaction
26+
|*12*| xref:master/ecosystem_components/pg_stat_monitor.adoc[pg_stat_monitor] | 2.3.1 | Collects performance statistics and provides query performance insights in a single view and graphically in histogram. | Performance monitoring
2627
|====
2728

2829
These plugins have all been tested and adapted by the IvorySQL team to ensure stable operation in the IvorySQL environment. Users can select appropriate plugins based on business needs to further enhance the capabilities and flexibility of the database system.

‎EN/modules/ROOT/pages/master/ecosystem_components/pg_stat_monitor.adoc‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
:sectnums:
2+
:sectnumlevels: 5
3+
4+
= pg_stat_monitor
5+
6+
== Overview
7+
8+
pg_stat_monitor is a Query Performance Monitoring tool for PostgreSQL. pg_stat_monitor collects performance statistics and provides query performance insights in a single view and graphically in histogram.
9+
10+
These insights allow database users to understand query origins, execution, planning statistics and details, query information, and metadata. This significantly improves observability, enabling users to debug and tune query performance.
11+
12+
== Installation
13+
14+
The IvorySQL installation package already includes the pg_stat_monitor plugin. If you installed IvorySQL using the installation package, you typically don't need to manually install pg_stat_monitor. If you installed IvorySQL from source code, you can proceed to install the pg_stat_monitor plugin also from source. The IvorySQL community provides step-by-step instructions for source code installation：
15+
16+
To build pg_stat_monitor from source code, you require the following:
17+
18+
* git
19+
* make
20+
* gcc
21+
* pg_config
22+
23+
You can download the source code of the latest release of pg_stat_monitor from https://github.com/Percona/pg_stat_monitor/releases[the releases page on GitHub] or using git:
24+
25+
[source,bash]
26+
----
27+
git clone https://github.com/percona/pg_stat_monitor.git
28+
----
29+
30+
Compile and install the extension. Assuming IvorySQL is already installed in the environment with the installation path at /usr/ivory-5.
31+
32+
[source,bash]
33+
----
34+
cd pg_stat_monitor
35+
export PG_CONFIG=/usr/ivory-5/bin/pg_config
36+
make USE_PGXS=1
37+
make USE_PGXS=1 install
38+
----
39+
40+
== Load the module
41+
42+
Load pg_stat_monitor at the start time by adding it to the shared_preload_libraries configuration parameter. This is because pg_stat_monitor requires additional shared memory.
43+
44+
modify the shared_preload_libraries parameter：
45+
46+
[source,conf]
47+
----
48+
shared_preload_libraries = 'pg_stat_monitor';
49+
----
50+
51+
NOTE: If you’ve added other modules to the shared_preload_libraries parameter (for example, pg_stat_statements), list all of them separated by commas for the ALTER SYSTEM command.
52+
53+
[source,conf]
54+
----
55+
shared_preload_libraries = 'liboracle_parser, ivorysql_ora, pg_stat_statements, pg_stat_monitor';
56+
----
57+
58+
Start or restart the IvorySQL instance to apply the changes.
59+
60+
[source,bash]
61+
----
62+
pg_ctl restart -D data
63+
----
64+
65+
After you have added pg_stat_monitor to the shared_preload_libraries, it starts collecting statistics data for all existing databases. To access this data, you need to create the view on every database that you wish to monitor.
66+
67+
== Create the extension view
68+
69+
Create the extension view with the user that has the privileges of a superuser or a database owner. Connect to psql as a superuser for a database and run the CREATE EXTENSION command:
70+
71+
[source,sql]
72+
----
73+
CREATE EXTENSION pg_stat_monitor;
74+
----
75+
76+
After the setup is complete, you can see the stats collected by pg_stat_monitor.
77+
78+
== Usage
79+
80+
To obtain query execution time information as an example, connect to the database and execute the following SQL：
81+
82+
[source,sql]
83+
----
84+
SELECT userid, total_exec_time, min_exec_time, max_exec_time, mean_exec_time, query FROM pg_stat_monitor;
85+
----
86+
87+
[source,text]
88+
----
89+
userid | total_exec_time | min_exec_time | max_exec_time | mean_exec_time | query
90+
--------+-----------------+---------------+---------------+----------------+----------------------------------------------------------------------------------------------
91+
10 | 1.532168 | 0.749108 | 0.78306 | 0.766084 | SELECT userid, datname, queryid, substr(query,$1, $2) AS query, calls FROM pg_stat_monitor
92+
10 | 0.755857 | 0.755857 | 0.755857 | 0.755857 | SELECT application_name, client_ip, substr(query,$1,$2) as query FROM pg_stat_monitor
93+
10 | 0 | 0 | 0 | 0 | SELECT userid, total_time, min_time, max_time, mean_time, query FROM pg_stat_monitor;
94+
10 | 0 | 0 | 0 | 0 | SELECT userid, total_exec_time, min_time, max_time, mean_time, query FROM pg_stat_monitor;
95+
(4 rows)
96+
----
97+
98+
For more information on using pg_stat_monitor, please refer to pg_stat_monitor https://docs.percona.com/pg-stat-monitor/user_guide.html[ Official documentation]

0 commit comments

Comments
 (0)