B.7. User-Defined Tasks

B.7. User-Defined Tasks

Documentation

VoltDB Home » Documentation » Administrator's Guide

table of contents

B.7. User-Defined Tasks

The following tables describe the metrics for measuring and monitoring user-defined tasks.

Table B.14. Tasks

Metrics	Type	Description
voltdb_scheduler_action_status_info	Metadata	Informational metric with scheduler metadata. Tags: PARTITION_ID - The numeric ID for the logical partition running the task procedure. Directed procedures run on each logical partition. Multi-partition procedures run on the multi-partition initiator. TASK_NAME - The name of the task. TASK_STATUS - The current status of the task. Possible values include: RUNNING - The task is enabled and running normally; DISABLED - The task is disabled and not running. ERROR - The task returned an error and was stopped due to the ON ERROR STOP attribute. PAUSED - The database is paused or is running on a DR replica, so the task is not currently running but will restart when the database resumes or is promoted. TASK_ORIGIN - "System" or "User". TASK_SCOPE - The execution scope of the task, which matches the RUN ON attribute. Possible values are "Database", "Hosts", or "Partitions".
voltdb_scheduler_procedure_execution_time_seconds	Histogram	The distribution of time the task took to execute.
voltdb_scheduler_procedure_failure_total	Counter	The number of times the procedure generated an error when run.Tags: same as above.
voltdb_scheduler_procedure_invocation_total	Counter	The total number of invocations of the task's procedure.
voltdb_scheduler_procedure_wait_time_seconds	Histogram	The distribution of time between when the procedure was scheduled to run and when it was invoked.
voltdb_scheduler_task_execution_time_seconds	Histogram	The distribution of the amount of time taken to schedule an instance of the task.
voltdb_scheduler_task_invocation_total	Counter	The total number of invocations of the task's schedule.
voltdb_scheduler_task_wait_time_seconds	Histogram	The distribution of the difference between when the task was scheduled to run and when the scheduler was invoked.
voltdb_task_priority_queue_depth_total	Gauge	The number of tasks in the queue.
voltdb_task_priority_queue_poll_count_total	Counter	The number of tasks that left the queue.
voltdb_task_priority_queue_wait_time_seconds	Histogram	The distribution of the length of time tasks were waiting in the queue.
voltdb_task_queue_depth_total	Gauge	The number of tasks in the queue.
voltdb_task_queue_poll_count_total	Counter	The number of tasks that left the queue (and started executing) in the past five seconds.
voltdb_task_queue_wait_time_seconds	Histogram	The distribution of time tasks were waiting in the queue.

table of contents