feat: add polar stat env extension

external/Makefile

@@ -14,6 +14,7 @@ SUBDIRS += pgvector
 SUBDIRS += polar_worker
 SUBDIRS += polar_tde_utils
 SUBDIRS += polar_parameter_check
+SUBDIRS += polar_stat_env
 SUBDIRS += polar_stat_sql
 SUBDIRS += polar_csn
 SUBDIRS += polar_px

external/polar_stat_env/Makefile

@@ -0,0 +1,21 @@
+# extern/polar_stat_env/Makefile
+
+MODULE_big = polar_stat_env
+OBJS = polar_stat_env.o
+
+EXTENSION = polar_stat_env
+DATA = polar_stat_env--1.0.sql
+# REGRESS = polar_stat_env
+# NO_INSTALLCHECK = 1
+POLAR_NO_EXTENSION_USER=1
+
+ifdef USE_PGXS
+PG_CONFIG = pg_config
+PGXS := $(shell $(PG_CONFIG) --pgxs)
+include $(PGXS)
+else
+subdir = external/polar_stat_env
+top_builddir = ../..
+include $(top_builddir)/src/Makefile.global
+include $(top_srcdir)/contrib/contrib-global.mk
+endif

external/polar_stat_env/polar_stat_env--1.0.sql

@@ -0,0 +1,13 @@
+-- Create customized polar stat env func
+CREATE FUNCTION polar_stat_env(
+    IN format text DEFAULT 'json'
+) RETURNS TEXT
+AS 'MODULE_PATHNAME', 'polar_stat_env'
+LANGUAGE C PARALLEL SAFE;
+
+CREATE FUNCTION polar_stat_env_no_format(
+    IN format text DEFAULT 'json'
+)
+RETURNS TEXT
+AS 'MODULE_PATHNAME', 'polar_stat_env_no_format'
+LANGUAGE C PARALLEL SAFE;

external/polar_stat_env/polar_stat_env.c

