Spice can be monitored using the Spice Prometheus-compatible Metrics Endpoint (opens in a new tab).
Monitoring clients configuration:
The metrics endpoint uses port 9090 by default. The metrics endpoint configuration is logged at startup.
Pass the --metrics parameter to bind to a specific port. For example, to bind to port 9091:
or when using Docker:
Configuration of the metrics endpoint can be verified using a HTTP GET request, for example:
| Metric | Description |
| ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------- | --- |
| accelerated_ready_state_federated_fallback(count) | Number of times the federated table was queried due to the accelerated table loading the initial data. |
| catalog_load_errors(count) | Number of errors loading the catalog provider. |
| catalog_load_state(gauge) | Status of the catalog provider. 0=Initializing, 1=Ready, 2=Disabled, 3=Error, 4=Refreshing, 5=ShuttingDown. |
| dataset_acceleration_last_refresh_time_ms(gauge) | Unix timestamp in seconds when the last refresh completed. |
| dataset_acceleration_refresh_duration_ms(histogram) | Duration in milliseconds to load a full or appended refresh data. |
| dataset_acceleration_refresh_errors(count) | Number of errors refreshing the dataset. |
| dataset_active_count(gauge) | Number of currently loaded datasets. |
| dataset_load_state(gauge) | Status of the dataset. 0=Initializing, 1=Ready, 2=Disabled, 3=Error, 4=Refreshing, 5=ShuttingDown. |
| dataset_unavailable_time_ms | Time dataset went offline in milliseconds. |
| | Number of currently loaded embeddings. |
| | Number of errors loading the embedding. |
| | Status of the embedding. 0=Initializing, 1=Ready, 2=Disabled, 3=Error, 4=Refreshing, 5=ShuttingDown. |
| | Measures the duration of Flight requests in milliseconds. |
| | Total number of Flight requests. |
| | Measures the duration of HTTP requests in milliseconds. |
| | Number of HTTP requests. | |
| | Status of the LLM model. 0=Initializing, 1=Ready, 2=Disabled, 3=Error, 4=Refreshing, 5=ShuttingDown. |
| | Number of currently loaded models. |
| | Duration in milliseconds to load the model. |
| | Number of errors loading the model. |
| | Status of the model. 0=Initializing, 1=Ready, 2=Disabled, 3=Error, 4=Refreshing, 5=ShuttingDown. |
| | The total amount of time spent planning and executing queries in milliseconds. |
| | The total amount of time spent only executing queries (0 for cached queries). |
| | Number of query executions. |
| | Number of query failures. |
| | Number of bytes processed by the runtime. |
| | Number of bytes returned to query clients. |
| | Maximum allowed size of the cache in bytes. |
| | Number of requests to get a key from the cache. |
| | Cache hit count. |
| | Number of items currently in the cache. |
| | Size of the cache in bytes. |
| | Maximum allowed size of the search cache in bytes. |
| | Number of requests to get a key from the search cache. |
| | Search cache hit count. |
| | Number of items currently in the search cache. |
| | Size of the search cache in bytes. |
| | Indicates the runtime Flight server has started. |
| | Indicates the runtime HTTP server has started. |
| | Duration in milliseconds to load the secret stores. |
| | Number of currently loaded LLM tools. |
| | Number of errors loading the LLM tool. |
| | Status of the LLM tools. 0=Initializing, 1=Ready, 2=Disabled, 3=Error, 4=Refreshing, 5=ShuttingDown. |
| | Number of errors loading the view. |
| | Status of the views. 0=Initializing, 1=Ready, 2=Disabled, 3=Error, 4=Refreshing, 5=ShuttingDown. |
:::note Component Metrics
In addition to these core metrics, individual components can expose their own metrics. For example, the MySQL data connector exposes connection pool metrics (opens in a new tab). See Component Metrics (opens in a new tab) for more information.
:::
embeddings_active_countembeddings_load_errorsembeddings_load_stateflight_request_duration_msflight_requestshttp_requests_duration_mshttp_requestsllm_load_statemodel_active_countmodel_load_duration_msmodel_load_errorsmodel_load_statequery_duration_msquery_execution_duration_msquery_executionsquery_failuresquery_processed_bytesquery_returned_bytesresults_cache_max_size_bytesresults_cache_requestsresults_cache_hitsresults_cache_items_countresults_cache_size_bytessearch_results_cache_max_size_bytessearch_results_cache_requestssearch_results_cache_hitssearch_results_cache_items_countsearch_results_cache_size_bytesruntime_flight_server_startedruntime_http_server_startedsecrets_store_load_duration_mstool_active_counttool_load_errorstool_load_stateview_load_errorsview_load_state