diff --git a/docs/.vuepress/configs/navbar/en.ts b/docs/.vuepress/configs/navbar/en.ts index 7cb3aebdfa1..990a928d18f 100644 --- a/docs/.vuepress/configs/navbar/en.ts +++ b/docs/.vuepress/configs/navbar/en.ts @@ -84,32 +84,18 @@ export const en: NavbarConfig = [ text: "Dev", link: "/development/", children: [ - { - text: "Development on Docker", - link: "/development/dev-on-docker.html", - }, - { - text: "Customize Development Environment", - link: "/development/customize-dev-env.html", - }, + "/development/dev-on-docker.html", + "/development/customize-dev-env.html", ], }, { text: "Contributing", link: "/contributing/", children: [ - { - text: "Contributing Docs", - link: "/contributing/contributing-polardb-docs.html", - }, - { - text: "Contributing Code", - link: "/contributing/contributing-polardb-kernel.html", - }, - { - text: "Coding Style", - link: "/contributing/coding-style.html", - }, + "/contributing/contributing-polardb-docs.html", + "/contributing/contributing-polardb-kernel.html", + "/contributing/coding-style.html", + "/contributing/trouble-issuing.html", ], }, ]; diff --git a/docs/.vuepress/configs/navbar/zh.ts b/docs/.vuepress/configs/navbar/zh.ts index 922bb422568..da8f85c0ece 100644 --- a/docs/.vuepress/configs/navbar/zh.ts +++ b/docs/.vuepress/configs/navbar/zh.ts @@ -121,18 +121,10 @@ export const zh: NavbarConfig = [ text: "参与社区", link: "/zh/contributing/", children: [ - { - text: "贡献文档", - link: "/zh/contributing/contributing-polardb-docs.html", - }, - { - text: "贡献代码", - link: "/zh/contributing/contributing-polardb-kernel.html", - }, - { - text: "编码风格", - link: "/zh/contributing/coding-style.html", - }, + "/zh/contributing/contributing-polardb-docs.html", + "/zh/contributing/contributing-polardb-kernel.html", + "/zh/contributing/coding-style.html", + "/zh/contributing/trouble-issuing.md", ], }, ]; diff --git a/docs/.vuepress/configs/sidebar/en.ts b/docs/.vuepress/configs/sidebar/en.ts index 3fbecf8463b..d19810b4dcd 100644 --- a/docs/.vuepress/configs/sidebar/en.ts +++ b/docs/.vuepress/configs/sidebar/en.ts @@ -102,6 +102,7 @@ export const en: SidebarConfig = { "/contributing/contributing-polardb-kernel.md", "/contributing/contributing-polardb-docs.md", "/contributing/coding-style.md", + "/contributing/trouble-issuing.md", ], }, ], diff --git a/docs/.vuepress/configs/sidebar/zh.ts b/docs/.vuepress/configs/sidebar/zh.ts index 9edd2610577..a4b286f0514 100644 --- a/docs/.vuepress/configs/sidebar/zh.ts +++ b/docs/.vuepress/configs/sidebar/zh.ts @@ -175,6 +175,7 @@ export const zh: SidebarConfig = { "/zh/contributing/contributing-polardb-kernel.md", "/zh/contributing/contributing-polardb-docs.md", "/zh/contributing/coding-style.md", + "/zh/contributing/trouble-issuing.md", ], }, ], diff --git a/docs/contributing/trouble-issuing.md b/docs/contributing/trouble-issuing.md new file mode 100644 index 00000000000..8702de87384 --- /dev/null +++ b/docs/contributing/trouble-issuing.md @@ -0,0 +1,38 @@ +# 问题报告 + +如果在运行 PolarDB for PostgreSQL 的过程中出现问题，请提供数据库的日志与机器的配置信息以方便定位问题。 + +通过 `polar_stat_env` 插件可以轻松获取数据库所在主机的硬件配置： + +```sql:no-line-numbers +=> CREATE EXTENSION polar_stat_env; +=> SELECT polar_stat_env(); + polar_stat_env +-------------------------------------------------------------------- + { + + "CPU": { + + "Architecture": "x86_64", + + "Model Name": "Intel(R) Xeon(R) Platinum 8369B CPU @ 2.70GHz",+ + "CPU Cores": "8", + + "CPU Thread Per Cores": "2", + + "CPU Core Per Socket": "4", + + "NUMA Nodes": "1", + + "L1d cache": "192 KiB (4 instances)", + + "L1i cache": "128 KiB (4 instances)", + + "L2 cache": "5 MiB (4 instances)", + + "L3 cache": "48 MiB (1 instance)" + + }, + + "Memory": { + + "Memory Total (GB)": "14", + + "HugePage Size (MB)": "2", + + "HugePage Total Size (GB)": "0" + + }, + + "OS Params": { + + "OS": "5.10.134-16.1.al8.x86_64", + + "Swappiness(1-100)": "0", + + "Vfs Cache Pressure(0-1000)": "100", + + "Min Free KBytes(KB)": "67584" + + } + + } +(1 row) +``` diff --git a/docs/zh/contributing/trouble-issuing.md b/docs/zh/contributing/trouble-issuing.md new file mode 100644 index 00000000000..8702de87384 --- /dev/null +++ b/docs/zh/contributing/trouble-issuing.md @@ -0,0 +1,38 @@ +# 问题报告 + +如果在运行 PolarDB for PostgreSQL 的过程中出现问题，请提供数据库的日志与机器的配置信息以方便定位问题。 + +通过 `polar_stat_env` 插件可以轻松获取数据库所在主机的硬件配置： + +```sql:no-line-numbers +=> CREATE EXTENSION polar_stat_env; +=> SELECT polar_stat_env(); + polar_stat_env +-------------------------------------------------------------------- + { + + "CPU": { + + "Architecture": "x86_64", + + "Model Name": "Intel(R) Xeon(R) Platinum 8369B CPU @ 2.70GHz",+ + "CPU Cores": "8", + + "CPU Thread Per Cores": "2", + + "CPU Core Per Socket": "4", + + "NUMA Nodes": "1", + + "L1d cache": "192 KiB (4 instances)", + + "L1i cache": "128 KiB (4 instances)", + + "L2 cache": "5 MiB (4 instances)", + + "L3 cache": "48 MiB (1 instance)" + + }, + + "Memory": { + + "Memory Total (GB)": "14", + + "HugePage Size (MB)": "2", + + "HugePage Total Size (GB)": "0" + + }, + + "OS Params": { + + "OS": "5.10.134-16.1.al8.x86_64", + + "Swappiness(1-100)": "0", + + "Vfs Cache Pressure(0-1000)": "100", + + "Min Free KBytes(KB)": "67584" + + } + + } +(1 row) +```