Prometheus metrics

Overview

See our Prometheus integration documentation for how to set Prometheus up to automatically discover and scrape metrics for your database branches. If you’re using Datadog, see our Datadog tutorial for how to setup your Datadog agent to scrape metrics for your branch.

Metrics

PlanetScale emits the following metrics to be scraped.

Database metrics

Name & Description	Type	Tags
planetscale_edge_active_connections The number of active MySQL connections to the branch	Gauge	cluster, planetscale_database_branch_id, planetscale_region
planetscale_mysql_bytes_received_total Total number of bytes received from MySQL clients	Counter	cluster, planetscale_component, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_bytes_sent_total Total number of bytes sent to MySQL clients	Counter	cluster, planetscale_component, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_innodb_data_writes_total Total number of InnoDB data write operations	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_innodb_row_lock_time_total Total time spent acquiring row locks in InnoDB	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_innodb_row_lock_waits_total Number of times InnoDB had to wait for a row lock	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_innodb_row_operations_total Total number of row operations (inserts/updates/deletes) in InnoDB	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_mysql_operation_type, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_auto_increment_util_percentage The percentage of auto increment size being utilized	Gauge	cluster, planetscale_column, planetscale_database_branch_id, planetscale_keyspace, planetscale_shard, planetscale_table
planetscale_mysql_replica_lag_seconds Replica lag in fine-grained seconds from MySQL	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_slow_queries_total Number of queries that exceeded the slow query threshold	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_threads_running Current number of threads executing in MySQL	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_pods_container_last_terminated_reason Reason a container was last terminated (1 = the current reason). Join against planetscale_pods_container_status_restarts_total to attribute restarts to a reason	Gauge	cluster, planetscale_cell, planetscale_component, planetscale_container, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_restart_reason, planetscale_shard
planetscale_pods_container_status_restarts_total Total container restarts, across all restart reasons. Join planetscale_pods_container_last_terminated_reason to attribute them	Counter	cluster, planetscale_cell, planetscale_component, planetscale_container, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard
planetscale_pods_container_waiting_reason Container waiting reason (CrashLoopBackOff, ImagePullBackOff, etc)	Gauge	cluster, planetscale_cell, planetscale_component, planetscale_container, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type, planetscale_waiting_reason
planetscale_pods_cpu_util_percentages CPU utilization percentage of database pods	Gauge	cluster, planetscale_cell, planetscale_component, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_pods_iops_total Total IOPS (Input/Output Operations Per Second) of database pods	Counter	cluster, planetscale_cell, planetscale_component, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_pods_mem_util_percentages Memory utilization percentage of database pods	Gauge	cluster, planetscale_cell, planetscale_component, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_pods_status_phase Pod status phase (Running, Pending, Failed, Succeeded, Unknown)	Gauge	cluster, planetscale_cell, planetscale_component, planetscale_database_branch_id, planetscale_phase, planetscale_pod, planetscale_keyspace, planetscale_shard, planetscale_tablet_type
planetscale_vtgate_affected_rows_total Number of rows affected by queries through vtgate	Counter	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_pod
planetscale_vtgate_errors_total Total number of errors encountered by vtgate	Counter	cluster, planetscale_vtgate_code, planetscale_database_branch_id, planetscale_tablet_type, planetscale_keyspace, planetscale_cell, planetscale_pod, planetscale_vtgate_operation
planetscale_vtgate_queries_duration Distribution of query execution times through vtgate	Histogram	cluster, le, planetscale_cell, planetscale_database_branch_id, planetscale_pod, planetscale_tablet_type, planetscale_vtgate_operation
planetscale_vtgate_query_executions_total Number of queries executed by vtgate. Replaces planetscale_vtgate_commands_total	Counter	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_pod, planetscale_query_type, planetscale_tablet_type, planetscale_vtgate_plan_type
planetscale_vtgate_returned_rows_total Number of rows returned by queries through vtgate	Counter	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_pod, planetscale_tablet_type
planetscale_vtgate_total_pods Total number of vtgate pods	Gauge	cluster, planetscale_cell, planetscale_database_branch_id
planetscale_vtgate_v_streams_count Number of active vstreams	Gauge	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vtgate_v_streams_created_total Number of vstreams created	Counter	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vtgate_v_streams_ended_with_errors_total Number of vstreams that ended with errors	Counter	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vtgate_v_streams_events_streamed_total Number of events sent across all vstreams	Counter	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vtgate_v_streams_lag_seconds Difference in seconds between the current time when the vstream event was sent and the time when the binlog event occurred	Gauge	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vtorc_detected_problems Problems VTOrc currently detects in the cluster (1 = the problem is active). Join against the recovery counters to see what VTOrc did about it	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_vtorc_analysis
planetscale_vtorc_failed_recoveries_total Number of failed replication/recovery attempts by vtorc	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace (Vitess 23+), planetscale_pod, planetscale_shard (Vitess 23+), planetscale_vtorc_recovery_type
planetscale_vtorc_successful_recoveries_total Number of successful replication/recovery attempts by vtorc	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace (Vitess 23+), planetscale_pod, planetscale_shard (Vitess 23+), planetscale_vtorc_recovery_type
planetscale_vttablet_connection_pool_active Number of active connections in the vttablet connection pool	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_connection_pool_capacity Total capacity of the vttablet connection pool	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_connection_pool_get_total Number of connection get operations from the vttablet pool	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_connection_pool_in_use Number of connections currently in use in the vttablet pool	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_connection_pool_wait_time_total Total time spent waiting for connections from the vttablet pool	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_connection_pool_wait_total Number of waits for an available connection in the vttablet pool	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_errors_total Number of errors encountered by vttablet	Counter	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type, planetscale_vttablet_code
planetscale_vttablet_found_rows_pool_active Number of active connections in the vttablet found rows pool	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_found_rows_pool_capacity Total capacity of the vttablet found rows pool	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_found_rows_pool_get_total Number of connection get operations from the found rows pool	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_found_rows_pool_in_use Number of connections currently in use in the found rows pool	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_found_rows_pool_wait_time_total Total time spent waiting for connections from the found rows pool	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_found_rows_pool_wait_total Number of waits for an available connection in the found rows pool	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_is_serving If a vttablet is or is not serving traffic	Gauge	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_queries_affected_rows_total Total number of rows affected by queries through vttablet	Counter	cluster, planetscale_command, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_table, planetscale_tablet_type
planetscale_vttablet_queries_duration Distribution of query execution times through vttablet	Histogram	cluster, le, planetscale_command, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_queries_duration_by_table_total Total of query execution times through vttablet, broken down by table	Counter	cluster, planetscale_command, planetscale_database_branch_id, planetscale_keyspace, planetscale_shard, planetscale_table, planetscale_tablet_type
planetscale_vttablet_queries_read_rows_total Total number of rows read by queries through vttablet	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_queries_returned_rows_total Total number of rows returned by queries through vttablet	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_table, planetscale_tablet_type
planetscale_vttablet_queries_total Total number of queries processed by vttablet	Counter	cluster, planetscale_command, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_table, planetscale_tablet_type
planetscale_vttablet_replication_lag MySQL replication lag in seconds	Gauge	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_stream_connection_pool_active Number of active connections in the vttablet stream connection pool	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_stream_connection_pool_capacity Total capacity of the vttablet stream connection pool	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_stream_connection_pool_get_total Number of connection get operations from the stream connection pool	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_stream_connection_pool_in_use Number of connections currently in use in the stream connection pool	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_stream_connection_pool_wait_time_total Total time spent waiting for connections from the stream pool	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_stream_connection_pool_wait_total Number of waits for an available connection in the stream pool	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_table_storage_all_bytes Storage size of tables in bytes for all tablet types	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_table, planetscale_tablet_type
planetscale_vttablet_transaction_pool_active Number of active transactions in the vttablet transaction pool	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_transaction_pool_capacity Total capacity of the vttablet transaction pool	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_transaction_pool_get_total Number of transaction get operations from the transaction pool	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_transaction_pool_in_use Number of transactions currently in use in the transaction pool	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_transaction_pool_wait_time_total Total time spent waiting for transactions from the transaction pool	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_transaction_pool_wait_total Number of waits for an available transaction in the transaction pool	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_volume_available_bytes Available storage space in bytes on vttablet volumes	Gauge	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_volume_capacity_bytes Total storage capacity in bytes on vttablet volumes	Gauge	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vttablet_vstreamer_errors_total Total number of vttablet vstreamer errors.	Counter	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_keyspace, planetscale_shard, planetscale_vstreamer_code
planetscale_vttablet_vstreamer_events_total Total number of vttablet vstreamer streamed events.	Counter	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_keyspace, planetscale_shard
planetscale_vttablet_vstreamer_throttled_total Number of times the vstreamer was throttled by the tablet throttler.	Counter	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_keyspace, planetscale_shard
planetscale_workflow_vreplication_copy_row_count Number of rows copied so far for a VReplication workflow stream	Gauge	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_keyspace, planetscale_shard, planetscale_source_keyspace, planetscale_source_shard, planetscale_workflow
planetscale_workflow_vreplication_lag VReplication lag in seconds for workflow operations	Gauge	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_keyspace, planetscale_shard, planetscale_source_keyspace, planetscale_source_shard, planetscale_workflow
planetscale_workflow_vreplication_stream_state State of the VReplication stream for workflow operations	Gauge	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_keyspace, planetscale_shard, planetscale_state, planetscale_workflow
planetscale_workflow_vreplication_table_copy_row_count Number of rows copied so far per table for a VReplication workflow	Gauge	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_keyspace, planetscale_shard, planetscale_source_keyspace, planetscale_source_shard, planetscale_table, planetscale_workflow
planetscale_workflow_vreplication_throttled_total Number of times VReplication was throttled for a workflow, by component and throttler	Counter	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_keyspace, planetscale_shard, planetscale_throttled_component, planetscale_throttler, planetscale_workflow

