Skip to content

Commit

Permalink
PG-1245 Fix comments and refactoring
Browse files Browse the repository at this point in the history
  • Loading branch information
@artemgavrilov
artemgavrilov committed Dec 25, 2024
1 parent dc62b46 commit 8fb65f1
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 64 deletions.
87 changes: 40 additions & 47 deletions percona_pg_telemetry.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -562,7 +562,7 @@ setup_background_worker(const char *bgw_function_name, const char *bgw_name, con
}

/*
* Returns string contain server uptime in seconds
* Returns server uptime in seconds.
*/
static long
server_uptime(void)
Expand All @@ -575,13 +575,11 @@ server_uptime(void)
return secs;
}


/*
* Getting pg_settings values:
* -> name, units, setting, boot_val, and reset_val
*/

#define PT_SETTINGS_COL_COUNT 5

static void
write_pg_settings(void)
{
Expand All @@ -595,11 +593,11 @@ write_pg_settings(void)


/* Open file in append mode. */
fp = json_file_open(ptss->dbtemp_filepath, "a+");
fp = open_telemetry_file(ptss->dbtemp_filepath, "a+");

/* Construct and initiate the active extensions array block. */
/* Start settings object */
construct_json_block(buf, buf_size, "settings", NULL, PT_JSON_NAMED_OBJECT_START, &ptss->json_file_indent);
write_json_to_file(fp, buf);
write_telemetry_file(fp, buf);

SetCurrentStatementStartTimestamp();
StartTransactionCommand();
Expand All @@ -617,7 +615,7 @@ write_pg_settings(void)
if (spi_result != SPI_OK_SELECT)
{
SPI_finish();
ereport(ERROR, (errmsg("Query failed execution.")));
ereport(ERROR, (errmsg("Failed to execute query")));
}

/* Process the result */
Expand All @@ -629,13 +627,14 @@ write_pg_settings(void)
{
char *null_value = "NULL";

/* Construct and initiate the active extensions array block. */
/* Get setting name, we don't expect empty value here */
char *name = SPI_getvalue(tuptable->vals[row_count], tuptable->tupdesc, 1);

/* Start particular setting object */
construct_json_block(buf, buf_size, name, NULL, PT_JSON_NAMED_OBJECT_START, &ptss->json_file_indent);
write_json_to_file(fp, buf);
write_telemetry_file(fp, buf);

/* Process the tuple as needed */
/* Get the rest of the values */
for (int col_count = 2; col_count <= tuptable->tupdesc->natts; col_count++)
{
char *str = SPI_getvalue(tuptable->vals[row_count], tuptable->tupdesc, col_count);
Expand All @@ -646,25 +645,21 @@ write_pg_settings(void)

construct_json_block(buf, buf_size, NameStr(tuptable->tupdesc->attrs[col_count - 1].attname),
value, flags, &ptss->json_file_indent);
write_json_to_file(fp, buf);
write_telemetry_file(fp, buf);
}

/* Close the extension block */
/* Close setting object */
flags = (row_count == (SPI_processed - 1)) ? (PT_JSON_OBJECT_END | PT_JSON_LAST_ELEMENT) : PT_JSON_OBJECT_END;
construct_json_block(buf, sizeof(buf), NULL, NULL, flags, &ptss->json_file_indent);

/* Write both to file. */
write_json_to_file(fp, buf);
write_telemetry_file(fp, buf);
}
}

/* Close the array */
/* Close settings object */
construct_json_block(buf, sizeof(buf), NULL, NULL, PT_JSON_OBJECT_END, &ptss->json_file_indent);
write_telemetry_file(fp, buf);

/* Write both to file. */
write_json_to_file(fp, buf);

/* Clean up */
/* Close the file */
fclose(fp);

/* Disconnect from SPI */
Expand All @@ -674,8 +669,6 @@ write_pg_settings(void)
CommitTransactionCommand();
}

#undef PT_SETTINGS_COL_COUNT

/*
* Return a list of databases from the pg_database catalog
*/
Expand Down Expand Up @@ -803,56 +796,56 @@ write_database_info(PTDatabaseInfo *dbinfo, List *extlist)
int flags;

