Prometheus Metrics

This appendix section describes the various metrics along with tags and values that are provided with TrilioVault for Kubernetes.

Below are metrics included in trilio exporter which are exposed to the Prometheus server. Each metric has additional and related information for each resource in the form of tags and has a value. Check given sample for more detail.

trilio_backupplan_info description: this metric provide detail about BackupPlan CRD tags: applicationtype, backup_count, backupplan, cluster, creation_ts, lastprotected, namespace, protected, status, target value: 1 (Available/Completed) or 0 (InProgress) or -1 (Failed/Error)

# HELP trilio_backupplan_info BackupPlan Info
# TYPE trilio_backupplan_info gauge
trilio_backupplan_info{applicationtype="Custom",backup_count="1",backupplan="sample-backupplan-custom",cluster="84ccb170-baa2-11ea-96c8-42010a8e0fc9",creation_ts="2020-07-06 15:08:39 +0530 IST",lastprotected="",namespace="triliovault-integration",protected="False",status="Available",target="sample-target"} 1

trilio_target_info description: this metric provide detail about target CRD tags: cluster, creation_ts, namespace, size, status, target, vendor, vendorType value: 1 (Available) or 0 (Unavailable)

# HELP trilio_target_info Target Info
# TYPE trilio_target_info gauge
trilio_target_info{cluster="84ccb170-baa2-11ea-96c8-42010a8e0fc9",creation_ts="2020-07-05 12:16:24 +0530 IST",namespace="triliovault-integration",size="0",status="Available",target="sample-target",vendor="Other",vendorType="NFS"} 1

trilio_target_storage description: this metric provide detail about target CRD storage tags: cluster, creation_ts, namespace, status, target, vendor, vendorType value: storage in bytes

# HELP trilio_target_storage Target Storage Info
# TYPE trilio_target_storage gauge
trilio_target_storage{cluster="84ccb170-baa2-11ea-96c8-42010a8e0fc9",creation_ts="2020-07-05 12:16:24 +0530 IST",namespace="triliovault-integration",status="Available",target="sample-target",vendor="Other",vendorType="NFS"} 0

trilio_backup_info description: this metric provide detail about backup CRD tags: applicationtype, backupplan, backup, cluster, completion_ts, hook, namespace, size, start_ts, status, target value: 1 (Available/Completed) or 0 (InProgress) or -1 (Failed/Error) -2(UnKnown)\

# HELP trilio_backup_info Backup Info
# TYPE trilio_backup_info gauge
trilio_backup_info{applicationtype="Custom",backup="one-backup-1",backupplan="sample-backupplan-custom",cluster="84ccb170-baa2-11ea-96c8-42010a8e0fc9",completion_ts="2020-07-06 16:24:39 +0530 IST",hook="False",namespace="triliovault-integration",size="0",start_ts="2020-07-06 16:23:58 +0530 IST",status="Failed",target="sample-target"} -1

trilio_backup_status_percentage description: this metric provide detail about backup and its percentage status tags: backupplan, backup, cluster, completion_ts, namespace, size, start_ts, status, target value: percentage status

# HELP trilio_backup_status_percentage Backup Status Percentage
# TYPE trilio_backup_status_percentage gauge
trilio_backup_status_percentage{backup="one-backup-1",backupplan="sample-backupplan-custom",cluster="84ccb170-baa2-11ea-96c8-42010a8e0fc9",completion_ts="2020-07-06 16:24:39 +0530 IST",namespace="triliovault-integration",size="0",start_ts="2020-07-06 16:23:58 +0530 IST",status="Failed",target="sample-target"} 6

trilio_backup_completed_duration description: this metric provide detail about backups that are in Available state with its duration taken. tags: backupplan, backup, cluster, completion_ts, namespace, start_ts, status, target value: duration in minutes

# HELP trilio_backup_completed_duration Backup Completed Duration
# TYPE trilio_backup_completed_duration gauge
trilio_backup_completed_duration{backupplan="sample-backupplan-1",backup="sample-backup",cluster="84ccb170-baa2-11ea-96c8-42010a8e0fc9",completion_ts="2020-03-22 12:37:53 +0000 UTC",namespace="triliovault",start_ts="2020-03-22 12:36:01 +0000 UTC",status="Available",target="sample-target"} 1

trilio_backup_storage description: this metric provide detail about backup storage. tags: backupplan, backup, cluster, completion_ts, namespace, start_ts, status, target value: size in bytes

# HELP trilio_backup_storage Backup Storage in bytes
# TYPE trilio_backup_storage gauge
trilio_backup_storage{backup="one-backup-1",backupplan="sample-backupplan-custom",cluster="84ccb170-baa2-11ea-96c8-42010a8e0fc9",completion_ts="2020-07-06 16:24:39 +0530 IST",namespace="triliovault-integration",start_ts="2020-07-06 16:23:58 +0530 IST",status="Failed",target="sample-target"} 0

trilio_backup_metadata_info description: this metric provide detail about backup metadata. tags: apiversion, applicationtype, backup, backupplan, cluster, namespace, objectname, objecttype, status value: count of objects

