Metrics

VoltSP pipelines expose metrics that can be scraped by Prometheus and visualized with Grafana dashboards. When deploying with Helm, enable Prometheus scraping for a pipeline with:

$ helm upgrade pipeline1 voltdb/volt-streams   \
    --reuse-values                             \
    --set monitoring.prometheus.enabled=true

For a fuller observability stack, VoltSP also provides a standalone Management Console chart. It bundles Prometheus for scraping metrics from pods, Grafana with pre-made dashboards, Loki for log processing, and optional Pyroscope profiling.

$ helm install mc voltdb/management-console

You can also enable the Management Console together with a pipeline by setting management-console.enabled=true, but that starts separate Grafana, Loki, and Prometheus pods for that release. For more than one pipeline, use the standalone Management Console chart.

Built-in metrics

Metric enum: org.voltdb.stream.execution.metric.BaseMetric

Prometheus name	Type	Description
voltsp_cpu_available_total	gauge	Number of CPUs available to the JVM.
voltsp_cpu_load_os_percent	gauge	CPU load percentage reported by the operating system.
voltsp_cpu_load_percent	gauge	CPU load percentage reported by the runtime.
voltsp_cpu_load_process_percent	gauge	CPU load percentage consumed by the JVM process.
voltsp_disk_swap_space_free_bytes	gauge	Free swap space reported by the operating system.
voltsp_disk_swap_space_total_bytes	gauge	Total swap space reported by the operating system.
voltsp_file_descriptors_limit_total	gauge	Maximum number of file descriptors available to the process.
voltsp_file_descriptors_open_total	gauge	Number of file descriptors currently open by the process.
voltsp_memory_java_heap_max_bytes	gauge	Maximum Java heap memory available to the JVM.
voltsp_memory_java_heap_used_bytes	gauge	Java heap memory currently used by the JVM.
voltsp_memory_java_nonheap_used_bytes	gauge	Java non-heap memory currently used by the JVM.
voltsp_memory_size_committed_bytes	gauge	Committed virtual memory used by the JVM process.
voltsp_memory_size_free_bytes	gauge	Free physical memory reported by the operating system.
voltsp_memory_size_total_bytes	gauge	Total physical memory reported by the operating system.
voltsp_stage_activity_info	gauge	Current activity marker for a pipeline stage.
voltsp_collected_total	counter	Number of records collected by a sink or downstream component.
voltsp_emitted_total	counter	Number of records emitted by a source or upstream component.
voltsp_error_total	counter	Number of unhandled errors recorded by VoltSP.
voltsp_gc_count_total	counter	Number of garbage collection events reported by the JVM.
voltsp_gc_time_seconds	counter	Total garbage collection time reported by the JVM.
voltsp_stage_failure_total	counter	Number of failures recorded while executing a pipeline stage.
voltsp_event_processing_time_seconds	histogram	Time spent processing individual events.
voltsp_stage_execution_time_seconds	histogram	Time spent executing a pipeline stage.
voltsp_configuration_info	info	Configuration metadata for the running VoltSP pipeline. Tags: system_properties: Filtered JVM and system properties.
voltsp_general_info	info	General runtime metadata for the VoltSP instance. Tags: build_time: VoltSP build timestamp. commit_id: Source control commit id. start_time: VoltSP process start timestamp. version: VoltSP version.
voltsp_license_info	info	License metadata reported by the running VoltSP instance. Tags: license_expiration_to_epoch: License expiration time as an epoch timestamp. license_licensee: Licensed customer or entity. license_streaming_feature: Whether the streaming license feature is enabled. license_type: License type.
voltsp_node_graph_edges_info	info	Node graph edge metadata describing connections between pipeline nodes. Tags: id: Node or edge identifier. source: Source component name. target: Target node or external resource identifier.
voltsp_node_graph_info	info	Node graph metadata describing the running pipeline topology. Tags: color: Visualization color. icon: Visualization icon. id: Node or edge identifier. title: Display title for a node.
voltsp_stream_sink_info	info	Metadata describing stream sink configuration. Tags: sink: Sink component name. sink_target: External sink target or destination.
voltsp_stream_source_info	info	Metadata describing stream source configuration. Tags: source: Source component name.
voltsp_unknown_	info	Fallback metric used when a metric id cannot be resolved.

Built-in tags

Tag enum: org.voltdb.stream.execution.metric.BaseTag

Metrics reported by this component may include these tags. Not every metric includes every tag; tags are present only when they are relevant to the measurement.

Tag	Description
emitter	Emitter component name or trigger.
function	Function or operator name.
gc_type	JVM garbage collector name.
host_name	Host name attached as a global metric tag.
name	Logical stream or component name.
pipeline	Pipeline name attached as a global metric tag.
stage	Stream stage name.
subtitle	Display subtitle for a node.
unknown	Fallback tag used when a tag id cannot be resolved.
worker	Worker thread or worker instance identifier.