The planetscale_keyspace and planetscale_shard tags on planetscale_vtorc_failed_recoveries_total and planetscale_vtorc_successful_recoveries_total are only present on databases running Vitess 23 or later. On earlier versions these counters are reported per pod and recovery type only, and queries that group by keyspace or shard return nothing.

Edge metrics (Single Tenant & Managed only)

Name & Description	Type	Tags
planetscale_edge_cpu_util_percentages CPU utilization percentage of Edge instances	Gauge	cluster, planetscale_component, planetscale_instance
planetscale_edge_instance_connections Number of active connections to Edge instances	Gauge	cluster, planetscale_component, planetscale_instance, planetscale_region
planetscale_edge_mem_util_percentages Memory utilization percentage of Edge instances	Gauge	cluster, planetscale_component, planetscale_instance
planetscale_edge_mysql_bytes_received_total Total number of MySQL bytes received by Edge instances	Counter	cluster, planetscale_database_branch_id, planetscale_instance, planetscale_region
planetscale_edge_mysql_bytes_sent_total Total number of MySQL bytes sent by Edge instances	Counter	cluster, planetscale_database_branch_id, planetscale_instance, planetscale_region
planetscale_edge_mysql_http_bytes_received_total Total number of MySQL HTTP bytes received by Edge instances	Counter	cluster, planetscale_database_branch_id, planetscale_instance, planetscale_region
planetscale_edge_mysql_http_bytes_sent_total Total number of MySQL HTTP bytes sent by Edge instances	Counter	cluster, planetscale_database_branch_id, planetscale_instance, planetscale_region
planetscale_edge_queries_total Total number of queries processed by Edge instances	Counter	cluster, planetscale_component, planetscale_instance, planetscale_region
planetscale_psdb_api_cpu_util_percentages CPU utilization percentage of PSDB API instances	Gauge	cluster, planetscale_availability_zone, planetscale_component, planetscale_pod
planetscale_psdb_api_mem_util_percentages Memory utilization percentage of PSDB API instances	Gauge	cluster, planetscale_availability_zone, planetscale_component, planetscale_pod
planetscale_psdb_api_requests_total Total number of requests processed by PSDB API instances	Counter	cluster, planetscale_availability_zone, planetscale_component, planetscale_pod, planetscale_psdb_api_operation

