This page lists the metrics collected by the Commvault integration and describes the default monitoring configuration applied when the integration is installed.Use this information to understand what is monitored out-of-the-box and how to customize thresholds, templates, and alert behaviour for your environment.
Supported Metrics
The metrics collected by the integration are grouped into logical categories based on the monitored component type. Each category is represented as a tabbed table that displays the native type, metric names, display labels, units, supported versions, and descriptions.
| Native Type | Metric Name | Display Name | Units | Version | Description | Metric Group |
|---|---|---|---|---|---|---|
| CommServer | commvault_server_LicenseExpiryDaysRemain | Commvault Server License Expire Days Remain | Days | 1.0.0 | Returns number of Days remained for the license expiry of commvault | |
| commvault_storage_disk_Status | Commvault Storage Disk Status | NA | 1.0.0 | Return the status of the storage disk.Possible states are OFFLINE(0), ONLINE(1) and OTHER(2) | ||
| commvault_server_job_Status | Commvault Server Job Status | NA | 3.0.0 | The status of the job.Possible values are Running(0), Waiting(1), Pending(2), Suspend(3), Suspended(4), Kill Pending(5), Interrupt Pending(6), Interrupted(7), Queued(8), Running (cannot be verified)(9), Abnormal Terminated Cleanup(10), Completed(11), Completed w/ one or more errors(12), Completed w/ one or more warnings(13), Completed(14), Committed(15), Failed(16), Failed to Start(17), Killed(18) | ||
| commvault_job_Status | Commvault Job Status | NA | 3.0.0 | The status of the job.Possible values are Running(0), Waiting(1), Pending(2), Suspend(3), Suspended(4), Kill Pending(5), Interrupt Pending(6), Interrupted(7), Queued(8), Running (cannot be verified)(9), Abnormal Terminated Cleanup(10), Completed(11), Completed w/ one or more errors(12), Completed w/ one or more warnings(13), Completed(14), Committed(15), Failed(16), Failed to Start(17), Killed(18) | ||
| commvault_server_vm_Status | Commvault Server Virtual Machine Status | NA | 4.0.0 | The status of the virtual machine. Possible values are PROTECTED(0) NOT_PROTECTED(1) PARTIALLY_PROTECTED(2) DISABLED(3) DELETED(4) | - | |
| commvault_server_vm_BackupStatus | Commvault Server Virtual Machine Backup Status | NA | 4.0.0 | The back up status of the virtual machine. Possible values are COMPLETED(0) COMPLETED_WITH_ERRORS(1) FAILED(2) KILLED(3) DELAYED(4) RUNNING(5) FAILED_TO_START(6) N/A(7) | - | |
| Native Type | Metric Name | Display Name | Units | Version | Description | Metric Group |
|---|---|---|---|---|---|---|
| CommServer | commvault_storage_disk_Capacity | Commvault Storage Disk Capacity | GB | 1.0.0 | Returns the capacity of storage disk. | |
| commvault_server_vm_Size | Commvault Server Virtual Machine Size | GB | 4.0.0 | The total size of the virtual machine including all disks. |
| Native Type | Metric Name | Display Name | Units | Version | Description | Metric Group | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| CommServer | commvault_server_ApiStatistics | Commvault Server API Statistics | NA | 1.0.0 | Returns number of API calls made for each monitoring poll for each native type. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| commvault_server_JobResultsRetentionDays | Commvault Server Job Result Retention Days | Days | 1.0.0 | Commvault Server Job Result Retention Days | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| commvault_server_IsExcludedFromSLA | Commvault Server IsExcludedFromSLA | NA | 1.0.0 | Returns true if a server is excluded from SLA otherwise false. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| commvault_server_SLACopyFallenBehindDays | Commvault Server SLA Copy Fallen Behind Days | Days | 1.0.0 | Commvault Server SLA Copy Fallen Behind Days. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Native Type | Metric Name | Display Name | Units | Version | Description | Metric Group | Performance | commvault_job_FailedFolders | Commvault Job Failed Folders Count | count | 1.0.0 | The total number of folders that failed during the job. |
|---|---|---|---|---|---|---|
| commvault_job_FailedFiles | Commvault Job Failed Files Count | count | 1.0.0 | The total number of files that failed during the job. | ||
| commvault_job_TotalFiles | Commvault Job Total Files Count | count | 1.0.0 | The total number of files processed during the job. | ||
| commvault_job_DaysSinceLastUpdate | Commvault Job Last Updated Time | Days | 1.0.0 | The date and time the job was last updated. | ||
| commvault_job_PercentageSavings | Commvault Job Percentage Savings | % | 1.0.0 | The percentage of space saved due to deduplication and compression, if employed. | ||
| commvault_job_ElapsedTime | Commvault Job Elapsed Time | s | 1.0.0 | The time in seconds that the job ran. | ||
| commvault_job_PercentageComplete | Commvault Job Percentage Complete | % | 1.0.0 | The progress of the job shown as a percentage. | ||
| commvault_job_CurrentThroughput | Commvault Job Current ThroughPut | MBps | 1.0.0 | Commvault Job Current ThroughPut. | ||
| commvault_job_AverageThroughput | Commvault Job Average ThroughPut | MBps | 1.0.0 | Commvault Job Average ThroughPut. | ||
| commvault_server_job_FailedFolders | Commvault Server Job Failed Folders Count | count | 1.0.0 | Commvault Server Job Failed Folders Count. | ||
| commvault_server_job_FailedFiles | Commvault Server Job Failed Files Count | count | 1.0.0 | Commvault Server Job Failed Files Count. | ||
| commvault_server_job_PercentageSavings | Commvault Server Job Percentage Savings | % | 1.0.0 | Commvault Server Job Percentage Savings. | ||
| commvault_server_job_CurrentThroughput | Commvault Server Job Current ThroughPut | 1.0.0 | Commvault Server Job Current ThroughPut. | |||
| commvault_server_job_CurrentThroughput | Commvault Server Job Current ThroughPut | 1.0.0 | Commvault Server Job Current ThroughPut. | |||
| commvault_server_job_TotalFiles | Commvault Server Job Total Files Count | count | 1.0.0 | Commvault Server Job Total Files Count. |
| Native Type | Metric Name | Display Name | Units | Version | Description | Metric Group |
|---|---|---|---|---|---|---|
| CommServer | commvault_server_job_FailedFolders | Commvault Server Job Failed Folders Count | count | 3.0.0 | The total number of folders that failed during the job. | |
| commvault_server_job_FailedFiles | Commvault Server Job Failed Files Count | count | 3.0.0 | The total number of files that failed during the job. | ||
| commvault_server_job_TotalFiles | Commvault Server Job Total Files Count | count | The total number of files processed during the job. | |||
| commvault_server_job_DaysSinceLastUpdate | Commvault Server Job Last Updated Time | Days | 3.0.0 | The date and time the job was last updated. | ||
| commvault_server_job_PercentageSavings | Commvault Server Job Percentage Savings | % | 3.0.0 | The percentage of space saved due to deduplication and compression, if employed. | ||
| commvault_server_job_ElapsedTime | Commvault Server Job Elapsed Time | s | 3.0.0 | The time in seconds that the job ran. | ||
| commvault_server_job_PercentageComplete | Commvault Server Job Percentage Complete | % | The progress of the job shown as a percentage. | |||
| commvault_server_job_CurrentThroughput | Commvault Server Job Current ThroughPut | MBps | 3.0.0 | Commvault Server Job Current ThroughPut. | ||
| commvault_server_job_AverageThroughput | Commvault Server Job Average ThroughPut | MBps | 3.0.0 | Commvault Server Job Average ThroughPut. | ||
| commvault_server_job_Summary | Commvault Server Job Summary | count | 4.0.0 | The total number of jobs Failed jobs completed jobs on the CommServer. | ||
| commvault_server_backup_job_Summary | Commvault Server Backup Job Summary | count | 4.0.0 | The total number of backup jobs Failed and completed on the CommServer. | ||
| commvault_server_RetentionForCritical | Commvault Retention Policy Critical Count | count | 4.0.0 | The count of retention policies with critical priority. | ||
| commvault_server_RetentionForHigh | Commvault Retention Policy High Count | count | 4.0.0 | The count of retention policies with high priority. | ||
| commvault_server_RetentionForMedium | Commvault Retention Policy Medium Count | count | 4.0.0 | The count of retention policies with medium priority. | ||
| commvault_server_RetentionForLow | Commvault Retention Policy Low Count | count | 4.0.0 | The count of retention policies with low priority. | ||
| commvault_server_UserLaptopCount | Commvault Server User Laptop Count | count | 4.0.0 | The total number of user laptops registered with the CommServer. | ||
| commvault_server_vm_LastBackupTime | Commvault Server Virtual Machine Last Backup Time | Days | 4.0.0 | The number of days since the last successful backup of the virtual machine. | ||
| Client | commvault_job_Summary | Commvault Job Summary | count | 4.0.0 | The total number of jobs (failed and completed) on the CommServer. | |
| commvault_backup_job_Summary | Commvault Backup Job Summary | count | 4.0.0 | The total number of backup jobs (failed and completed) on the CommServer. |
| Native Type | Metric Name | Display Name | Units | Version | Description | Metric Group |
|---|---|---|---|---|---|---|
| CommServer | commvault_storage_disk_FreeSpace | Commvault Storage Disk FreeSpace | GB | 1.0.0 | Returns the freespace on storage disk. | |
| commvault_storage_disk_Utilization | Commvault Storage Disk Utilization | % | 1.0.0 | Returns the utilization of storage disk. | ||
| commvault_server_job_MediaDiskSize | Commvault Server Job Media Disk Size | Bytes | 3.0.0 | Size of the data stored on the media. This is the size of the data after deduplication and compression, if employed. This amount also includes metadata information, so in some cases, it could be larger than the actual size of the backed up data. |
Default monitoring configurations
Commvualt provides default monitoring components that include:
- Global Device Management Policies
- Global Templates
- Global Monitors
These configurations are applied automatically upon installation. Customize them for your environment by cloning the global versions and modifying thresholds or alerting behaviour.
It is recommended to apply this customization prior to installing the application to prevent unnecessary alerts and reduce noise
Default Global Device Management Policies available
OpsRamp will have a Global Device Management Policy for each Native Type of COMMVAULT. Find those Device Management Policies at Setup -> Resources -> Device Management Policies -> Search with suggested names in global scope. Each Device Management Policy follows below naming convention.{appName nativeType - version}
Ex : commvault Client - 1 (i.e, appName = commvault, nativeType = Client, version = 1)
Default Global Templates available
OpsRamp will have a Global template for each Native Type of COMMVAULT. Find those templates at Setup -> Monitoring -> Templates -> Search with suggested names in global scope. Each template follows below naming convention.{appName nativeType 'Template' - version}
Ex : commvault Client Template - 1 (i.e, appName = commvault, nativeType = Client, version = 1)
Default Global Monitors available
OpsRamp will have a Global Monitors for each Native Type which has monitoring support. Find those monitors at Setup -> Monitoring -> Monitors -> Search with suggested names in global scope. Each Monitors follows below naming convention.{monitorKey appName nativeType - version}
Ex : Client Monitor commvault Client 1(i.e, monitorKey = Client , appName = commvault, nativeType = Client , version = 1)