Back to Details

alloydb-postgres-monitor

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Usage

使用方法

All scripts can be executed using Node.js. Replace 
<param_name>
and 
<param_value>
with actual values.
Bash: 
node <skill_dir>/scripts/<script_name>.js '{"<param_name>": "<param_value>"}'
PowerShell: 
node <skill_dir>/scripts/<script_name>.js '{\"<param_name>\": \"<param_value>\"}'
Note: The scripts automatically load the environment variables from various .env files. Do not ask the user to set vars unless skill executions fails due to env var absence.
所有脚本均可通过Node.js执行。将
<param_name>
和
<param_value>
替换为实际值。
Bash： 
node <skill_dir>/scripts/<script_name>.js '{"<param_name>": "<param_value>"}'
PowerShell： 
node <skill_dir>/scripts/<script_name>.js '{\"<param_name>\": \"<param_value>\"}'
注意：脚本会自动从各种.env文件加载环境变量。除非因缺少环境变量导致技能执行失败，否则不要要求用户设置变量。

Scripts

脚本

get_query_metrics

get_query_metrics

Fetches query level cloudmonitoring data (timeseries metrics) for queries running in an AlloyDB instance. To use this tool, you must provide the Google Cloud 
projectId
and a PromQL 
query
.
Generate the PromQL 
query
for AlloyDB query metrics using the provided metrics and rules. Get labels like 
cluster_id
, 
instance_id
, and 
query_hash
from the user's intent. If 
query_hash
is provided, use the per-query metrics.
Defaults:
  1. Interval: Use a default interval of 
    5m
    for 
    _over_time
    aggregation functions unless a different window is specified by the user.