Deprecated metrics

These metrics are deprecated and will be removed eventually.

Name & Description	Type	Tags
planetscale_pods_container_restarts_total Total container restart events detected. The reason label is attached to an all-reasons total and the counter cannot be observed at zero, so rates and increases over it are wrong in both directions. Replaced by planetscale_pods_container_status_restarts_total.	Counter	cluster, planetscale_cell, planetscale_component, planetscale_container, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_restart_reason, planetscale_shard, planetscale_tablet_type
planetscale_vtgate_commands_total Number of commands processed by vtgate. Replaced by planetscale_vtgate_query_executions_total.	Counter	cluster, planetscale_cell, planetscale_command, planetscale_database_branch_id, planetscale_pod
planetscale_vttablet_table_storage_bytes Storage size of tables in bytes. Replaced by planetscale_vttablet_table_storage_all_bytes.	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_shard, planetscale_table

Experimental metrics

These metrics are experimental and may be subject to changes to their name, type, or tags.

Name & Description	Type	Tags
planetscale_mysql_innodb_history_list_length InnoDB transaction history list length (purge lag indicator)	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_innodb_redo_log_capacity_resized Current InnoDB redo log capacity in bytes	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_innodb_redo_log_current_lsn Current InnoDB redo log sequence number	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_innodb_redo_log_checkpoint_lsn InnoDB redo log checkpoint sequence number	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_innodb_buffer_pool_read_requests_total Total logical read requests to buffer pool	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_innodb_buffer_pool_reads_total Number of reads that required disk I/O (buffer pool misses)	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_innodb_buffer_pool_bytes_dirty Total bytes of dirty pages in buffer pool	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_innodb_buffer_pool_bytes_data Total bytes of data in buffer pool	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_innodb_buffer_pool_wait_free_total Number of times InnoDB had to wait for free pages in buffer pool	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_innodb_log_waits_total Number of times log buffer was too small and required flushing	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_innodb_os_log_written_total Total bytes written to InnoDB redo log files	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_innodb_data_written_total Total bytes of data written by InnoDB	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_innodb_buffer_pool_read_ahead_evicted_total Read-ahead pages evicted without being accessed	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_handlers_total Total handler operations by type	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_mysql_handler_type, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_sort_merge_passes_total Number of merge passes the sort algorithm has had to do	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_sort_range_total Number of sorts done with ranges	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_sort_scan_total Number of sorts done by scanning the table	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_threads_connected Number of currently open connections	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_connections_total Total number of connection attempts	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_max_connections Maximum permitted number of simultaneous connections	Gauge	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_created_tmp_tables_total Number of internal temporary tables created	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_created_tmp_disk_tables_total Number of internal on-disk temporary tables created	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_table_locks_immediate_total Number of times a table lock was acquired immediately	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_table_locks_waited_total Number of times a table lock could not be acquired immediately	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_binlog_cache_use_total Number of transactions that used the binary log cache	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_binlog_cache_disk_use_total Number of transactions that used temporary binary log cache but exceeded binlog_cache_size	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_binlog_stmt_cache_use_total Number of non-transactional statements that used the binary log statement cache	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_mysql_binlog_stmt_cache_disk_use_total Number of non-transactional statements that exceeded binlog_stmt_cache_size	Counter	cluster, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_tablet_type
planetscale_vitess_emergency_reparents_total Number of emergency reparents attempted on a shard, counting both successes and failures. An emergency reparent means the primary was promoted to recover from a failure rather than as part of planned work	Counter	cluster, planetscale_component, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_reparent_result, planetscale_shard
planetscale_vitess_planned_reparents_total Number of planned reparents attempted on a shard, counting both successes and failures. A planned reparent is a graceful promotion, such as the one that happens during maintenance or when you request one	Counter	cluster, planetscale_component, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_reparent_result, planetscale_shard
planetscale_vttablet_storage_info An info metric for the storage type of a vttablet	Gauge	cluster, planetscale_cell, planetscale_database_branch_id, planetscale_keyspace, planetscale_pod, planetscale_shard, planetscale_storage_type, planetscale_tablet_type

