Skip to content

Commit

Permalink
Updated N2WS tile for Ver 4.0 (DataDog#860)
Browse files Browse the repository at this point in the history
  • Loading branch information
eliadeini authored May 10, 2021
1 parent 42cfb17 commit 0868c9c
Show file tree
Hide file tree
Showing 8 changed files with 45 additions and 27 deletions.
47 changes: 27 additions & 20 deletions n2ws/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

## Overview

N2WS Backup & Recovery (CPM), known as N2WS, is an enterprise-class backup, recovery, and disaster recovery solution for Amazon Web Services (AWS). N2WS uses cloud native technologies (snapshots) to provide backup and restore capabilities in AWS.

N2WS Backup & Recovery (CPM), known as N2WS, is an enterprise-class backup, recovery, and disaster recovery solution for Amazon Web Services (AWS) and Microsoft Azure. N2WS uses cloud native technologies (snapshots) to provide backup and restore capabilities in AWS and Azure.

Your N2WS Backup and Recovery instance supports the monitoring of backups, disaster recovery, copy to S3, alerts,
and more by Datadog monitoring service. This integration allows users to monitor and analyze the N2WS Backup and Recovery Dashboard metrics.
Expand All @@ -11,43 +12,49 @@ and more by Datadog monitoring service. This integration allows users to monitor

### Installation

1. Install the [Python integration][1].
1. ##### Install the [Python Integration][1]

2. Enable support for Datadog on your N2WS instance:
2. ##### Enable support for Datadog on your N2WS instance:
- Connect to your N2WS Backup and Recovery instance with SSH.
- Add the lines below to `/cpmdata/conf/cpmserver.cfg`. You might need `sudo` privileges to perform this action.
```
[external_monitoring]
enabled=True
```
- Run `service apache2 restart`.
- Run ```service apache2 restart```.
3. ##### Install the Datadog Agent on your N2WS Instance.
Login to Datadog and go to Integrations -> Agent -> Ubuntu
Copy the agent ‘easy one-step install’ command
Connect to your N2WS Backup and Recovery Instance with SSH. You may require `sudo` privileges to perform this action.
4. ##### Setup Datadog Dashboard metrics
Go to [‘Metrics-> Explorer’][2]
3. Install the Datadog Agent on your N2WS instance:
- Login to Datadog and navigate to [Integrations -> Agent -> Ubuntu][9].
- Copy the Agent one-step install command.
- Connect to your N2WS Backup and Recovery instance with SSH. You might need `sudo` privileges to perform this action.
**Graph**: Select your metric from the list. All N2WS metrics begin with the string ‘cpm_metric’.
4. Visualize N2WS metrics in Datadog:
- Navigate to [Metrics -> Explorer][2].
- **Graph**: Select your metric from the list. All N2WS metrics begin with the string `cpm_metric`.
- **Over**: Select data from the list. All N2WS user data begins with the string `cpm:user:<USER_NAME>`. You can select a specific user or the entire N2WS instance.
**Over**: Select data from the list. All N2WS users data begin with the string ‘cpm:user:<user-name>’.
You can select either a specific user or the entire N2WS instance.
5. Add N2WS dashboards to your Datadog account:
- Navigate to the [N2WS tile][3] and install the integration.
- Clicking the install button adds the dashboards: `N2WSBackup&Recovery-Graphicalversion`, `N2WSBackup&Recovery-Graphicalversion-areas`, and `N2WSBackup&Recovery-Squaresdashboard`.
- Alternatively, users can [import JSON templates from N2WS][4].
5. ##### Get N2WS dashboards
In [Datadog Integrations][3] , search for 'N2WS' tile and install it.
You will get 5 types of dashboards to your account, 3 for N2WS Backup & Recovery v3.2.1 (only AWS supported) and 2 for for N2WS Backup & Recovery v4.0 (includes Azure):
'N2WSBackup&Recovery-Graphicalversion', 'N2WSBackup&Recovery-Graphicalversion-areas' and 'N2WSBackup&Recovery-EntitiesSpecificDashboard' for version 3.2.1
'N2WSBackup&Recovery-EntitiesSpecificDashboardV4.0' and 'N2WSBackup&Recovery-GraphicalVersionV4.0' for version 4.0
Alternatively users can [import JSON templates from N2WS][4].
## Data Collected
Datadog collects the following data about N2WS Backup & Recovery backups:
- The number of snapshots of each type
- Successful backups
- Failed backups
- Partially successful backups
- Successful backups (AWS only)
- Failed backups (AWS only)
- Partially successful backups (AWS only)
- Protected resources from any type
- Data about volume capacity, alerts, etc.
- Data about volume capacity (AWS only), alerts, etc.
### Metrics
Expand Down

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

12 changes: 7 additions & 5 deletions n2ws/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,20 @@
"categories": [
"cloud"
],
"type": "crawler",
"type": "check",
"is_public": true,
"has_logo": true,
"doc_link": "https://docs.datadoghq.com/integrations/n2ws/",
"integration_id": "n2ws",
"assets": {
"configuration": {},
"dashboards": {
"N2WSBackup&Recovery-EntitiesSpecificDashboard": "assets/dashboards/N2WSBackup&Recovery-EntitiesSpecificDashboard.json",
"N2WSBackup&Recovery-GraphicalVersion": "assets/dashboards/N2WSBackup&Recovery-Graphicalversion.json",
"N2WSBackup&Recovery-GraphicalVersion-Areas": "assets/dashboards/N2WSBackup&Recovery-Graphicalversion-areas.json"
},
"N2WSBackup&Recovery-EntitiesSpecificDashboard": "assets/dashboards/N2WSBackup&Recovery-EntityTypesDetails.json",
"N2WSBackup&Recovery-GraphicalVersion": "assets/dashboards/N2WSBackup&Recovery-BackupSuccessRates(ColumnGraphs).json",
"N2WSBackup&Recovery-GraphicalVersion-Areas": "assets/dashboards/N2WSBackup&Recovery-BackupSuccessRates(AreasGraphs).json",
"N2WSBackup&Recovery-EntitiesSpecificDashboardV4.0": "assets/dashboards/N2WSBackup&RecoveryV4.0-EntityTypesDetails.json",
"N2WSBackup&Recovery-GraphicalVersionV4.0": "assets/dashboards/N2WSBackup&RecoveryV4.0-BackupSuccessRates(ColumnGraphs).json"
},
"metrics_metadata": "metadata.csv",
"monitors": {},
"saved_views": {},
Expand Down
8 changes: 6 additions & 2 deletions n2ws/metadata.csv
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,18 @@ cpm_metric.dashboard_state.snapshots_redshift_num,gauge,,,,Total number of snaps
cpm_metric.dashboard_state.snapshots_rds_clus_num,gauge,,,,Total number of snapshots of Aurora clusters,0,n2ws_backup_recovery,Aurora snapshots
cpm_metric.dashboard_state.snapshots_dr_rds_clus_num,gauge,,,,Total number of DR snapshots of Aurora clusters,0,n2ws_backup_recovery,DR Aurora snapshots
cpm_metric.dashboard_state.snapshots_ddb_num,gauge,,,,Total number of snapshots of DynamoDB,0,n2ws_backup_recovery,DynamoDB snapshots
cpm_metric.dashboard_state.snapshots_efs_num,gauge,,,,Total number of snapshots of EFS file systems,0,n2ws_backup_recovery,EFS snapshots
cpm_metric.dashboard_state.snapshots_efs_num,gauge,,,,Total number of DR snapshots of EFS file systems,0,n2ws_backup_recovery,EFS snapshots
cpm_metric.dashboard_state.snapshots_dr_efs_num,gauge,,,,Total number of snapshots of Azure Disks,0,n2ws_backup_recovery,DR EFS snapshots
cpm_metric.dashboard_state.snapshots_disk_num,gauge,,,,Total number of snapshots of EFS file systems,0,n2ws_backup_recovery,Azure Disks snapshots
cpm_metric.dashboard_state.protected_instances_num,gauge,,,,Total number of protected instances resources,0,n2ws_backup_recovery,Protected instances
cpm_metric.dashboard_state.protected_volumes_num,gauge,,,,Total number of protected volumes resources,0,n2ws_backup_recovery,Protected volumes
cpm_metric.dashboard_state.protected_rds_db_num,gauge,,,,Total number of protected RDS resources,0,n2ws_backup_recovery,Protected RDS
cpm_metric.dashboard_state.protected_ddb_num,gauge,,,,Total number of protected DynamoDB resources,0,n2ws_backup_recovery,Protected DynamoDB
cpm_metric.dashboard_state.protected_efs_num,gauge,,,,Total number of protected EFS resources,0,n2ws_backup_recovery,Protected EFS
cpm_metric.dashboard_state.protected_rds_clus_num,gauge,,,,Total number of protected Aurora resources,0,n2ws_backup_recovery,Protected Aurora
cpm_metric.dashboard_state.protected_redshift_num,gauge,,,,Total number of protected Redshift resources,0,n2ws_backup_recovery,Protected Redshift
cpm_metric.dashboard_state.protected_redshift_num,gauge,,,,Total number of protected Azure Virtual Machines resources,0,n2ws_backup_recovery,Protected Redshift
cpm_metric.dashboard_state.protected_virtual_machines_num,gauge,,,,Total number of protected Redshift resources,0,n2ws_backup_recovery,Protected Azure VMs
cpm_metric.dashboard_state.protected_disks_num,gauge,,,,Total number of protected Redshift resources,0,n2ws_backup_recovery,Protected Azure Disks
cpm_metric.dashboard_state.volumes_above_high_watermark_num,gauge,,,,Number of volumes with above high watermark capacity,0,n2ws_backup_recovery,High capcity volumes
cpm_metric.dashboard_state.volumes_below_low_watermark_num,gauge,,,,Number of volumes with below low watermark capacity,0,n2ws_backup_recovery,Low capacity volumes
cpm_metric.dashboard_state.volumes_usage_percentage_num,gauge,,percent,,Total usage of capacity for all volumes of all hosts,0,n2ws_backup_recovery,Volumes capacity percent

0 comments on commit 0868c9c

Please sign in to comment.