/* Open file in append mode. */
fp = json_file_open(ptss->dbtemp_filepath, "a+");
fp = open_telemetry_file(ptss->dbtemp_filepath, "a+");

if (ptss->first_db_entry)
{
/* Start databases block. */
/* Start databases object */
construct_json_block(buf, buf_size, "databases", NULL, PT_JSON_NAMED_OBJECT_START, &ptss->json_file_indent);
write_json_to_file(fp, buf);
write_telemetry_file(fp, buf);
}

/* Start database block where database OID is key. */
/* Start database object where database OID is key */
snprintf(str, sizeof(str), "%u", dbinfo->datid);
construct_json_block(buf, buf_size, str, NULL, PT_JSON_NAMED_OBJECT_START, &ptss->json_file_indent);
write_json_to_file(fp, buf);
write_telemetry_file(fp, buf);

/* Construct and write the database size. */
/* Add database size */
snprintf(str, sizeof(str), "%lu", dbinfo->datsize);
construct_json_block(buf, buf_size, "size", str, PT_JSON_KEY_VALUE, &ptss->json_file_indent);
write_json_to_file(fp, buf);
write_telemetry_file(fp, buf);

/* Start active extensions array block. */
/* Start active extensions array */
construct_json_block(buf, buf_size, "active_extensions", NULL, PT_JSON_NAMED_ARRAY_START, &ptss->json_file_indent);
write_json_to_file(fp, buf);
write_telemetry_file(fp, buf);

/* Iterate through all extensions and those to the array. */
/* Add extensions names */
foreach(lc, extlist)
{
PTExtensionInfo *extinfo = lfirst(lc);

flags = (list_tail(extlist) == lc) ? (PT_JSON_VALUE | PT_JSON_LAST_ELEMENT) : PT_JSON_VALUE;
construct_json_block(buf, buf_size, NULL, extinfo->extname, flags, &ptss->json_file_indent);
write_json_to_file(fp, buf);
write_telemetry_file(fp, buf);
}

/* Close active extensions array */
construct_json_block(buf, buf_size, NULL, NULL, PT_JSON_ARRAY_END | PT_JSON_LAST_ELEMENT, &ptss->json_file_indent);
write_json_to_file(fp, buf);
write_telemetry_file(fp, buf);

/* Close the database block */
flags = (ptss->last_db_entry) ? (PT_JSON_OBJECT_END | PT_JSON_LAST_ELEMENT) : PT_JSON_OBJECT_END;
construct_json_block(buf, buf_size, NULL, NULL, flags, &ptss->json_file_indent);
write_json_to_file(fp, buf);
write_telemetry_file(fp, buf);

if (ptss->last_db_entry)
{
/* Close databases array */
/* Close databases object */
construct_json_block(buf, buf_size, NULL, NULL, PT_JSON_OBJECT_END | PT_JSON_LAST_ELEMENT, &ptss->json_file_indent);
write_json_to_file(fp, buf);
write_telemetry_file(fp, buf);
}

/* Clean up */
/* Close the file */
fclose(fp);

return true;
Expand Down Expand Up @@ -947,29 +940,29 @@ percona_pg_telemetry_main(Datum main_arg)
ptss->write_in_progress = true;

/* Open file for writing. */
fp = json_file_open(ptss->dbtemp_filepath, "w");
fp = open_telemetry_file(ptss->dbtemp_filepath, "w");

construct_json_block(buf, buf_size, NULL, NULL, PT_JSON_OBJECT_START, &ptss->json_file_indent);
write_json_to_file(fp, buf);
write_telemetry_file(fp, buf);

/* Construct and write the database size block. */
pg_snprintf(str, sizeof(str), "%lu", GetSystemIdentifier());
construct_json_block(buf, buf_size, "db_instance_id", str, PT_JSON_KEY_VALUE, &ptss->json_file_indent);
write_json_to_file(fp, buf);
write_telemetry_file(fp, buf);

/* Construct and initiate the active extensions array block. */
construct_json_block(buf, buf_size, "pillar_version", PG_VERSION, PT_JSON_KEY_VALUE, &ptss->json_file_indent);
write_json_to_file(fp, buf);
write_telemetry_file(fp, buf);

