VictoriaMetrics

Software pattern summary

The following table gives an overview of the pattern characteristics:

Product component	OS type	Versioning	Pattern depth
VictoriaMetrics	UNIX	Active	Instance-based
VictoriaMetrics vmstorage	UNIX	Active	Instance-based
VictoriaMetrics vminsert	UNIX	Active	Instance-based
VictoriaMetrics vmselect	UNIX	Active	Instance-based
VictoriaMetrics Cluster	UNIX	From SI	Instance-based

Platforms supported by the pattern

The pattern discovers VictoriaMetrics deployments on the UNIX system only.

Software instance triggers

The following table gives details about the pattern trigger:

Pattern	Trigger node	Attribute	Condition	Argument
VictoriaMetricsSingleNode	DiscoveredProcess	cmd	matches	unix_cmd "victoria-metrics-prod"
VMStorage	DiscoveredProcess	cmd	matches	unix_cmd "vmstorage-prod"
VMInsert	DiscoveredProcess	cmd	matches	unix_cmd "vminsert-prod"
VMSelect	DiscoveredProcess	cmd	matches	unix_cmd "vmselect-prod"
VictoriaMetricsCluster	SoftwareInstance	NA	created, confirmed	type = "VictoriaMetrics vminsert"

Software instance type attributes

The pattern in this module sets the following attributes:

Product component	Attributes
VictoriaMetrics	key  = "<si_type>/<host.key>" type = "VictoriaMetrics" name  short_name  version product_version install_root
VictoriaMetrics vmstorage	key  = "<si_type>/<host.key>" type = "VictoriaMetrics vmstorage" name  short_name  version product_version install_root data_path
VictoriaMetrics vminsert	key  = "<si_type>/<host.key>" type = "VictoriaMetrics vminsert" name  short_name  version product_version install_root storage_node_list running_on_k8s
VictoriaMetrics vmselect	key  = "<si_type>/<host.key>" type = "VictoriaMetrics vminsert" name  short_name  version product_version install_root storage_node_list
VictoriaMetrics Cluster	key  = "<si_type>/<host.key>", type = "VictoriaMetrics Cluster" name  short_name  version product_version

Simple identification mappings

The following components are identified by using the simple identity mappings that map the product's known processes:

Name	Command
VictoriaMetrics	unix_cmd "victoria-metrics-prod"
VictoriaMetrics vmstorage	unix_cmd "vmstorage-prod"
VictoriaMetrics vminsert	unix_cmd "vminsert-prod"
VictoriaMetrics vmselect	unix_cmd "vmselect-prod"

Versioning

Version information for each SoftwareInstance is collected by using the active versioning method. The pattern runs the following command:

• '<process_cmd_path>' --version

If the command retrieves results, the version is parsed by using the following regular expressions:

• '(?m)victoria-metrics\S+v(\d+(?:\.\d+)*)'
• '(?m)vmstorage-\S+v(\d+(?:\.\d+)*)'
• '(\/\S+)\/vminsert-prod'
• '(\/\S+)\/vmselect-prod'

SI depth

The VictoriaMetrics patterns create an instance-based software instance for each VictoriaMetrics component and a standalone VictoriaMetrics installation. The second-order SoftwareInstance is modelled, representing VictoriaMetrics Cluster and containing VictoriaMetrics vmstorage, VictoriaMetrics vminsert and VictoriaMetrics vmselect SIs. 

Testing

The pattern has been tested against the available customer data and the local test installation.