# Exported Prometheus Metrics ## Metrics This page describes the metrics provided by the Trilio Metrics Exporter that can be consumed by Prometheus. You will find detailed information about the tags and values associated with each metric along with examples of the output you will see from each metric. **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\_backupplan\_crstatus**\ description: this metric provides detail about continuousRestore site status for backupPlan\ tags: backupplan, cluster, continuousrestore\_enabled, continuousrestoreinstance, continuousrestoreplan, consistentset\_count, cr\_status\ value: 1 (Available/Completed) or 0 (InProgress) or -1 (Failed/Error) ``` # HELP trilio_backupplan_crstatus BackupPlan ContinuousRestore Info # TYPE trilio_backupplan_crstatus gauge trilio_backupplan_crstatus{backupplan="appbackupplan1",cluster="kops-gocoverage",consistentset_count="1",continuousrestore_enabled="true",continuousrestoreinstance="930936bc-cc93-488d-a21c-3306499da0ae",continuousrestoreplan="crp-d303bb96-fd9e-4bd1-b909-c2313a37fbe9-0e62ae31-29ec-45cb-8aa4-8ee1b5878438",cr_status="Available",kind="BackupPlan"} 1 ``` **trilio\_continuousrestoreplan\_info**\ description: this metric provide detail about ContinuousRestorePlan CRD\ tags: consistentset count, continuousrestore plan, continuousrestore policy, creation timestamp, install namespace, kind, source backupplan, source instanceinfo,cluster, status, target\ value: 1 (Available/Completed) or 0 (InProgress) or -1 (Failed/Error) ``` # HELP trilio_continuousrestoreplan_info ContinuousRestorePlan Info # TYPE trilio_continuousrestoreplan_info gauge trilio_continuousrestoreplan_info{cluster="kops-gocoverage",consistentsetcount="1",continuousrestoreplan="crp-d303bb96-fd9e-4bd1-b909-c2313a37fbe9-e63f2047-ce03-4c0d-92bf-9e446cde520e",continuousrestorepolicy="d303bb96-fd9e-4bd1-b909-c2313a37fbe9-01cec464-75dc-4426-9958-a525efb1559a",creation_ts="2023-02-21 15:56:18 +0530 IST",install_namespace="trilio-system",kind="ContinuousRestorePlan",sourcebackupplan="mulitsite-multins-s3-bp",sourceinstanceinfo="tvk-instance-src",status="Available",target="d303bb96-fd9e-4bd1-b909-c2313a37fbe9-c985b932-9d92-4ab0-b700-4f1a2712a2a7"} 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\_consistentset\_info**\ description: this metric provide detail about ConsistentSet CRD.\ tags: consistentset, consistentsetscope, continuousrestoreplan, completion\_ts, start\_ts, size, backupName, backupNamespace, backupSize, backupStatus, sourcebackupplan, sourceinstanceinfo, cluster, install\_namespace, kind, status\ value: 1 (Available/Completed) or 0 (InProgress) or -1 (Failed/Error) -2(UnKnown)\\ ``` # HELP trilio_consistentset_info ConsistentSet Info # TYPE trilio_consistentset_info gauge trilio_consistentset_info{backupName="multi-ns-mulitsite-multin-61db11e0-4b7f-46c3-8b94-ced253538d9a",backupNamespace="shruti",backupSize="2212597665",backupStatus="Available",cluster="kops-gocoverage",completion_ts="2023-02-21 17:34:13 +0530 IST",consistentset="cs-d303bb96-fd9e-4bd1-b909-c2313a37fbe9-11010fc9-16a1-407c-889d-fdae8f11b5a0",consistentsetscope="Cluster",continuousrestoreplan="crp-d303bb96-fd9e-4bd1-b909-c2313a37fbe9-e63f2047-ce03-4c0d-92bf-9e446cde520e",install_namespace="trilio-system",kind="ConsistentSet",size="2233542838",sourcebackupplan="mulitsite-multins-s3-bp",sourceinstanceinfo="tvk-instance-src",start_ts="2023-02-21 17:25:24 +0530 IST",status="Available"} 1 ``` **trilio\_consistentset\_status\_percentage**\ description: this metric provide detail about ConsistentSet and its percentage status\ tags: consistentset, consistentset scope, continuousrestore plan, start timestamp, completion timestamp, backupName, source backupplan, source instanceinfo, cluster, install namespace, kind, status\ value: status percentage ``` # HELP trilio_consistentset_status_percentage ConsistentSet Status Percentage # TYPE trilio_consistentset_status_percentage gauge trilio_consistentset_status_percentage{backupName="multi-ns-mulitsite-multin-61db11e0-4b7f-46c3-8b94-ced253538d9a",cluster="kops-gocoverage",completion_ts="2023-02-21 17:34:13 +0530 IST",consistentset="cs-d303bb96-fd9e-4bd1-b909-c2313a37fbe9-11010fc9-16a1-407c-889d-fdae8f11b5a0",consistentsetscope="Cluster",continuousrestoreplan="crp-d303bb96-fd9e-4bd1-b909-c2313a37fbe9-e63f2047-ce03-4c0d-92bf-9e446cde520e",install_namespace="trilio-system",kind="ConsistentSet",sourcebackupplan="mulitsite-multins-s3-bp",sourceinstanceinfo="tvk-instance-src",start_ts="2023-02-21 17:25:24 +0530 IST",status="Available"} 100 ``` **trilio\_consistentset\_completed\_duration**\ description: this metric provide detail about consistentSet that are in Completed state with its duration taken.\ tags: backupName, start timestamp completion timestamp, consistentset, consistentset scope, continuousrestore plan, install namespace, kind, source backupplan, source instanceinfo, cluster, status\ value: duration in minutes ``` # HELP trilio_consistentset_completed_duration ConsistentSet Completed Duration # TYPE trilio_consistentset_completed_duration gauge trilio_consistentset_completed_duration{backupName="multi-ns-mulitsite-multin-61db11e0-4b7f-46c3-8b94-ced253538d9a",cluster="kops-gocoverage",completion_ts="2023-02-21 17:34:13 +0530 IST",consistentset="cs-d303bb96-fd9e-4bd1-b909-c2313a37fbe9-11010fc9-16a1-407c-889d-fdae8f11b5a0",consistentsetscope="Cluster",continuousrestoreplan="crp-d303bb96-fd9e-4bd1-b909-c2313a37fbe9-e63f2047-ce03-4c0d-92bf-9e446cde520e",install_namespace="trilio-system",kind="ConsistentSet",sourcebackupplan="mulitsite-multins-s3-bp",sourceinstanceinfo="tvk-instance-src",start_ts="2023-02-21 17:25:24 +0530 IST",status="Available"} 8 ``` **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* | T4K Installation Scope | "Namespaced" | | *deployment* | T4K 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" |