Attributing container restarts

planetscale_pods_container_status_restarts_total counts every restart and carries no role or reason label. Join the metric that carries the one you want. To break restarts down by role, join planetscale_pods_status_phase:

sum by (planetscale_tablet_type) (
  increase(planetscale_pods_container_status_restarts_total[1h])
  * on (planetscale_pod) group_left(planetscale_tablet_type)
  group by (planetscale_pod, planetscale_tablet_type) (planetscale_pods_status_phase)
)

To break restarts down by reason as well, filter against planetscale_pods_container_last_terminated_reason one minute at a time and join the role onto the result:

sum by (planetscale_tablet_type) (
  sum_over_time((
    increase(planetscale_pods_container_status_restarts_total[1m])
    and on (planetscale_pod, planetscale_container)
    planetscale_pods_container_last_terminated_reason{planetscale_restart_reason="OOMKilled"}
  )[1h:1m])
  * on (planetscale_pod) group_left(planetscale_tablet_type)
  group by (planetscale_pod, planetscale_tablet_type) (planetscale_pods_status_phase)
)

The gauge only reports a container’s latest termination reason, so the query attributes each minute’s restarts to the reason current in that minute, then sums over the hour. Change 1h to your own window and leave the 1m alone. A container that restarts twice inside one minute under two different reasons has both restarts attributed to the later one.