/* Construct and initiate the active extensions array block. */
pg_snprintf(str, sizeof(str), "%ld", server_uptime());
construct_json_block(buf, buf_size, "uptime", str, PT_JSON_KEY_VALUE, &ptss->json_file_indent);
write_json_to_file(fp, buf);
write_telemetry_file(fp, buf);

/* Construct and initiate the active extensions array block. */
pg_snprintf(temp_buff, sizeof(temp_buff), "%d", list_length(dblist));
construct_json_block(buf, buf_size, "databases_count", temp_buff, PT_JSON_KEY_VALUE, &ptss->json_file_indent);
write_json_to_file(fp, buf);
write_telemetry_file(fp, buf);

/* Let's close the file now so that processes may add their stuff. */
fclose(fp);
Expand Down Expand Up @@ -1006,9 +999,9 @@ percona_pg_telemetry_main(Datum main_arg)
Assert(ptss->write_in_progress == true);

/* Open file, writing the closing bracket and close it. */
fp = json_file_open(ptss->dbtemp_filepath, "a+");
fp = open_telemetry_file(ptss->dbtemp_filepath, "a+");
construct_json_block(buf, buf_size, NULL, NULL, PT_JSON_OBJECT_END | PT_JSON_LAST_ELEMENT, &ptss->json_file_indent);
write_json_to_file(fp, buf);
write_telemetry_file(fp, buf);
fclose(fp);

/* Generate and save the filename */
Expand Down
23 changes: 11 additions & 12 deletions pt_json.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,9 @@ json_escape_str(char *str)
}

/*
* Construct a JSON block for writing.
*
* NOTE: We are not escape any quote characters in key or value strings, as
* we don't expect to encounter that in extension names.
* Construct a JSON block for writing. The function created json segment based
* on flags argument and provided key and value. json_file_indent is used
* to keep track of the indentation level. Result is written to the provided buffer.
*/
char *
construct_json_block(char *buf, size_t buf_sz, char *key, char *raw_value, int flags, int *json_file_indent)
Expand Down Expand Up @@ -136,36 +135,36 @@ construct_json_block(char *buf, size_t buf_sz, char *key, char *raw_value, int f
}

/*
* Open a file in the given mode.
* Open telemetry file in the given mode.
*/
FILE *
json_file_open(char *pathname, char *mode)
open_telemetry_file(char *filename, char *mode)
{
FILE *fp;

fp = fopen(pathname, mode);
fp = fopen(filename, mode);
if (fp == NULL)
{
ereport(LOG,
(errcode_for_file_access(),
errmsg("Could not open file %s for writing.", pathname)));
errmsg("Could not open file %s for writing.", filename)));
PT_WORKER_EXIT(PT_FILE_ERROR);
}

return fp;
}

/*
* Write JSON to file.
* Write data to telemetry file.
*/
void
write_json_to_file(FILE *fp, char *json_str)
write_telemetry_file(FILE *fp, char *data)
{
int len;
int bytes_written;

len = strlen(json_str);
bytes_written = fwrite(json_str, 1, len, fp);
len = strlen(data);
bytes_written = fwrite(data, 1, len, fp);

if (len != bytes_written)
{
Expand Down
8 changes: 3 additions & 5 deletions pt_json.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,8 @@
#define PT_JSON_NAMED_ARRAY_START (PT_JSON_KEY | PT_JSON_ARRAY_START)

/* JSON functions */
bool json_state_init(void);
bool json_state_validate(void);
char *construct_json_block(char *msg_block, size_t msg_block_sz, char *key, char *raw_value, int flags, int *json_file_indent);
FILE *json_file_open(char *pathname, char *mode);
void write_json_to_file(FILE *fp, char *json_str);
char *construct_json_block(char *buf, size_t buf_size, char *key, char *raw_value, int flags, int *json_file_indent);
FILE *open_telemetry_file(char *filename, char *mode);
void write_telemetry_file(FILE *fp, char *data);

#endif /* __PG_PT_JSON_H__ */

0 comments on commit 8fb65f1

Please sign in to comment.