mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-05 12:45:11 -05:00
293c1d6889
This PR introduces a significant update to the Toolbox configuration file format, which is one of the primary **breaking changes** required for the implementation of the Advanced Control Plane. # Summary of Changes The configuration schema has been updated to enforce resource isolation and facilitate atomic, incremental updates. * Resource Isolation: Resource definitions are now separated into individual blocks, using a distinct structure for each resource type (Source, Tool, Toolset, etc.). This improves readability, management, and auditing of configuration files. * Field Name Modification: Internal field names have been modified to align with declarative methodologies. Specifically, the configuration now separates kind (general resource type, e.g., Source) from type (specific implementation, e.g., Postgres). # User Impact Existing tools.yaml configuration files are now in an outdated format. Users must eventually update their files to the new YAML format. # Mitigation & Compatibility Backward compatibility is maintained during this transition to ensure no immediate user action is required for existing files. * Immediate Backward Compatibility: The source code includes a pre-processing layer that automatically detects outdated configuration files (v1 format) and converts them to the new v2 format under the hood. * [COMING SOON] Migration Support: The new toolbox migrate subcommand will be introduced to allow users to automatically convert their old configuration files to the latest format. # Example Example for config file v2: ``` kind: sources name: my-pg-instance type: cloud-sql-postgres project: my-project region: my-region instance: my-instance database: my_db user: my_user password: my_pass --- kind: authServices name: my-google-auth type: google clientId: testing-id --- kind: tools name: example_tool type: postgres-sql source: my-pg-instance description: some description statement: SELECT * FROM SQL_STATEMENT; parameters: - name: country type: string description: some description --- kind: tools name: example_tool_2 type: postgres-sql source: my-pg-instance description: returning the number one statement: SELECT 1; --- kind: toolsets name: example_toolset tools: - example_tool ``` --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com>
2.7 KiB
2.7 KiB
title, type, weight, description, aliases
| title | type | weight | description | aliases | |
|---|---|---|---|---|---|
| postgres-list-query-stats | docs | 1 | The "postgres-list-query-stats" tool lists query statistics from a Postgres database. |
|
About
The postgres-list-query-stats tool retrieves query statistics from the
pg_stat_statements extension in a PostgreSQL database. It provides detailed
performance metrics for executed queries. It's compatible with any of the following
sources:
postgres-list-query-stats lists detailed query statistics as JSON, ordered by
total execution time in descending order. The tool takes the following input parameters:
database_name(optional): The database name to filter query stats for. The input is used within a LIKE clause. Default:""(all databases).limit(optional): The maximum number of results to return. Default:50.
Example
kind: tools
name: list_query_stats
type: postgres-list-query-stats
source: postgres-source
description: List query statistics from pg_stat_statements, showing performance metrics for queries including execution counts, timing information, and resource usage. Results are ordered by total execution time descending.
The response is a json array with the following elements:
[
{
"datname": "database name",
"query": "the SQL query text",
"calls": "number of times the query was executed",
"total_exec_time": "total execution time in milliseconds",
"min_exec_time": "minimum execution time in milliseconds",
"max_exec_time": "maximum execution time in milliseconds",
"mean_exec_time": "mean execution time in milliseconds",
"rows": "total number of rows retrieved or affected",
"shared_blks_hit": "number of shared block cache hits",
"shared_blks_read": "number of shared block disk reads"
}
]
Notes
This tool requires the pg_stat_statements extension to be installed and enabled
on the PostgreSQL database. The pg_stat_statements extension tracks execution
statistics for all SQL statements executed by the server, which is useful for
identifying slow queries and understanding query performance patterns.
Reference
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be "postgres-list-query-stats". |
| source | string | true | Name of the source the SQL should execute on. |
| description | string | true | Description of the tool that is passed to the LLM. |