@@ -0,0 +1,288 @@
+/*-------------------------------------------------------------------------
+ *
+ * polar_stat_env.c
+ *	  Collecting environment information of PolarDB-PG.
+ *
+ * Copyright (c) 2024, Alibaba Group Holding Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * IDENTIFICATION
+ *	  external/polar_stat_env/polar_stat_env.c
+ *
+ *-------------------------------------------------------------------------
+ */
+#include "postgres.h"
+#include "funcapi.h"
+#include "utils/builtins.h"
+#include "utils/memutils.h"
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include "utils/guc.h"
+#include "commands/explain.h"
+#include "fmgr.h"
+
+#ifdef PG_MODULE_MAGIC
+PG_MODULE_MAGIC;
+#endif
+
+const char *cpu_commands[][2] =
+{
+	{"Architecture", "lscpu | grep -i architecture | awk '{print $NF}'"},
+	{"Model Name", "lscpu | grep -i 'model name\\:' | awk -F: '{gsub(/^[ \\t]+|[ \\t]+$/, \"\", $2); print $2}'"},
+	{"CPU Cores", "lscpu | grep '^CPU(s)\\:' | awk '{print $NF}'"},
+	{"CPU Thread Per Cores", "lscpu | grep Thread |awk '{print $NF}'"},
+	{"CPU Core Per Socket", "lscpu | grep Core |awk '{print $NF}'"},
+	{"NUMA Nodes", "lscpu | grep -i 'numa node(s)\\:' |awk '{print $NF}'"},
+	{"L1d cache", "lscpu | grep 'L1d cache:' |awk -F: '{gsub(/^[ \\t]+|[ \\t]+$/, \"\", $2); print $2}'"},
+	{"L1i cache", "lscpu | grep 'L1i cache:' |awk -F: '{gsub(/^[ \\t]+|[ \\t]+$/, \"\", $2); print $2}'"},
+	{"L2 cache", "lscpu | grep 'L2 cache:' |awk -F: '{gsub(/^[ \\t]+|[ \\t]+$/, \"\", $2); print $2}'"},
+	{"L3 cache", "lscpu | grep 'L3 cache:' |awk -F: '{gsub(/^[ \\t]+|[ \\t]+$/, \"\", $2); print $2}'"}
+};
+
+const char *mem_commands[][2] =
+{
+	{"Memory Total (GB)",
+	"cat /proc/meminfo | grep MemTotal | awk '{print int($2 / 1024 / 1024)}'"},
+	{"HugePage Size (MB)",
+	"expr $(cat /proc/meminfo  | grep Hugepagesize | awk '{print $2}') / 1024"},
+	{"HugePage Total Size (GB)",
+	"expr $(awk '/Hugepagesize/ {print $2}' /proc/meminfo) \\* $(awk '/HugePages_Total/ {print $2}' /proc/meminfo) / 1024 / 1024"}
+};
+
+const char *os_commands[][2] =
+{
+	{"OS", "uname -r"},
+	{"Swappiness(1-100)", "cat /proc/sys/vm/swappiness"},
+	{"Vfs Cache Pressure(0-1000)", "cat /proc/sys/vm/vfs_cache_pressure"},
+	{"Min Free KBytes(KB)", "cat /proc/sys/vm/min_free_kbytes"}
+};
+
+#define NUM_OF_CPU_COMMANDS (sizeof(cpu_commands) / sizeof(cpu_commands[0]))
+#define NUM_OF_MEM_COMMANDS (sizeof(mem_commands) / sizeof(mem_commands[0]))
+#define NUM_OF_OS_COMMANDS (sizeof(os_commands) / sizeof(os_commands[0]))
+
+static void
+remove_newlines(char *str)
+{
+	char	   *read = str;
+	char	   *write = str;
+
+	while (*read)
+	{
+		/* Copy only if the character is not a newline */
+		if (*read != '\n')
+		{
+			*write++ = *read;
+		}
+		read++;
+	}
+	*write = '\0';				/* Null - terminate the string */
+}
+
+static bool
+exec_collect_command(const char *command, StringInfoData *result)
+{
+	FILE	   *fp;
+	char		buffer[128];
+	size_t		bytes_read;
+
+	fp = popen(command, "r");
+	if (fp == NULL)
+	{
+		elog(WARNING, "Failed to run command: %s", command);
+		return false;
+	}
+
+	resetStringInfo(result);
+
+	while ((bytes_read = fread(buffer, 1, sizeof(buffer) - 1, fp)) > 0)
+	{
+		buffer[bytes_read] = '\0';
+		appendStringInfoString(result, buffer);
+	}
+	pclose(fp);
+
+	return true;
+}
+
+static void
+polar_collect_cpu(ExplainState *es)
+{
+	bool		success = false;
+	StringInfoData cur_data;
+
+	initStringInfo(&cur_data);
+	ExplainOpenGroup("CPU", "CPU", true, es);
+	for (int i = 0; i < NUM_OF_CPU_COMMANDS; i++)
+	{
+		pg_usleep(1000);
+		resetStringInfo(&cur_data);
+		success = exec_collect_command(cpu_commands[i][1], &cur_data);
+		if (success)
+		{
+			if (cur_data.len > 1 && cur_data.data[cur_data.len - 1] == '\n')
+			{
+				cur_data.data[cur_data.len - 1] = '\0';
+			}
+
+			/* Add property into text */
+			ExplainPropertyText(cpu_commands[i][0], cur_data.data, es);
+		}
+	}
+
+	ExplainCloseGroup("CPU", "CPU", true, es);
+	pfree(cur_data.data);
+	return;
+}
+
+static void
+polar_collect_mem(ExplainState *es)
+{
+	bool		success = false;
+	StringInfoData cur_data;
+
+	initStringInfo(&cur_data);
+	ExplainOpenGroup("Memory", "Memory", true, es);
+	for (int i = 0; i < NUM_OF_MEM_COMMANDS; i++)
+	{
+		pg_usleep(1000);
+		resetStringInfo(&cur_data);
+		success = exec_collect_command(mem_commands[i][1], &cur_data);
+		if (success)
+		{
+			if (cur_data.len > 1 && cur_data.data[cur_data.len - 1] == '\n')
+			{
+				cur_data.data[cur_data.len - 1] = '\0';
+			}
+
+			/* Add property into text */
+			ExplainPropertyText(mem_commands[i][0], cur_data.data, es);
+		}
+	}
+
+	ExplainCloseGroup("Memory", "Memory", true, es);
+	pfree(cur_data.data);
+	return;
+}
+
+static void
+polar_collect_os(ExplainState *es)
+{
+	bool		success = false;
+	StringInfoData cur_data;
+
+	initStringInfo(&cur_data);
+	ExplainOpenGroup("OS Params", "OS Params", true, es);
+	for (int i = 0; i < NUM_OF_OS_COMMANDS; i++)
+	{
+		pg_usleep(1000);
+		resetStringInfo(&cur_data);
+		success = exec_collect_command(os_commands[i][1], &cur_data);
+		if (success)
+		{
+			if (cur_data.len > 1 && cur_data.data[cur_data.len - 1] == '\n')
+			{
+				cur_data.data[cur_data.len - 1] = '\0';
+			}
+
+			/* Add property into text */
+			ExplainPropertyText(os_commands[i][0], cur_data.data, es);
+		}
+	}
+
+	ExplainCloseGroup("OS Params", "OS Params", true, es);
+	pfree(cur_data.data);
+	return;
+}
+
+static void
+polar_collect_env(ExplainState *es)
+{
+	ExplainBeginOutput(es);
+
+	/* Collect CPU info */
+	polar_collect_cpu(es);
+	/* Collect memory info */
+	polar_collect_mem(es);
+	/* Collect OS info */
+	polar_collect_os(es);
+
+	ExplainEndOutput(es);
+
+	/* Remove last line break */
+	if (es->str->len > 0 && es->str->data[es->str->len - 1] == '\n')
+		es->str->data[--es->str->len] = '\0';
+
+	/* Fix JSON to output an object */
+	if (es->format == EXPLAIN_FORMAT_JSON)
+	{
+		es->str->data[0] = '{';
+		es->str->data[es->str->len - 1] = '}';
+	}
+}
+
+static text *
+stat_env(FunctionCallInfo fcinfo, bool need_newline)
+{
+	text	   *format_txt = PG_GETARG_TEXT_PP(0);
+	char	   *format = text_to_cstring(format_txt);
+	text	   *result_text;
+	ExplainState *es = NewExplainState();
+
+	if (strcmp(format, "text") == 0)
+		es->format = EXPLAIN_FORMAT_TEXT;
+	else if (strcmp(format, "xml") == 0)
+		es->format = EXPLAIN_FORMAT_XML;
+	else if (strcmp(format, "json") == 0)
+		es->format = EXPLAIN_FORMAT_JSON;
+	else if (strcmp(format, "yaml") == 0)
+		es->format = EXPLAIN_FORMAT_YAML;
+	else
+		ereport(ERROR,
+				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
+				 errmsg("unrecognized value for output format: \"%s\"", format)));
+	pfree(format);
+
+	polar_collect_env(es);
+
+	if (!need_newline && es && es->str)
+		remove_newlines(es->str->data);
+
+	result_text = cstring_to_text_with_len(es->str->data, es->str->len);
+
+	pfree(es->str->data);
+	pfree(es);
+
+	return result_text;
+}
+
+PG_FUNCTION_INFO_V1(polar_stat_env);
+Datum
+polar_stat_env(PG_FUNCTION_ARGS)
+{
+	PG_RETURN_TEXT_P(stat_env(fcinfo, true));
+}
+
+/*
+ * Usage:
+ * 1. COPY (SELECT polar_stat_env_no_format('json')) TO '/path/to/output_file.json';
+ * 2. cat /path/to/output_file.json | jq .
+ */
+PG_FUNCTION_INFO_V1(polar_stat_env_no_format);
+Datum
+polar_stat_env_no_format(PG_FUNCTION_ARGS)
+{
+	PG_RETURN_TEXT_P(stat_env(fcinfo, false));
+}

external/polar_stat_env/polar_stat_env.control

@@ -0,0 +1,5 @@
+# polar_stat_env extension
+comment = 'env stat functions for PolarDB'
+default_version = '1.0'
+module_pathname = '$libdir/polar_stat_env'
+relocatable = true