# HELP trilio_backup_metadata_info Backup Metadata Info
# TYPE trilio_backup_metadata_info gauge
trilio_backup_metadata_info{apiversion="v1",applicationtype="Custom",backup="sample-backup-custom",backupplan="sample-backupplan-custom",cluster="9569dffa-ae3d-11ea-85d3-42010a8e0025",namespace="triliovault-integration",objectname="clusterrole-test",objecttype="ClusterRole",status="Available"} 1 ```

trilio_restore_info description: this metric provide detail about restore CRD. tags: backup, backupplan, cluster, completion_ts, namespace, restore, size, start_ts, status, target value: 1 (Available/Completed) or 0 (InProgress) or -1 (Failed/Error) -2(UnKnown)\

# HELP trilio_restore_info Restore Info
# TYPE trilio_restore_info gauge
trilio_restore_info{backup="sample-backup",backupplan="sample-backupplan-custom",cluster="84ccb170-baa2-11ea-96c8-42010a8e0fc9",completion_ts="2020-07-07 16:58:59 +0530 IST",namespace="triliovault-integration",restore="sample-restore-custom-1",size="0",start_ts="2020-07-07 16:58:44 +0530 IST",status="Failed",target="sample-target"} -1

trilio_restore_status_percentage description: this metric provide detail about backup and its percentage status tags: backup, completion timestamp, cluster, namespace, restore, start timestamp, size, status, target value: status percentage

# HELP trilio_restore_status_percentage Restore Status Percentage
# TYPE trilio_restore_status_percentage gauge
trilio_restore_status_percentage{backup="sample-backup",cluster="84ccb170-baa2-11ea-96c8-42010a8e0fc9",completion_ts="2020-07-07 16:58:59 +0530 IST",namespace="triliovault-integration",restore="sample-restore-custom-1",size="0",start_ts="2020-07-07 16:58:44 +0530 IST",status="Failed",target="sample-target"} 0

trilio_restore_completed_duration description: this metric provide detail about restore that are in Completed state with its duration taken. tags: backup, completion timestamp, cluster, namespace, restore, start timestamp, status, target value: duration in minutes

# HELP trilio_restore_completed_duration Restore Status Percentage
# TYPE trilio_restore_completed_duration gauge
trilio_restore_completed_duration{backup="db-backup",cluster="84ccb170-baa2-11ea-96c8-42010a8e0fc9",completion_ts="2020-03-24 22:44:50 +0530 IST",namespace="triliovault",restore="cockroachdb-restore",start_ts="2020-03-24 22:42:07 +0530 IST",status="Completed",target="sample-target"} 2

trilio_restore_metadata_info description: this metric provide detail about restore metadata. tags: apiversion, applicationtype, backupplan, cluster, namespace, objectname, objecttype, restore, status value: count of objects

# HELP trilio_restore_metadata_info Restore Metadata Info
# TYPE trilio_restore_metadata_info gauge
trilio_restore_metadata_info{apiversion="v1",applicationtype="Custom",backupplan="sample-backupplan-custom",cluster="9569dffa-ae3d-11ea-85d3-42010a8e0025",namespace="triliovault-integration",objectname="clusterrole-test",objecttype="ClusterRole",restore="sample-restore-custom",status="Failed"} 1

trilio_component_status description: this metric provide detail about all triliovault components with available replicas. tags: cluster, deployment, namespace, status(Ready State) value: available replicas count

# HELP trilio_component_status Trilio Component Status with Ready Replicas
# TYPE trilio_component_status gauge
trilio_component_status{cluster="84ccb170-baa2-11ea-96c8-42010a8e0fc9",deployment="k8s-triliovault-admission-webhook",namespace="triliovault-integration",status="1/1"} 1

trilio_system_info description: this metric provide details about all triliovault installation. tags: cluster, namespace, scope value: 1

# HELP trilio_system_info Trilio System Details
# TYPE trilio_system_info gauge
trilio_system_info{cluster="84ccb170-baa2-11ea-96c8-42010a8e0fc9",namespace="triliovault-integration",scope="Namespaced"}

Glossary

Tag

Description

Sample Value

cluster

Cluster UUID string

"84ccb170-baa2-11ea-96c8-42010a8e0fc9"

namespace

Resource Namespace

"triliovault-integration"

scope

TVK Installation Scope

"Namespaced"

deployment

TVK Component Deployment Name

"k8s-triliovault-exporter"

status

Component Status code: 1 (Available/Completed) 0 (InProgress) -1 (Failed/Error) -2 (UnKnown)

"-1"

applicationtype

We divide application into three groups: Helm, Operator, Custom on basis of BackupPlan

"Helm"

backup_count

Number of backups under given BackupPlan

"2"

backupplan

Name of Backup Plan

"sample-backupplan"

creation_ts

Resource Creation TImestamp

"2020-07-07 16:58:44 +0530 IST"

start_ts

Resource Start Timestamp

"2020-07-07 16:58:44 +0530 IST"

completion_ts

Resource Completion Timestamp

"2020-07-07 16:58:44 +0530 IST"

lastprotected

Last Backup Completion Timestamp for given Backup Plan

"2020-07-07 16:58:44 +0530 IST"

protected

Provide true/false, on whether Backup Plan has any successful Backup

"True"

target

Target Name for respective Backup or Backup Plan

"sample-target"

size

Storage size in bytes

"102400"

vendor

Storage Provider Vendor

"AWS"

vendorType

Type of Storage Used

"S3"

start_ts

Resource Start Timestamp

"2020-07-07 16:58:44 +0530 IST"

hook

Backup Plan Hook Enabled or not

"False"

apiversion

GVK Version for Object under Backup/Restore Metadata

"v1"

objectname

Object Name for Resource under Backup/Restore Metadata

"nginx"

objecttype

Object Type for Resource under Backup/Restore Metadata

"Service"