OpenText Analytics Database 26.2.x – HTTPS service

Admin: HTTPS endpoints

Mon, 01 Jan 0001 00:00:00 +0000

The HTTPS service exposes general-purpose endpoints for interacting with your database. While most endpoints require authentication with either certificates or the dbadmin's password, the following endpoints for documentation do not:

/v1/version
/swagger/ui
/swagger/{RESOURCE}
/api-docs/oas-3.0.0.json

To view a list of all endpoints, enter the following URL in your browser:

https://database_hostname_or_ip:8443/swagger/ui?urls.primaryName=server_docs

/v1/metrics (GET)

OpenText™ Analytics Database exposes time series metrics for Prometheus monitoring and alerting. These metrics create a detailed model of your database behavior over time to provide valuable performance and troubleshooting insights.

To retrieve time series metrics for a node, send a GET request to /v1/metrics:

$ curl https://host:8443/v1/metrics \
    --key path/to/client_key.key \
    --cert path/to/client_cert.pem \

The database scrapes metrics from the node and outputs the metrics in Prometheus text-based exposition format. This format applies context-specific labels to each metric to help group metrics when you visualize your data. It also describes the metric type—the database provides counter, gauge, and histogram metric types. The following example outlines the output format:

# HELP metric-name metric-defintion
# TYPE metric-name metric-type
metric-name{label-key="label-value"[, ...]} metric-value

For example, the following example shows a snippet of the request response that provides details about the vertica_resource_pool_memory_size_actual_kb metric:

$ curl https://10.20.30.40:8443/v1/metrics \
    --key path/to/client_key.key \
    --cert path/to/client_cert.pem \
...
# HELP vertica_resource_pool_memory_size_actual_kb Current amount of memory (in kilobytes) allocated to the resource pool by the resource manager.
# TYPE vertica_resource_pool_memory_size_actual_kb gauge
vertica_resource_pool_memory_size_actual_kb{node_name="v_vmart_node0001",pool_name="metadata",revive_instance_id="114b25c4aab6fec8c26b121cff2b52"} 84381
vertica_resource_pool_memory_size_actual_kb{node_name="v_vmart_node0001",pool_name="blobdata",revive_instance_id="114b25c4aab6fec8c26b121cff2b52"} 0
vertica_resource_pool_memory_size_actual_kb{node_name="v_vmart_node0001",pool_name="jvm",revive_instance_id="114b25c4aab6fec8c26b121cff2b52"} 0
vertica_resource_pool_memory_size_actual_kb{node_name="v_vmart_node0001",pool_name="sysquery",revive_instance_id="114b25c4aab6fec8c26b121cff2b52"} 336970
vertica_resource_pool_memory_size_actual_kb{node_name="v_vmart_node0001",pool_name="tm",revive_instance_id="114b25c4aab6fec8c26b121cff2b52"} 336970
vertica_resource_pool_memory_size_actual_kb{node_name="v_vmart_node0001",pool_name="general",revive_instance_id="114b25c4aab6fec8c26b121cff2b52"} 5981079
vertica_resource_pool_memory_size_actual_kb{node_name="v_vmart_node0001",pool_name="recovery",revive_instance_id="114b25c4aab6fec8c26b121cff2b52"} 0
vertica_resource_pool_memory_size_actual_kb{node_name="v_vmart_node0001",pool_name="dbd",revive_instance_id="114b25c4aab6fec8c26b121cff2b52"} 0
vertica_resource_pool_memory_size_actual_kb{node_name="v_vmart_node0001",pool_name="refresh",revive_instance_id="114b25c4aab6fec8c26b121cff2b52"} 0
...

To get a cluster-wide view of your metrics, you must call the /v1/metrics endpoint on each node in your cluster.

For a comprehensive list of metrics, see Prometheus metrics.

Grafana dashboards

You can visualize data exposed at /v1/metrics with Grafana dashboards. OpenText™ Analytics Database provides the following dashboards for metrics that use a Prometheus data source:

You can also download the source for each dashboard from the vertica/grafana-dashboards repository.

Admin: Prometheus metrics

