Add MCP endpoint for stats
#5341
+7,826
−73
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| #ifndef CLASS_STATS_TOOL_HANDLER_H | ||
| #define CLASS_STATS_TOOL_HANDLER_H | ||
|
|
||
| #include <map> | ||
|
|
||
| #include "MCP_Tool_Handler.h" | ||
| #include "MCP_Thread.h" | ||
|
|
||
| /** | ||
| * @brief Stats Tool Handler for /mcp/stats endpoint | ||
| * | ||
| * This handler provides tools for real-time metrics, statistics, and monitoring | ||
| * of ProxySQL internals including connection pools, query digests, errors, | ||
| * cluster status, and more. | ||
| * | ||
| * Tools provided: | ||
| * - get_health: Comprehensive health status summary | ||
| * - show_processlist: Active sessions (like MySQL SHOW PROCESSLIST) | ||
| * - show_metrics: Prometheus-compatible metrics | ||
| * - show_queries: Query digest performance statistics | ||
| * - show_connections: Backend connection pool metrics | ||
| * - show_errors: Error tracking and analysis | ||
| * - show_cluster: Cluster node health and sync status | ||
| * - list_stats: List available statistics tables | ||
| * - get_stats: Ad-hoc query any stats table | ||
| * - show_commands: Command execution statistics with latency distribution | ||
| * - show_users: User connection statistics | ||
| * - show_client_cache: Client host cache for connection throttling | ||
| * - show_gtid: GTID replication information | ||
| * - show_query_rules: Query rule hit statistics | ||
| * - show_history_connections: Historical connection trends | ||
| * - show_history_query_digest: Historical query digest snapshots | ||
| * - aggregate_metrics: Custom metric aggregations | ||
| */ | ||
wazir-ahmed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| class Stats_Tool_Handler : public MCP_Tool_Handler { | ||
| private: | ||
| MCP_Threads_Handler* mcp_handler; ///< Pointer to MCP handler | ||
| pthread_mutex_t handler_lock; ///< Mutex for thread-safe operations | ||
|
|
||
| // Tool handlers | ||
| json handle_get_health(const json& arguments); | ||
| json handle_show_processlist(const json& arguments); | ||
| json handle_show_metrics(const json& arguments); | ||
| json handle_show_queries(const json& arguments); | ||
| json handle_show_connections(const json& arguments); | ||
| json handle_show_errors(const json& arguments); | ||
| json handle_show_cluster(const json& arguments); | ||
| json handle_list_stats(const json& arguments); | ||
| json handle_get_stats(const json& arguments); | ||
| json handle_show_commands(const json& arguments); | ||
| json handle_show_users(const json& arguments); | ||
| json handle_show_client_cache(const json& arguments); | ||
| json handle_show_gtid(const json& arguments); | ||
| json handle_show_query_rules(const json& arguments); | ||
| json handle_show_history_connections(const json& arguments); | ||
| json handle_show_history_query_digest(const json& arguments); | ||
| json handle_aggregate_metrics(const json& arguments); | ||
|
|
||
| // Helper methods | ||
|
|
||
| /** | ||
| * @brief Execute a SQL query against GloAdmin->admindb | ||
| * @param sql The SQL query to execute | ||
| * @param resultset Output pointer for the result set (caller must delete) | ||
| * @param cols Output for number of columns | ||
| * @return Empty string on success, error message on failure | ||
| */ | ||
| std::string execute_admin_query(const char* sql, SQLite3_result** resultset, int* cols); | ||
|
|
||
| /** | ||
| * @brief Execute a SQL query against GloAdmin->statsdb_disk (historical data) | ||
| * @param sql The SQL query to execute | ||
| * @param resultset Output pointer for the result set (caller must delete) | ||
| * @param cols Output for number of columns | ||
| * @return Empty string on success, error message on failure | ||
| */ | ||
| std::string execute_statsdb_disk_query(const char* sql, SQLite3_result** resultset, int* cols); | ||
|
|
||
| /** | ||
| * @brief Parse key-value pairs from stats_*_global tables | ||
| * @param resultset The result set from a global stats query | ||
| * @return Map of variable name to variable value | ||
| */ | ||
| std::map<std::string, std::string> parse_global_stats(SQLite3_result* resultset); | ||
|
|
||
| /** | ||
| * @brief Validate a stats table name against a whitelist | ||
| * @param table The table name to validate | ||
| * @return true if the table name is valid | ||
| */ | ||
| static bool is_valid_stats_table(const std::string& table); | ||
|
|
||
| public: | ||
| /** | ||
| * @brief Constructor | ||
| * @param handler Pointer to MCP_Threads_Handler | ||
| */ | ||
| Stats_Tool_Handler(MCP_Threads_Handler* handler); | ||
|
|
||
| /** | ||
| * @brief Destructor | ||
| */ | ||
| ~Stats_Tool_Handler() override; | ||
|
|
||
| // MCP_Tool_Handler interface implementation | ||
| json get_tool_list() override; | ||
| json get_tool_description(const std::string& tool_name) override; | ||
| json execute_tool(const std::string& tool_name, const json& arguments) override; | ||
| int init() override; | ||
| void close() override; | ||
| std::string get_handler_name() const override { return "stats"; } | ||
| }; | ||
|
|
||
| #endif /* CLASS_STATS_TOOL_HANDLER_H */ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| #include "sqlite3db.h" | ||
| #include "MCP_Tool_Handler.h" | ||
|
|
||
| #include "../deps/json/json.hpp" | ||
| using json = nlohmann::json; | ||
| #define PROXYJSON | ||
|
|
||
| json MCP_Tool_Handler::resultset_to_json(SQLite3_result* resultset, int cols) { | ||
| json rows = json::array(); | ||
|
|
||
| if (!resultset || resultset->rows_count == 0) { | ||
| return rows; | ||
| } | ||
|
|
||
| for (const auto& row : resultset->rows) { | ||
| json obj = json::object(); | ||
| for (int i = 0; i < cols && i < (int)resultset->column_definition.size(); i++) { | ||
| const char* col_name = resultset->column_definition[i]->name; | ||
| const char* val = row->fields[i]; | ||
|
|
||
| if (!val) { | ||
| obj[col_name] = nullptr; | ||
| continue; | ||
| } | ||
|
|
||
| // Try to parse the value as a number. | ||
| // strtoll / strtod are used directly to avoid the overhead | ||
| // of a separate is_numeric() scan followed by a second parse. | ||
| char* end = nullptr; | ||
| long long ll = strtoll(val, &end, 10); | ||
| if (end != val && *end == '\0') { | ||
| obj[col_name] = ll; | ||
| } else { | ||
| // Not a plain integer; try floating-point | ||
| double d = strtod(val, &end); | ||
| if (end != val && *end == '\0') { | ||
| obj[col_name] = d; | ||
| } else { | ||
| obj[col_name] = std::string(val); | ||
| } | ||
| } | ||
|
Comment on lines
+31
to
+43
There was a problem hiding this comment. The current numeric parsing logic using A more robust approach is to first attempt parsing as char* end = nullptr;
bool parsed = false;
// Try unsigned long long for non-negative numbers, which is common for stats counters.
if (val[0] != '-') {
errno = 0;
unsigned long long ull = strtoull(val, &end, 10);
if (end != val && *end == '\0' && errno != ERANGE) {
obj[col_name] = ull;
parsed = true;
}
}
// Try long long if not parsed yet (e.g., for negative numbers).
if (!parsed) {
errno = 0;
end = nullptr;
long long ll = strtoll(val, &end, 10);
if (end != val && *end == '\0' && errno != ERANGE) {
obj[col_name] = ll;
parsed = true;
}
}
// Fallback to double if it's not an integer.
if (!parsed) {
end = nullptr;
double d = strtod(val, &end);
if (end != val && *end == '\0') {
obj[col_name] = d;
parsed = true;
}
}
// Finally, treat as a string if no numeric conversion worked.
if (!parsed) {
obj[col_name] = std::string(val);
} |
||
| } | ||
| rows.push_back(obj); | ||
| } | ||
|
|
||
| return rows; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.