Tag glossary

Tag Name	Description
cluster	The database cluster identifier
le	Histogram bucket upper bound (less than or equal to)
planetscale_availability_zone	AWS availability zone where the component is running
planetscale_cell	Availability zone or cell where the component is running
planetscale_column	Auto-increment column name
planetscale_command	VTGate command type (e.g., Select, Insert, Update)
planetscale_component	Vitess component type (vtgate, vttablet, vtctld, vtorc). On the reparent metrics it says which component ran the reparent: vtorc means VTOrc recovered the shard on its own, vtctld means the reparent was requested
planetscale_container	Kubernetes container name within the pod
planetscale_database_branch_id	Unique identifier for the database branch
planetscale_instance	Edge instance identifier
planetscale_keyspace	Database keyspace (logical database name)
planetscale_mysql_handler_type	MySQL handler operation type (e.g., read_first, read_key, write)
planetscale_mysql_operation_type	MySQL row operation type (inserted, read, updated, deleted)
planetscale_phase	Pod status phase (Running, Pending, Failed, Succeeded, Unknown)
planetscale_pod	Kubernetes pod name where the component is running
planetscale_psdb_api_operation	PSDB API operation type
planetscale_query_type	Query statement type (SELECT, INSERT, UPDATE, DELETE, etc.)
planetscale_region	Geographic region where the database is hosted
planetscale_reparent_result	Whether a reparent attempt succeeded (success, failure)
planetscale_restart_reason	Reason for a container’s most recent termination (OOMKilled, Error, Completed). Carried by planetscale_pods_container_last_terminated_reason
planetscale_shard	Database shard identifier
planetscale_source_keyspace	Source keyspace for VReplication workflow operations
planetscale_source_shard	Source shard for VReplication workflow operations
planetscale_state	VReplication stream state (e.g., Running, Stopped)
planetscale_storage_type	Storage type backing a vttablet (network-attached, metal)
planetscale_table	Database table name
planetscale_tablet_type	Vitess tablet type (primary, replica, rdonly). Absent on components that have none, such as vtgate
planetscale_throttled_component	VReplication component that was throttled (e.g., vcopier, vplayer, binlogplayer)
planetscale_throttler	Which throttler applied the throttle (tablet throttler name)
planetscale_vstreamer_code	VTTablet VStreamer error code (StreamEnded, etc.)
planetscale_vtgate_code	VTGate error code (INVALID_ARGUMENT, etc.)
planetscale_vtgate_operation	VTGate operation type (Execute, ExecuteBatch, etc.)
planetscale_vtgate_plan_type	VTGate query plan type (Passthrough, Scatter, MultiShard, Join, etc.)
planetscale_vtorc_analysis	The problem VTOrc detected (DeadPrimary, ReplicaSemiSyncMustBeSet, etc.)
planetscale_vtorc_recovery_type	The recovery VTOrc performed (RecoverDeadPrimary, ElectNewPrimary, FixReplica, etc.)
planetscale_vttablet_code	VTTablet error code (NOT_FOUND, etc.)
planetscale_waiting_reason	Container waiting reason (CrashLoopBackOff, ImagePullBackOff, etc.)
planetscale_workflow	VReplication workflow identifier

Need help?

Get help from the PlanetScale Support team, or join our Discord community to see how others are using PlanetScale.

Pricing

Platform

Integrations

Guides

Overview

Metrics

Database metrics

Edge metrics (Single Tenant & Managed only)

Deprecated metrics

Experimental metrics

Attributing container restarts

Tag glossary

Need help?

​Overview

​Metrics

​Database metrics

​Edge metrics (Single Tenant & Managed only)

​Deprecated metrics

​Experimental metrics

​Attributing container restarts

​Tag glossary

​Need help?

Overview

Metrics

Database metrics

Edge metrics (Single Tenant & Managed only)

Deprecated metrics

Experimental metrics

Attributing container restarts

Tag glossary

Need help?