Mon, 01 Jan 0001 00:00:00 +0000

The following table describes the metrics available at https://host:8443/v1/metrics/.

Name	Type	Description
`vertica_allocator_total_size_bytes`	gauge	Amount of bytes consumed in an allocator pool.
`vertica_build_info`	gauge	Shows information about the Vertica build through labels.
`vertica_cpu_aggregate_usage_percentage`	gauge	Aggregate CPU usage, expressed as a percentage of total CPU capacity.
`vertica_data_size_compressed_mb`	gauge	Total compressed size (in megabytes) of the data.
`vertica_data_size_estimation_error_mb`	gauge	Margin of error (in megabytes) of the estimated raw data size.
`vertica_db_info`	gauge	Shows information about the current database through labels.
`vertica_depot_evictions_bytes`	counter	Total size (in bytes) of depot evictions.
`vertica_depot_evictions_total`	counter	Number of depot evictions.
`vertica_depot_fetch_queue_size`	gauge	Number of files in the depot's fetch queue.
`vertica_depot_fetches_bytes`	counter	Total size (in bytes) of successful depot fetches.
`vertica_depot_fetches_failures_total`	counter	Number of failed depot fetch requests.
`vertica_depot_fetches_ms`	histogram	Time (in milliseconds) that it takes to fetch files into the depot.
`vertica_depot_fetches_requests_total`	counter	Number of depot fetch requests.
`vertica_depot_lookup_hits_total`	counter	Number of cache hits when finding a file in the depot.
`vertica_depot_lookup_requests_total`	counter	Number of attempts to find a file in the depot.
`vertica_depot_max_size_bytes`	gauge	Maximum size (in bytes) of the depot.
`vertica_depot_size_bytes`	gauge	Number of bytes currently used in the depot.
`vertica_depot_uploads_bytes`	counter	Number of bytes uploaded to persistent storage.
`vertica_depot_uploads_failures_total`	counter	Number of failures during upload attempts to persistent storage.
`vertica_depot_uploads_in_progress_bytes`	gauge	Number of bytes in running requests that are uploading a file to persistent storage.
`vertica_depot_uploads_in_progress_counter`	gauge	Number of requests currently uploading a file to persistent storage.
`vertica_depot_uploads_ms`	histogram	Time (in milliseconds) it took to upload files to persistent storage.
`vertica_depot_uploads_queued_bytes`	gauge	Number of bytes in queued requests to upload a file to persistent storage.
`vertica_depot_uploads_queued_counter`	gauge	Number of queued requests to upload a file to persistent storage.
`vertica_depot_uploads_requests_total`	counter	Number of file upload attempts to persistent storage.
`vertica_depot_usage_percent`	gauge	Current size of the depot, expressed as a percentage of max depot size.
`vertica_disk_storage_free_mb`	gauge	Number of megabytes of free storage available.
`vertica_disk_storage_free_percent`	gauge	Amount of free storage available, expressed as a percentage of total disk storage.
`vertica_disk_storage_latency_seek_per_second`	gauge	Measures a storage location's performance in seeks/sec. 1/latency is the time that it takes to seek to the data.
`vertica_disk_storage_throughput_mb_per_second`	gauge	Measures a storage location's performance in MBps. 1/throughput is the time that it takes to read 1MB of data.
`vertica_disk_storage_total_mb`	gauge	Number of megabytes of total disk storage.
`vertica_disk_storage_used_mb`	gauge	Number of megabytes of disk storage in use.
`vertica_errors`	counter	Number of errors, by error level and error code.
`vertica_estimated_data_size_raw_mb`	gauge	Estimation (in megabytes) of the total raw data size. This is computed each time there is an audit.
`vertica_file_system_attempted_operations_total`	gauge	Number of attempted file system operations.
`vertica_file_system_data_reads_total`	gauge	Number of read operations, such as S3 GET requests, to download files.
`vertica_file_system_data_writes_total`	gauge	Number of write operations, such as S3 PUT requests, to upload files.
`vertica_file_system_downstream_bytes`	gauge	Number of bytes received.
`vertica_file_system_failed_operations_total`	gauge	Number of failed filesystem operations.
`vertica_file_system_metadata_reads_total`	gauge	Number of requests to read metadata. For example, S3 list bucket and HEAD requests are metadata reads.
`vertica_file_system_metadata_writes_total`	gauge	Number of requests to write metadata. For example, S3 POST and DELETE requests are metadata writes.
`vertica_file_system_open_files_counter`	gauge	Number of currently open files.
`vertica_file_system_overall_average_latency_ms`	gauge	Average HTTP request latency in milliseconds.
`vertica_file_system_overall_downstream_throughput_mb_s`	gauge	Average downstream throughput in megabytes per second.
`vertica_file_system_overall_upstream_throughput_mb_s`	gauge	Average upstream throughput in megabytes per second.
`vertica_file_system_reader_counter`	gauge	Number of currently running read operations.
`vertica_file_system_retries_total`	gauge	Number of retry events.
`vertica_file_system_total_request_duration_ms`	gauge	Sum of HTTP request latency in milliseconds.
`vertica_file_system_upstream_bytes`	gauge	Number of bytes sent.
`vertica_file_system_writer_counter`	gauge	Number of currently running writer operations.
`vertica_health_watchdog_blocked_transactions`	counter	Number of blocked tranactions per health metric.
`vertica_health_watchdog_timed_out_transactions`	counter	Number of timed out transactions per health metric.
`vertica_health_watchdog_module_health_metric_information`	gauge	Current health metric.
`vertica_health_watchdog_txn_block_time_ms`	histogram	Time a transaction is blocked by Health Watchdog metric.
`vertica_is_readonly`	gauge	Returns whether the nodes are read-only.
`vertica_last_audit_end_time`	gauge	Time (in milliseconds) that the last audit ended.
`vertica_last_catalog_sync_seconds`	gauge	Number of seconds elapsed since the most recent catalog sync.
`vertica_license_node_count`	gauge	If the license limits the number of nodes, the number of nodes that the license allows.
`vertica_license_size_mb`	gauge	If the license limits the size of the database, the number of megabytes that license allows.
`vertica_locked_users`	gauge	Number of users that are locked out of their accounts.
`vertica_login_attempted_total`	counter	Number of login attempts.
`vertica_login_failure_total`	counter	Number of failed login attempts.
`vertica_login_success_total`	counter	Number of successful login attempts.
`vertica_planned_file_reads_bytes`	counter	Total number of bytes read in requests for files (estimated during query planning).
`vertica_planned_file_reads_requests_total`	counter	Total number of read requests for files (estimated during query planning).
`vertica_process_memory_usage_percent`	gauge	Total database process memory usage, expressed as a percentage of total usable RAM.
`vertica_projections_not_up_to_date_total`	gauge	Number of projections that are not up to date.
`vertica_projections_segmented_total`	gauge	Number of segmented projections.
`vertica_projections_total`	gauge	Number of projections.
`vertica_projections_unsafe_total`	gauge	Number of projections whose K-safety is less than the database K-safety.
`vertica_projections_unsegmented_total`	gauge	Number of unsegmented projections.
`vertica_query_requests_attempted_total`	counter	Number of attempted query requests.
`vertica_query_requests_failed_total`	counter	Number of failed query requests.
`vertica_query_requests_processed_rows_total`	counter	Number of processed rows for each query type.
`vertica_query_requests_succeeded_total`	counter	Number of successful query requests.
`vertica_query_requests_time_ms`	histogram	Time (in milliseconds) that it takes to execute query requests in the resource pool.
`vertica_queued_requests_failed_reservation_total`	counter	Number of queued requests whose resource reservation failed in the resource pool.
`vertica_queued_requests_max_memory_kb`	gauge	Maximum memory requested for a single queued request in the resource pool.
`vertica_queued_requests_total`	gauge	Number of requests that are queued in the resource pool.
`vertica_queued_requests_total_memory_kb`	gauge	Total memory requested for all queued requests in the resource pool.
`vertica_queued_requests_wait_time_ms`	histogram	Length of time (in microseconds) that a resource pool queues queries.
`vertica_resource_pool_general_memory_borrowed_kb`	gauge	Amount of memory (in kilobytes) that running requests borrow from the GENERAL pool.
`vertica_resource_pool_max_concurrency`	gauge	MAXCONCURRENCY parameter setting for the resource pool. When set to -1, the resource pool can have an unlimited number of concurrent execution slots. When set to 0, queries are prevented from running in the pool.
`vertica_resource_pool_max_memory_size_kb`	gauge	MAXMEMORYSIZE parameter setting (in kilobytes) for the resource pool.
`vertica_resource_pool_max_query_memory_size_kb`	gauge	MAXQUERYMEMORYSIZE parameter setting (in kilobytes) for the resource pool. When set to -1, the resource pool borrows any amount of available memory from the GENERAL pool, up to vertica_resource_pool_max_memory_size_kb.
`vertica_resource_pool_memory_inuse_kb`	gauge	Amount of memory (in kilobytes) acquired by requests running against the resource pool.
`vertica_resource_pool_memory_size_actual_kb`	gauge	Current amount of memory (in kilobytes) allocated to the resource pool by the resource manager.
`vertica_resource_pool_planned_concurrency`	gauge	PLANNEDCONCURRENCY parameter setting for the resource pool.
`vertica_resource_pool_priority`	gauge	PRIORITY parameter setting for the resource pool.
`vertica_resource_pool_query_budget_kb`	gauge	Amount of resource pool memory (in kilobytes) that queries are currently tuned to use. When equal to -1, queries are prevented from running in the pool.
`vertica_resource_pool_queue_timeout`	gauge	QUEUETIMEOUT parameter setting for the resource pool.
`vertica_resource_pool_queueing_threshold_kb`	gauge	Limits the amount of memory (in kilobytes) that a resource pool makes available to all requests before it queues requests.
`vertica_resource_pool_running_query_count`	gauge	Number of queries currently executing in the pool.
`vertica_resource_pool_runtime_priority_threshold`	gauge	RUNTIMEPRIORITYTHRESHOLD parameter setting for the resource pool.
`vertica_sessions_blocked_counter`	gauge	Number of sessions that are blocked waiting for locks.
`vertica_sessions_running_counter`	gauge	Number of active sessions.
`vertica_storage_containers_count`	gauge	Total number of storage containers.
`vertica_subcluster_info`	gauge	Shows information about a subcluster through labels.
`vertica_system_disk_io_completed_per_second`	gauge	Number of successful I/O requests completed per second.
`vertica_system_disk_io_in_progress_counter`	gauge	Number of I/O requests currently in process.
`vertica_system_disk_io_read_kb_per_second`	gauge	Measures the I/O bandwidth used to read from disk in KBps.
`vertica_system_disk_io_usage_percent`	gauge	Percentage of time the disk is processing I/O.
`vertica_system_disk_io_write_kb_per_second`	gauge	Measures the I/O bandwidth used to write to disk in KBps.
`vertica_system_memory_usage_percent`	gauge	Total system memory usage, expressed as a percentage of total usable RAM.
`vertica_tm_operations_attempted_total`	counter	Number of attempted tuple mover operations.
`vertica_tm_operations_completed_total`	counter	Number of completed tuple mover operations.
`vertica_tm_operations_failed_total`	counter	Number of aborted tuple mover operations.
`vertica_tm_operations_ros_count_total`	gauge	Total number of ROS containers in the tuple mover operation.
`vertica_tm_operations_ros_used_bytes_total`	gauge	Total size (in bytes) of all ROS containers in the mergeout operation.
`vertica_tm_operations_running_total`	gauge	Number of running tuple mover operations.
`vertica_total_nodes_count`	gauge	Total number of nodes.
`vertica_transactions_completed_total`	counter	Number of completed transactions.
`vertica_transactions_failed_total`	counter	Number of failed transactions.
`vertica_transactions_started_total`	counter	Number of transactions that have started.
`vertica_up_nodes_count`	gauge	Number of nodes that have a database running and can accept connections.