Logo
Observability

Observability #

PluginBootService #

SPI NameDescription
PluginBootServicePlugin startup service definition
Implementation ClassDescription
PrometheusPluginBootServicePrometheus plugin startup class
BaseLoggingPluginBootServiceLogging plugin startup class
JaegerTracingPluginBootServiceJaeger plugin startup class
OpenTelemetryTracingPluginBootServiceOpenTelemetryTracing plugin startup class
OpenTracingPluginBootServiceOpenTracing plugin startup class
ZipkinTracingPluginBootServiceZipkin plugin startup class

Proxy Agent Monitoring Metrics #

MetricDescriptionMetric Type
proxy_request_totaltotal number of requestsCOUNTER
proxy_connection_totaltotal number of connectionsGAUGE
proxy_execute_latency_millisrequest duration (MS)HISTOGRAM
proxy_execute_error_totalNumber of execution exceptionsCOUNTER
proxy_infoProxy information. Different values of the name tag represent different information contents. state: proxy running status value, 1 for running and 2 for fusing. uptime: runtime length milliseconds. init-metadata-duration: metadata loading took Ms. init-socket-duration: network startup took Ms. init-backend-duration: the backend startup took milliseconds. boot-duration: boot duration takes milliseconds. boot-time: boot time millisecond value timestamp.GAUGE
proxy_transaction_commit_totalTransaction commit timesCOUNTER
proxy_transaction_rollback_totalTransaction rollback timesCOUNTER
build_infoProxy build information. The name tag represents different components, and the version tag represents the component version.Name equals ‘sphereex-plugins-metrics-prometheus’ represents agent. Name equals ‘shardingsphere-proxy-bootstrap’ represents proxy.GAUGE
meta_data_infoMetadata information. Different name tag values represent different information. database_count: number of databases. database_instance_count: number of database instances. database_catalog_count: number of data directories. datasource_count: number of data sources. table_count: number of tables (sharding table+broadcast table+single table+binding table (table group)). sharding_table_count: number of sharding tables. broadcast_table_count: number of broadcast tables. single_table_count: number of single tables. encrypt_table_count: number of encryption rules. shadow_table_count: number of shadow rules. readwrite_splitting_count: number of read/write splitting rules. db_discovery_count: number of database discovery rules. user_count: number of users.GAUGE
parse_dist_sql_rql_totalTotal number of DistSQL RQL types parsedCOUNTER
parse_dist_sql_rdl_totalTotal number of DistSQL RDL types parsedCOUNTER
parse_dist_sql_ral_totalTotal number of DistSQL RAL types parsedCOUNTER
parse_dist_sql_rul_totalTotal number of DistSQL RUL types parsedCOUNTER
route_sql_select_totalTotal number of select SQL statements executed by routeCOUNTER
route_sql_insert_totalTotal number of insert SQL statements executed by routeCOUNTER
route_sql_update_totalTotal number of update SQL statements executed by routeCOUNTER
route_sql_delete_totalTotal number of delete SQL statements executed by routeCOUNTER
route_datasource_totalThe number of data source routes. The name tag represents the added data source nameCOUNTER
route_table_totalThe number of table routes. The name tag represents the table nameCOUNTER
parse_sql_dml_insert_totalTotal number of insert SQL statements parsedCOUNTER
parse_sql_dml_delete_totalTotal number of delete SQL statements parsedCOUNTER
parse_sql_dml_update_totalTotal number of update SQL statements parsedCOUNTER
parse_sql_dml_select_totalTotal number of select SQL statements parsedCOUNTER
parse_sql_ddl_totalTotal number of parsing DDL SQL statementsCOUNTER
parse_sql_dcl_totalTotal number of parsing DCL SQL statementsCOUNTER
parse_sql_dal_totalTotal number of parsing DAL SQL statementsCOUNTER
parse_sql_tcl_totalTotal number of parsing TCL SQL statementsCOUNTER
proxy_transaction_autocommit_totalTotal number of auto commit transactionsCOUNTER
proxy_connection_usage_secConnection durationHISTOGRAM
proxy_request_bytesNumber of requested bytesHISTOGRAM
proxy_response_bytesNumber of response bytesHISTOGRAM
route_sql_latency_millisRouting SQL takes timeHISTOGRAM
parse_sql_latency_millisParsing durationHISTOGRAM
parse_sql_in_commitNumber of SQL parsed in commitHISTOGRAM
parse_sql_in_rollbackNumber of SQL parsed in rollbackHISTOGRAM
proxy_execute_error_typed_totalThe total number of execution errors. The name tag represents the exception class name.COUNTER
parse_sql_totalTotal number of SQL parsedCOUNTER
route_sql_totalTotal number of SQL routesCOUNTER
proxy_execute_totalTotal number of tasks executedCOUNTER
proxy_backend_executor_thread_infoThe backend executes thread pool information. Labels of different names represent thread information in different states.(It is only of reference significance when executing tasks will affect multiple actual database tables, such as sharding data query)task_pending: Number of tasks to be executed; task_running: Number of tasks being executed; task_completed: Cumulative number of tasks completed; kernel_executor_size: In file of server.yaml, parameter kernel_executor_size configuration value.GAUGE