PromQL Query Examples:
  1. Basic Time Series: 
    avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance"}[5m])
  2. Top K: 
    topk(30, avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance"}[5m]))
  3. Mean: 
    avg(avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="my-instance","cluster_id"="my-cluster"}[5m]))
  4. Minimum: 
    min(min_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance","cluster_id"="alloydb-cluster"}[5m]))
  5. Maximum: 
    max(max_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance","cluster_id"="alloydb-cluster"}[5m]))
  6. Sum: 
    sum(avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance","cluster_id"="alloydb-cluster"}[5m]))
  7. Count streams: 
    count(avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance","cluster_id"="alloydb-cluster"}[5m]))
  8. Percentile with groupby on instanceid, clusterid: 
    quantile by ("instance_id","cluster_id")(0.99,avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","cluster_id"="my-cluster","instance_id"="my-instance"}[5m]))
Available Metrics List: metricname. description. monitored resource. labels. aggregate is the aggregated values for all query stats, Use aggregate metrics if query id is not provided. For perquery metrics do not fetch querystring unless specified by user specifically. Have the aggregation on query hash to avoid fetching the querystring. Do not use latency metrics for anything.
  1. alloydb.googleapis.com/database/postgresql/insights/aggregate/latencies
    : Aggregated query latency distribution. 
    alloydb.googleapis.com/Database
    . 
    user
    , 
    client_addr
    .
  2. alloydb.googleapis.com/database/postgresql/insights/aggregate/execution_time
    : Accumulated aggregated query execution time since the last sample. 
    alloydb.googleapis.com/Database
    . 
    user
    , 
    client_addr
    .
  3. alloydb.googleapis.com/database/postgresql/insights/aggregate/io_time
    : Accumulated aggregated IO time since the last sample. 
    alloydb.googleapis.com/Database
    . 
    user
    , 
    client_addr
    , 
    io_type
    .
  4. alloydb.googleapis.com/database/postgresql/insights/aggregate/lock_time
    : Accumulated aggregated lock wait time since the last sample. 
    alloydb.googleapis.com/Database
    . 
    user
    , 
    client_addr
    , 
    lock_type
    .
  5. alloydb.googleapis.com/database/postgresql/insights/aggregate/row_count
    : Aggregated number of retrieved or affected rows since the last sample. 
    alloydb.googleapis.com/Database
    . 
    user
    , 
    client_addr
    .
  6. alloydb.googleapis.com/database/postgresql/insights/aggregate/shared_blk_access_count
    : Aggregated shared blocks accessed by statement execution. 
    alloydb.googleapis.com/Database
    . 
    user
    , 
    client_addr
    , 
    access_type
    .
  7. alloydb.googleapis.com/database/postgresql/insights/perquery/latencies
    : Per query latency distribution. 
    alloydb.googleapis.com/Database
    . 
    user
    , 
    client_addr
    , 
    querystring
    , 
    query_hash
    .
  8. alloydb.googleapis.com/database/postgresql/insights/perquery/execution_time
    : Accumulated execution times per user per database per query. 
    alloydb.googleapis.com/Database
    . 
    user
    , 
    client_addr
    , 
    querystring
    , 
    query_hash
    .
  9. alloydb.googleapis.com/database/postgresql/insights/perquery/io_time
    : Accumulated IO time since the last sample per query. 
    alloydb.googleapis.com/Database
    . 
    user
    , 
    client_addr
    , 
    io_type
    , 
    querystring
    , 
    query_hash
    .
  10. alloydb.googleapis.com/database/postgresql/insights/perquery/lock_time
    : Accumulated lock wait time since the last sample per query. 
    alloydb.googleapis.com/Database
    . 
    user
    , 
    client_addr
    , 
    lock_type
    , 
    querystring
    , 
    query_hash
    .
  11. alloydb.googleapis.com/database/postgresql/insights/perquery/row_count
    : The number of retrieved or affected rows since the last sample per query. 
    alloydb.googleapis.com/Database
    . 
    user
    , 
    client_addr
    , 
    querystring
    , 
    query_hash
    .
  12. alloydb.googleapis.com/database/postgresql/insights/perquery/shared_blk_access_count
    : Shared blocks accessed by statement execution per query. 
    alloydb.googleapis.com/Database
    . 
    user
    , 
    client_addr
    , 
    access_type
    , 
    querystring
    , 
    query_hash
    .
  13. alloydb.googleapis.com/database/postgresql/insights/pertag/latencies
    : Query latency distribution. 
    alloydb.googleapis.com/Database
    . 
    user
    , 
    client_addr
    , 
    action
    , 
    application
    , 
    controller
    , 
    db_driver
    , 
    framework
    , 
    route
    , 
    tag_hash
    .
  14. alloydb.googleapis.com/database/postgresql/insights/pertag/execution_time
    : Accumulated execution times since the last sample. 
    alloydb.googleapis.com/Database
    . 
    user
    , 
    client_addr
    , 
    action
    , 
    application
    , 
    controller
    , 
    db_driver
    , 
    framework
    , 
    route
    , 
    tag_hash
    .
  15. alloydb.googleapis.com/database/postgresql/insights/pertag/io_time
    : Accumulated IO time since the last sample per tag. 
    alloydb.googleapis.com/Database
    . 
    user
    , 
    client_addr
    , 
    action
    , 
    application
    , 
    controller
    , 
    db_driver
    , 
    framework
    , 
    route
    , 
    io_type
    , 
    tag_hash
    .
  16. alloydb.googleapis.com/database/postgresql/insights/pertag/lock_time
    : Accumulated lock wait time since the last sample per tag. 
    alloydb.googleapis.com/Database
    . 
    user
    , 
    client_addr
    , 
    action
    , 
    application
    , 
    controller
    , 
    db_driver
    , 
    framework
    , 
    route
    , 
    lock_type
    , 
    tag_hash
    .
  17. alloydb.googleapis.com/database/postgresql/insights/pertag/shared_blk_access_count
    : Shared blocks accessed by statement execution per tag. 
    alloydb.googleapis.com/Database
    . 
    user
    , 
    client_addr
    , 
    action
    , 
    application
    , 
    controller
    , 
    db_driver
    , 
    framework
    , 
    route
    , 
    access_type
    , 
    tag_hash
    .
  18. alloydb.googleapis.com/database/postgresql/insights/pertag/row_count
    : The number of retrieved or affected rows since the last sample per tag. 
    alloydb.googleapis.com/Database
    . 
    user
    , 
    client_addr
    , 
    action
    , 
    application
    , 
    controller
    , 
    db_driver
    , 
    framework
    , 
    route
    , 
    tag_hash
    .
获取AlloyDB实例中运行的查询的查询级云监控数据（时间序列指标）。 使用此工具时，你必须提供Google Cloud的
projectId
和PromQL
query
。
使用提供的指标和规则生成AlloyDB查询指标的PromQL
query
。从用户的需求中获取
cluster_id
、
instance_id
和
query_hash
等标签。如果提供了
query_hash
，则使用单查询指标。
默认设置：
  1. 时间间隔：对于
    _over_time
    聚合函数，默认使用
    5m
    的时间间隔，除非用户指定了不同的窗口。
PromQL查询示例：
  1. 基础时间序列：
    avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance"}[5m])
  2. Top K：
    topk(30, avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance"}[5m]))
  3. 平均值：
    avg(avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="my-instance","cluster_id"="my-cluster"}[5m]))
  4. 最小值：
    min(min_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance","cluster_id"="alloydb-cluster"}[5m]))
  5. 最大值：
    max(max_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance","cluster_id"="alloydb-cluster"}[5m]))
  6. 求和：
    sum(avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance","cluster_id"="alloydb-cluster"}[5m]))
  7. 流计数：
    count(avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance","cluster_id"="alloydb-cluster"}[5m]))
  8. 按实例ID、集群ID分组的百分位数：
    quantile by ("instance_id","cluster_id")(0.99,avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","cluster_id"="my-cluster","instance_id"="my-instance"}[5m]))
可用指标列表：指标名称、描述、监控资源、标签。aggregate是所有查询统计的聚合值，如果未提供查询ID，请使用聚合指标。对于单查询指标，除非用户特别指定，否则不要获取querystring。基于query_hash进行聚合，避免获取querystring。不要将延迟指标用于任何场景。
  1. alloydb.googleapis.com/database/postgresql/insights/aggregate/latencies
    ：聚合查询延迟分布。
    alloydb.googleapis.com/Database
    。
    user
    、
    client_addr
    。
  2. alloydb.googleapis.com/database/postgresql/insights/aggregate/execution_time
    ：自上次采样以来的累计聚合查询执行时间。
    alloydb.googleapis.com/Database
    。
    user
    、
    client_addr
    。
  3. alloydb.googleapis.com/database/postgresql/insights/aggregate/io_time
    ：自上次采样以来的累计聚合IO时间。
    alloydb.googleapis.com/Database
    。
    user
    、
    client_addr
    、
    io_type
    。
  4. alloydb.googleapis.com/database/postgresql/insights/aggregate/lock_time
    ：自上次采样以来的累计聚合锁等待时间。
    alloydb.googleapis.com/Database
    。
    user
    、
    client_addr
    、
    lock_type
    。
  5. alloydb.googleapis.com/database/postgresql/insights/aggregate/row_count
    ：自上次采样以来检索或影响的聚合行数。
    alloydb.googleapis.com/Database
    。
    user
    、
    client_addr
    。
  6. alloydb.googleapis.com/database/postgresql/insights/aggregate/shared_blk_access_count
    ：语句执行访问的聚合共享块数。
    alloydb.googleapis.com/Database
    。
    user
    、
    client_addr
    、
    access_type
    。
  7. alloydb.googleapis.com/database/postgresql/insights/perquery/latencies
    ：单查询延迟分布。
    alloydb.googleapis.com/Database
    。
    user
    、
    client_addr
    、
    querystring
    、
    query_hash
    。
  8. alloydb.googleapis.com/database/postgresql/insights/perquery/execution_time
    ：每个用户、每个数据库、每个查询的累计执行时间。
    alloydb.googleapis.com/Database
    。
    user
    、
    client_addr
    、
    querystring
    、
    query_hash
    。
  9. alloydb.googleapis.com/database/postgresql/insights/perquery/io_time
    ：自上次采样以来每个查询的累计IO时间。
    alloydb.googleapis.com/Database
    。
    user
    、
    client_addr
    、
    io_type
    、
    querystring
    、
    query_hash
    。
  10. alloydb.googleapis.com/database/postgresql/insights/perquery/lock_time
    ：自上次采样以来每个查询的累计锁等待时间。
    alloydb.googleapis.com/Database
    。
    user
    、
    client_addr
    、
    lock_type
    、
    querystring
    、
    query_hash
    。
  11. alloydb.googleapis.com/database/postgresql/insights/perquery/row_count
    ：自上次采样以来每个查询检索或影响的行数。
    alloydb.googleapis.com/Database
    。
    user
    、
    client_addr
    、
    querystring
    、
    query_hash
    。
  12. alloydb.googleapis.com/database/postgresql/insights/perquery/shared_blk_access_count
    ：每个查询语句执行访问的共享块数。
    alloydb.googleapis.com/Database
    。
    user
    、
    client_addr
    、
    access_type
    、
    querystring
    、
    query_hash
    。
  13. alloydb.googleapis.com/database/postgresql/insights/pertag/latencies
    ：查询延迟分布。
    alloydb.googleapis.com/Database
    。
    user
    、
    client_addr
    、
    action
    、
    application
    、
    controller
    、
    db_driver
    、
    framework
    、
    route
    、
    tag_hash
    。
  14. alloydb.googleapis.com/database/postgresql/insights/pertag/execution_time
    ：自上次采样以来的累计执行时间。
    alloydb.googleapis.com/Database
    。
    user
    、
    client_addr
    、
    action
    、
    application
    、
    controller
    、
    db_driver
    、
    framework
    、
    route
    、
    tag_hash
    。
  15. alloydb.googleapis.com/database/postgresql/insights/pertag/io_time
    ：自上次采样以来每个标签的累计IO时间。
    alloydb.googleapis.com/Database
    。
    user
    、
    client_addr
    、
    action
    、
    application
    、
    controller
    、
    db_driver
    、
    framework
    、
    route
    、
    io_type
    、
    tag_hash
    。
  16. alloydb.googleapis.com/database/postgresql/insights/pertag/lock_time
    ：自上次采样以来每个标签的累计锁等待时间。
    alloydb.googleapis.com/Database
    。
    user
    、
    client_addr
    、
    action
    、
    application
    、
    controller
    、
    db_driver
    、
    framework
    、
    route
    、
    lock_type
    、
    tag_hash
    。
  17. alloydb.googleapis.com/database/postgresql/insights/pertag/shared_blk_access_count
    ：每个标签的语句执行访问的共享块数。
    alloydb.googleapis.com/Database
    。
    user
    、
    client_addr
    、
    action
    、
    application
    、
    controller
    、
    db_driver
    、
    framework
    、
    route
    、
    access_type
    、
    tag_hash
    。
  18. alloydb.googleapis.com/database/postgresql/insights/pertag/row_count
    ：自上次采样以来每个标签检索或影响的行数。
    alloydb.googleapis.com/Database
    。
    user
    、
    client_addr
    、
    action
    、
    application
    、
    controller
    、
    db_driver
    、
    framework
    、
    route
    、
    tag_hash
    。

Parameters

参数

NameTypeDescriptionRequiredDefault
projectIdstringThe Id of the Google Cloud project.Yes
querystringThe promql query to execute.Yes
名称类型描述是否必填默认值
projectIdstringGoogle Cloud项目的ID。是
querystring要执行的PromQL查询。是

get_query_plan

get_query_plan

Generate a PostgreSQL EXPLAIN plan in JSON format for a single SQL statement—without executing it. This returns the optimizer's estimated plan, costs, and rows (no ANALYZE, no extra options). Use in production safely for plan inspection, regression checks, and query tuning workflows.
为单个SQL语句生成JSON格式的PostgreSQL EXPLAIN计划——无需执行该语句。返回优化器的估算计划、成本和行数（不包含ANALYZE，无额外选项）。可安全用于生产环境中的计划检查、回归测试和查询调优工作流。

Parameters

参数

NameTypeDescriptionRequiredDefault
querystringThe SQL statement for which you want to generate plan (omit the EXPLAIN keyword).Yes
名称类型描述是否必填默认值
querystring要生成计划的SQL语句（省略EXPLAIN关键字）。是

get_system_metrics

get_system_metrics

Fetches system level cloudmonitoring data (timeseries metrics) for an AlloyDB cluster, instance. To use this tool, you must provide the Google Cloud 
projectId
and a PromQL 
query
.
Generate the PromQL 
query
for AlloyDB system metrics using the provided metrics and rules. Get labels like 
cluster_id
and 
instance_id
from the user's intent.
Defaults:
  1. Interval: Use a default interval of 
    5m
    for 
    _over_time
    aggregation functions unless a different window is specified by the user.
PromQL Query Examples:
  1. Basic Time Series: 
    avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance"}[5m])
  2. Top K: 
    topk(30, avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance"}[5m]))
  3. Mean: 
    avg(avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="my-instance","cluster_id"="my-cluster"}[5m]))
  4. Minimum: 
    min(min_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance","cluster_id"="alloydb-cluster"}[5m]))
  5. Maximum: 
    max(max_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance","cluster_id"="alloydb-cluster"}[5m]))
  6. Sum: 
    sum(avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance","cluster_id"="alloydb-cluster"}[5m]))
  7. Count streams: 
    count(avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance","cluster_id"="alloydb-cluster"}[5m]))
  8. Percentile with groupby on instanceid, clusterid: 
    quantile by ("instance_id","cluster_id")(0.99,avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","cluster_id"="my-cluster","instance_id"="my-instance"}[5m]))
Available Metrics List: metricname. description. monitored resource. labels
  1. alloydb.googleapis.com/instance/cpu/average_utilization
    : The percentage of CPU being used on an instance. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    .
  2. alloydb.googleapis.com/instance/cpu/maximum_utilization
    : Maximum CPU utilization across all currently serving nodes of the instance from 0 to 100. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    .
  3. alloydb.googleapis.com/cluster/storage/usage
    : The total AlloyDB storage in bytes across the entire cluster. 
    alloydb.googleapis.com/Cluster
    . 
    cluster_id
    .
  4. alloydb.googleapis.com/instance/postgres/replication/replicas
    : The number of read replicas connected to the primary instance. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    , 
    state
    , 
    replica_instance_id
    .
  5. alloydb.googleapis.com/instance/postgres/replication/maximum_lag
    : The maximum replication time lag calculated across all serving read replicas of the instance. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    , 
    replica_instance_id
    .
  6. alloydb.googleapis.com/instance/memory/min_available_memory
    : The minimum available memory across all currently serving nodes of the instance. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    .
  7. alloydb.googleapis.com/instance/postgres/instances
    : The number of nodes in the instance, along with their status, which can be either up or down. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    , 
    status
    .
  8. alloydb.googleapis.com/database/postgresql/tuples
    : Number of tuples (rows) by state per database in the instance. 
    alloydb.googleapis.com/Database
    . 
    cluster_id
    , 
    instance_id
    , 
    database
    , 
    state
    .
  9. alloydb.googleapis.com/database/postgresql/temp_bytes_written_for_top_databases
    : The total amount of data(in bytes) written to temporary files by the queries per database for top 500 dbs. 
    alloydb.googleapis.com/Database
    . 
    cluster_id
    , 
    instance_id
    , 
    database
    .
  10. alloydb.googleapis.com/database/postgresql/temp_files_written_for_top_databases
    : The number of temporary files used for writing data per database while performing internal algorithms like join, sort etc for top 500 dbs. 
    alloydb.googleapis.com/Database
    . 
    cluster_id
    , 
    instance_id
    , 
    database
    .
  11. alloydb.googleapis.com/database/postgresql/inserted_tuples_count_for_top_databases
    : The total number of rows inserted per db for top 500 dbs as a result of the queries in the instance. 
    alloydb.googleapis.com/Database
    . 
    cluster_id
    , 
    instance_id
    , 
    database
    .
  12. alloydb.googleapis.com/database/postgresql/updated_tuples_count_for_top_databases
    : The total number of rows updated per db for top 500 dbs as a result of the queries in the instance. 
    alloydb.googleapis.com/Database
    . 
    cluster_id
    , 
    instance_id
    , 
    database
    .
  13. alloydb.googleapis.com/database/postgresql/deleted_tuples_count_for_top_databases
    : The total number of rows deleted per db for top 500 dbs as a result of the queries in the instance. 
    alloydb.googleapis.com/Database
    . 
    cluster_id
    , 
    instance_id
    , 
    database
    .
  14. alloydb.googleapis.com/database/postgresql/backends_for_top_databases
    : The current number of connections per database to the instance for top 500 dbs. 
    alloydb.googleapis.com/Database
    . 
    cluster_id
    , 
    instance_id
    , 
    database
    .
  15. alloydb.googleapis.com/instance/postgresql/backends_by_state
    : The current number of connections to the instance grouped by the state like idle, active, idle_in_transaction, idle_in_transaction_aborted, disabled, and fastpath_function_call. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    , 
    state
    .
  16. alloydb.googleapis.com/instance/postgresql/backends_for_top_applications
    : The current number of connections to the AlloyDB instance, grouped by applications for top 500 applications. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    , 
    application_name
    .
  17. alloydb.googleapis.com/database/postgresql/new_connections_for_top_databases
    : Total number of new connections added per database for top 500 databases to the instance. 
    alloydb.googleapis.com/Database
    . 
    cluster_id
    , 
    instance_id
    , 
    database
    .
  18. alloydb.googleapis.com/database/postgresql/deadlock_count_for_top_databases
    : Total number of deadlocks detected in the instance per database for top 500 dbs. 
    alloydb.googleapis.com/Database
    . 
    cluster_id
    , 
    instance_id
    , 
    database
    .
  19. alloydb.googleapis.com/database/postgresql/statements_executed_count
    : Total count of statements executed in the instance per database per operation_type. 
    alloydb.googleapis.com/Database
    . 
    cluster_id
    , 
    instance_id
    , 
    database
    , 
    operation_type
    .
  20. alloydb.googleapis.com/instance/postgresql/returned_tuples_count
    : Number of rows scanned while processing the queries in the instance since the last sample. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    .
  21. alloydb.googleapis.com/instance/postgresql/fetched_tuples_count
    : Number of rows fetched while processing the queries in the instance since the last sample. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    .
  22. alloydb.googleapis.com/instance/postgresql/updated_tuples_count
    : Number of rows updated while processing the queries in the instance since the last sample. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    .
  23. alloydb.googleapis.com/instance/postgresql/inserted_tuples_count
    : Number of rows inserted while processing the queries in the instance since the last sample. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    .
  24. alloydb.googleapis.com/instance/postgresql/deleted_tuples_count
    : Number of rows deleted while processing the queries in the instance since the last sample. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    .
  25. alloydb.googleapis.com/instance/postgresql/written_tuples_count
    : Number of rows written while processing the queries in the instance since the last sample. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    .
  26. alloydb.googleapis.com/instance/postgresql/deadlock_count
    : Number of deadlocks detected in the instance. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    .
  27. alloydb.googleapis.com/instance/postgresql/blks_read
    : Number of blocks read by Postgres that were not in the buffer cache. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    .
  28. alloydb.googleapis.com/instance/postgresql/blks_hit
    : Number of times Postgres found the requested block in the buffer cache. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    .
  29. alloydb.googleapis.com/instance/postgresql/temp_bytes_written_count
    : The total amount of data(in bytes) written to temporary files by the queries while performing internal algorithms like join, sort etc. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    .
  30. alloydb.googleapis.com/instance/postgresql/temp_files_written_count
    : The number of temporary files used for writing data in the instance while performing internal algorithms like join, sort etc. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    .
  31. alloydb.googleapis.com/instance/postgresql/new_connections_count
    : The number new connections added to the instance. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    .
  32. alloydb.googleapis.com/instance/postgresql/wait_count
    : Total number of times processes waited for each wait event in the instance. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    , 
    wait_event_type
    , 
    wait_event_name
    .
  33. alloydb.googleapis.com/instance/postgresql/wait_time
    : Total elapsed wait time for each wait event in the instance. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    , 
    wait_event_type
    , 
    wait_event_name
    .
  34. alloydb.googleapis.com/instance/postgres/transaction_count
    : The number of committed and rolled back transactions across all serving nodes of the instance. 
    alloydb.googleapis.com/Instance
    . 
    cluster_id
    , 
    instance_id
    .
获取AlloyDB集群、实例的系统级云监控数据（时间序列指标）。 使用此工具时，你必须提供Google Cloud的
projectId
和PromQL
query
。
使用提供的指标和规则生成AlloyDB系统指标的PromQL
query
。从用户的需求中获取
cluster_id
和
instance_id
等标签。
默认设置：
  1. 时间间隔：对于
    _over_time
    聚合函数，默认使用
    5m
    的时间间隔，除非用户指定了不同的窗口。
PromQL查询示例：
  1. 基础时间序列：
    avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance"}[5m])
  2. Top K：
    topk(30, avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance"}[5m]))
  3. 平均值：
    avg(avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="my-instance","cluster_id"="my-cluster"}[5m]))
  4. 最小值：
    min(min_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance","cluster_id"="alloydb-cluster"}[5m]))
  5. 最大值：
    max(max_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance","cluster_id"="alloydb-cluster"}[5m]))
  6. 求和：
    sum(avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance","cluster_id"="alloydb-cluster"}[5m]))
  7. 流计数：
    count(avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","instance_id"="alloydb-instance","cluster_id"="alloydb-cluster"}[5m]))
  8. 按实例ID、集群ID分组的百分位数：
    quantile by ("instance_id","cluster_id")(0.99,avg_over_time({"__name__"="alloydb.googleapis.com/instance/cpu/average_utilization","monitored_resource"="alloydb.googleapis.com/Instance","cluster_id"="my-cluster","instance_id"="my-instance"}[5m]))
可用指标列表：指标名称、描述、监控资源、标签
  1. alloydb.googleapis.com/instance/cpu/average_utilization
    ：实例上CPU的使用率百分比。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    。
  2. alloydb.googleapis.com/instance/cpu/maximum_utilization
    ：实例所有当前服务节点的最大CPU使用率（0到100）。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    。
  3. alloydb.googleapis.com/cluster/storage/usage
    ：整个集群的AlloyDB总存储量（字节）。
    alloydb.googleapis.com/Cluster
    。
    cluster_id
    。
  4. alloydb.googleapis.com/instance/postgres/replication/replicas
    ：连接到主实例的只读副本数量。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    、
    state
    、
    replica_instance_id
    。
  5. alloydb.googleapis.com/instance/postgres/replication/maximum_lag
    ：实例所有服务只读副本的最大复制时间延迟。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    、
    replica_instance_id
    。
  6. alloydb.googleapis.com/instance/memory/min_available_memory
    ：实例所有当前服务节点的最小可用内存。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    。
  7. alloydb.googleapis.com/instance/postgres/instances
    ：实例中的节点数量及其状态（运行中或停止）。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    、
    status
    。
  8. alloydb.googleapis.com/database/postgresql/tuples
    ：实例中每个数据库按状态统计的元组（行）数量。
    alloydb.googleapis.com/Database
    。
    cluster_id
    、
    instance_id
    、
    database
    、
    state
    。
  9. alloydb.googleapis.com/database/postgresql/temp_bytes_written_for_top_databases
    ：前500个数据库的查询写入临时文件的总数据量（字节）。
    alloydb.googleapis.com/Database
    。
    cluster_id
    、
    instance_id
    、
    database
    。
  10. alloydb.googleapis.com/database/postgresql/temp_files_written_for_top_databases
    ：前500个数据库在执行连接、排序等内部算法时，查询使用的临时文件数量。
    alloydb.googleapis.com/Database
    。
    cluster_id
    、
    instance_id
    、
    database
    。
  11. alloydb.googleapis.com/database/postgresql/inserted_tuples_count_for_top_databases
    ：实例中的查询在前500个数据库中插入的总行数。
    alloydb.googleapis.com/Database
    。
    cluster_id
    、
    instance_id
    、
    database
    。
  12. alloydb.googleapis.com/database/postgresql/updated_tuples_count_for_top_databases
    ：实例中的查询在前500个数据库中更新的总行数。
    alloydb.googleapis.com/Database
    。
    cluster_id
    、
    instance_id
    、
    database
    。
  13. alloydb.googleapis.com/database/postgresql/deleted_tuples_count_for_top_databases
    ：实例中的查询在前500个数据库中删除的总行数。
    alloydb.googleapis.com/Database
    。
    cluster_id
    、
    instance_id
    、
    database
    。
  14. alloydb.googleapis.com/database/postgresql/backends_for_top_databases
    ：前500个数据库当前连接到实例的连接数。
    alloydb.googleapis.com/Database
    。
    cluster_id
    、
    instance_id
    、
    database
    。
  15. alloydb.googleapis.com/instance/postgresql/backends_by_state
    ：实例当前的连接数按状态分组（空闲、活跃、事务中空闲、事务中止空闲、禁用、快速路径函数调用）。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    、
    state
    。
  16. alloydb.googleapis.com/instance/postgresql/backends_for_top_applications
    ：前500个应用程序连接到AlloyDB实例的当前连接数，按应用分组。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    、
    application_name
    。
  17. alloydb.googleapis.com/database/postgresql/new_connections_for_top_databases
    ：前500个数据库新增到实例的连接总数。
    alloydb.googleapis.com/Database
    。
    cluster_id
    、
    instance_id
    、
    database
    。
  18. alloydb.googleapis.com/database/postgresql/deadlock_count_for_top_databases
    ：实例中前500个数据库检测到的死锁总数。
    alloydb.googleapis.com/Database
    。
    cluster_id
    、
    instance_id
    、
    database
    。
  19. alloydb.googleapis.com/database/postgresql/statements_executed_count
    ：实例中每个数据库按操作类型统计的语句执行总数。
    alloydb.googleapis.com/Database
    。
    cluster_id
    、
    instance_id
    、
    database
    、
    operation_type
    。
  20. alloydb.googleapis.com/instance/postgresql/returned_tuples_count
    ：自上次采样以来，实例中查询处理时扫描的行数。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    。
  21. alloydb.googleapis.com/instance/postgresql/fetched_tuples_count
    ：自上次采样以来，实例中查询处理时获取的行数。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    。
  22. alloydb.googleapis.com/instance/postgresql/updated_tuples_count
    ：自上次采样以来，实例中查询处理时更新的行数。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    。
  23. alloydb.googleapis.com/instance/postgresql/inserted_tuples_count
    ：自上次采样以来，实例中查询处理时插入的行数。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    。
  24. alloydb.googleapis.com/instance/postgresql/deleted_tuples_count
    ：自上次采样以来，实例中查询处理时删除的行数。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    。
  25. alloydb.googleapis.com/instance/postgresql/written_tuples_count
    ：自上次采样以来，实例中查询处理时写入的行数。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    。
  26. alloydb.googleapis.com/instance/postgresql/deadlock_count
    ：实例中检测到的死锁数量。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    。
  27. alloydb.googleapis.com/instance/postgresql/blks_read
    ：Postgres读取的不在缓冲区缓存中的块数。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    。
  28. alloydb.googleapis.com/instance/postgresql/blks_hit
    ：Postgres在缓冲区缓存中找到请求块的次数。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    。
  29. alloydb.googleapis.com/instance/postgresql/temp_bytes_written_count
    ：查询在执行连接、排序等内部算法时写入临时文件的总数据量（字节）。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    。
  30. alloydb.googleapis.com/instance/postgresql/temp_files_written_count
    ：实例中查询在执行连接、排序等内部算法时使用的临时文件数量。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    。
  31. alloydb.googleapis.com/instance/postgresql/new_connections_count
    ：新增到实例的连接数。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    。
  32. alloydb.googleapis.com/instance/postgresql/wait_count
    ：实例中每个等待事件的进程等待总次数。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    、
    wait_event_type
    、
    wait_event_name
    。
  33. alloydb.googleapis.com/instance/postgresql/wait_time
    ：实例中每个等待事件的累计等待时间。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    、
    wait_event_type
    、
    wait_event_name
    。
  34. alloydb.googleapis.com/instance/postgres/transaction_count
    ：实例所有服务节点的已提交和回滚事务数。
    alloydb.googleapis.com/Instance
    。
    cluster_id
    、
    instance_id
    。

Parameters

参数

NameTypeDescriptionRequiredDefault
projectIdstringThe Id of the Google Cloud project.Yes
querystringThe promql query to execute.Yes
名称类型描述是否必填默认值
projectIdstringGoogle Cloud项目的ID。是
querystring要执行的PromQL查询。是

list_active_queries

list_active_queries

List the top N (default 50) currently running queries (state='active') from pg_stat_activity, ordered by longest-running first. Returns pid, user, database, application_name, client_addr, state, wait_event_type/wait_event, backend/xact/query start times, computed query_duration, and the SQL text.
列出当前运行的前N个（默认50个）查询（state='active'），按运行时间从长到短排序。返回pid、用户、数据库、application_name、client_addr、状态、wait_event_type/wait_event、backend/xact/query开始时间、计算出的query_duration以及SQL文本。

Parameters

参数

NameTypeDescriptionRequiredDefault
min_durationstringOptional: Only show queries running at least this long (e.g., '1 minute', '1 second', '2 seconds').No
1 minute
exclude_application_namesstringOptional: A comma-separated list of application names to exclude from the query results. This is useful for filtering out queries from specific applications (e.g., 'psql', 'pgAdmin', 'DBeaver'). The match is case-sensitive. Whitespace around commas and names is automatically handled. If this parameter is omitted, no applications are excluded.No``
limitintegerOptional: The maximum number of rows to return.No
50
名称类型描述是否必填默认值
min_durationstring可选：仅显示运行时间至少达到此时长的查询（例如：'1 minute'、'1 second'、'2 seconds'）。否
1 minute
exclude_application_namesstring可选：要从查询结果中排除的应用程序名称列表，用逗号分隔。这有助于过滤特定应用的查询（例如：'psql'、'pgAdmin'、'DBeaver'）。匹配区分大小写，逗号和名称周围的空格会自动处理。如果省略此参数，则不排除任何应用。否``
limitinteger可选：返回的最大行数。否
50

list_database_stats

list_database_stats

Parameters

参数

NameTypeDescriptionRequiredDefault
database_namestringOptional: A specific database name pattern to search for.No``
include_templatesbooleanOptional: Whether to include template databases in the results.No
false
database_ownerstringOptional: A specific database owner name pattern to search for.No``
default_tablespacestringOptional: A specific default tablespace name pattern to search for.No``
order_bystringOptional: The field to order the results by. Valid values are 'size' and 'commit'.No``
limitintegerOptional: The maximum number of rows to return.No
10
名称类型描述是否必填默认值
database_namestring可选：要搜索的特定数据库名称模式。否``
include_templatesboolean可选：是否在结果中包含模板数据库。否
false
database_ownerstring可选：要搜索的特定数据库所有者名称模式。否``
default_tablespacestring可选：要搜索的特定默认表空间名称模式。否``
order_bystring可选：结果排序的字段。有效值为'size'和'commit'。否``
limitinteger可选：返回的最大行数。否
10

list_locks

list_locks

Identifies all locks held by active processes showing the process ID, user, query text, and an aggregated list of all transactions and specific locks (relation, mode, grant status) associated with each process.
识别活动进程持有的所有锁，显示进程ID、用户、查询文本，以及每个进程关联的所有事务和特定锁（关系、模式、授予状态）的聚合列表。

list_query_stats

list_query_stats

Lists performance statistics for executed queries ordered by total time, filtering by database name pattern if provided. This tool requires the pg_stat_statements extension to be installed. The tool returns the database name, query text, execution count, timing metrics (total, min, max, mean), rows affected, and buffer cache I/O statistics (hits and reads).
按总时间排序列出已执行查询的性能统计信息，如果提供了数据库名称模式则进行过滤。此工具需要安装pg_stat_statements扩展。工具返回数据库名称、查询文本、执行次数、计时指标（总时长、最小、最大、平均）、受影响的行数以及缓冲区缓存IO统计信息（命中数和读取数）。

Parameters

参数

NameTypeDescriptionRequiredDefault
database_namestringOptional: The database name to list query stats for.No``
limitintegerOptional: The maximum number of results to return. Defaults to 50.No
50
名称类型描述是否必填默认值
database_namestring可选：要列出查询统计信息的数据库名称。否``
limitinteger可选：返回的最大结果数。默认值为50。否
50

long_running_transactions

long_running_transactions

Identifies and lists database transactions that exceed a specified time limit. For each of the long running transactions, the output contains the process id, database name, user name, application name, client address, state, connection age, transaction age, query age, last activity age, wait event type, wait event, and query string.
识别并列出超过指定时间限制的数据库事务。对于每个长运行事务，输出包含进程ID、数据库名称、用户名、应用程序名称、客户端地址、状态、连接时长、事务时长、查询时长、最后活动时长、等待事件类型、等待事件以及查询字符串。

Parameters

参数

NameTypeDescriptionRequiredDefault
min_durationstringOptional: Only show transactions running at least this long (e.g., '1 minute', '15 minutes', '30 seconds').No
5 minutes
limitintegerOptional: The maximum number of long-running transactions to return. Defaults to 20.No
20
名称类型描述是否必填默认值
min_durationstring可选：仅显示运行时间至少达到此时长的事务（例如：'1 minute'、'15 minutes'、'30 seconds'）。否
5 minutes
limitinteger可选：返回的长运行事务最大数量。默认值为20。否
20