Hitachi VSP OpCenter Detailview

Introduction

The Hitachi Operations Center Analyzer detail view (Analyzer detail view) database is a high speed, size-optimized NoSQL database with extremely effective storage and retrieval capabilities. It has the capacity to store time series data with a fine precision for an extended duration, including minute-level data. An expressive, potent, and succinct query language can be used to query this data (MQL). MQL differs from the widely used Structured Query Language because of its distinctive design (SQL).

The Analyzer detail view REST API allows you to build an application around the Analyzer detail view database.

The following diagram shows the architecture of the analyzer detail view REST API server.

Prerequisites

• OpsRamp Classic Gateway 14.0.0 and above.
• OpsRamp NextGen Gateway 14.0.0 and above.
• Note: OpsRamp recommends using the latest Gateway version for full coverage of recent bug fixes, enhancements, etc.

Resource Hierarchy

• Hitachi VSP Storage Array
  • Hitachi VSP Parity Group
  • Hitachi VSP Pool
  • Hitachi VSP LDEV
  • Hitachi VSP Cache
  • Hitachi VSP MPB
  • Hitachi VSP Port
  • Hitachi VSP Tier LDEV
  • Hitachi VSP MP
  • Hitachi VSP MPB CLPR

Supported Metrics

Default Monitoring Configurations

Hitachi VSP OpCenter Detailview has default Global Device Management Policies, Global Templates, Global Monitors and Global Metrics in OpsRamp. You can customize these default monitoring configurations as per your business requirement by cloning respective Global Templates and Global Device Management Policies. It is recommended to clone them before installing the application to avoid noise alerts and data.

1. Default Global Device Management Policies

   You can find the Device Management Policy for each Native Type at Setup > Resources > Device Management Policies. Search with suggested names in global scope:

   {appName nativeType - version}

   Ex: hitachi-vsp-opscenter-detailview Hitachi VSP Port - 1 (i.e, appName = hitachi-vsp-opscenter-detailview, nativeType = Hitachi VSP Port, version = 1)

2. Default Global Templates

   You can find the Global Templates for each Native Type at Setup > Monitoring > Templates. Search with suggested names in global scope. Each template adheres to the following naming convention:

   {appName nativeType 'Template' - version}

   Ex: hitachi-vsp-opscenter-detailview Hitachi VSP Port Template - 1 (i.e, appName = hitachi-vsp-opscenter-detailview, nativeType = Hitachi VSP Port, version = 1)

3. Default Global Monitors available

   You can find the Global Monitors for each Native Type at Setup > Monitoring > Monitors. Search with suggested names in global scope. Each Monitors adheres to the following naming convention:

   {monitorKey appName nativeType - version}

   Ex: Hitachi VSP Port Monitor hitachi-vsp-opscenter-detailview Hitachi VSP Port 1 (i.e, monitorKey = Hitachi VSP Port Monitor Monitor, appName = hitachi-vsp-opscenter-detailview, nativeType = Hitachi VSP Port, version = 1)

Configure and Install the Hitachi VSP OpCenter Detailview Integration

1. From All Clients, select a client.
2. Go to Setup > Account.
3. Select the Integrations and Apps tab.
4. The Installed Integrations page, where all the installed applications are displayed.
   Note: If there are no installed applications, it will navigate to the Available Integrations and Apps page.
5. Click + ADD on the Installed Integrations page. The Available Integrations and Apps page displays all the available applications along with the newly created application with the version.
   Note: You can even search for the application using the search option available. Also you can use the All Categories option to search.

6. Click ADD in the Hitachi VSP Opcenter Detailview tile.
7. In the Configuration page, click + ADD. The Add Configuration page appears.
8. Enter the below mentioned BASIC INFORMATION:

Notes:

• By default the Is Secure checkbox is selected.
• Ip Address/Host Name and Port should be accessible from Gateway.
• Select App Failure Notifications: if turned on, you will be notified in case of an application failure that is, Connectivity Exception, Authentication Exception.

9. Select the below mentioned CUSTOM ATTRIBUTE:

Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).

10. In the RESOURCE TYPE section, select:
    • ALL: All the existing and future resources will be discovered.
    • SELECT: You can select one or multiple resources to be discovered.
11. In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:
    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
12. Click ADD.

Now the configuration is saved and displayed on the configurations page after you save it.
Note: From the same page, you may Edit and Remove the created configuration.

13. Under the ADVANCED SETTINGS, Select the Bypass Resource Reconciliation option, if you wish to bypass resource reconciliation when encountering the same resources discovered by multiple applications.

    Note: If two different applications provide identical discovery attributes, two separate resources will be generated with those respective attributes from the individual discoveries.

14. Click NEXT.

15. (Optional) Click +ADD to create a new collector by providing a name or use the pre-populated name.

16. Select an existing registered profile.

17. Click FINISH.

The application is installed and displayed on the INSTALLED INTEGRATION page. Use the search field to find the installed integration.

Modify the Configuration

• See Modify an Installed Integration or Application article.

  Note: Select the Hitachi VSP Opcenter Detailview application.

View the Hitachi VSP Opcenter Detailview details

The discovered resource(s) are displayed in Infrastructure > Resources > Hitachi VSP, with Native Resource Type as Hitachi VSP Storage Array. You can navigate to the Attributes tab to view the discovery details, and the Metrics tab to view the metric details for Hitachi VSP.

Supported Alert Custom Macros

Customize the alert subject and description with below macros then it will generate alert based on customisation.
Supported macros keys:

Risks, Limitations & Assumptions

• Application can handle Critical/Recovery failure notifications for below two cases when user enables App Failure Notifications in configuration
  • Connectivity Exception
  • Authentication Exception
• If App Failure Notifications are enabled, an alert will be sent, however, either OpsCenter Detailview Gateway IP Address configurations or OpsCenter Detailview Manager IP Address configurations should be provided.
• Application will send any duplicate/repeat failure alert notification for every 6 hours.
• Application cannot control monitoring pause/resume actions based on above alerts Metrics can be used to monitor OpsCenter Detailview resources and can generate alerts based on the threshold values.
• OpsCenter Detailview Event/Alert polling will start only if the user enables Alert Polling in configuration. Possible values of Alert Severity Filter configuration property are ALERT_LOW,ALERT_MEDIUM,ALERT_HIGH.
• OpsRamp has given sample mappings to map OpsCenter Detailview Severity with OpsRamp Severities as part of Alert Severity Mapping configuration file. Users can modify them as per their use-case at any point of time from the application configuration page. Possible OpsRamp Severities are Critical, Warning, Ok, Info.
• In OpsCenter Detailview, few resource names are null. For them, we are mapping id as resource name.
• Support for Macro replacement for threshold breach alerts (i.e, customisation for threshold breach alert’s subject, description).
• Component level thresholds can be configured on each resource level.
• No support of showing activity logs.
• The Template Applied Time will only be displayed if the collector profile (Classic and NextGen Gateway) is version 18.1.0 or higher.
• Support for the option to get Latest snapshot metric.

Troubleshooting

Before troubleshooting Hitachi VSP DetailView integration issues, ensure that all prerequisites and limitations are cross-checked as per the setup guidelines.

If the Hitachi VSP DetailView integration fails to discover or monitor resources, follow these troubleshooting steps:

• Inspect if any alerts have been generated on the VSP resource, the gateway, or if any error logs are present in the vprobe.

• If the alert/error is related to connectivity or authentication, check the reachability of the end device from the gateway:

  • Use the ping command to check the device’s IP address:

    ping <IP Address>
    

  • Use the telnet command to check connectivity to the specific port:

    telnet <IP Address> <port>
    

• In some cases, the DetailView APIs may not return data for the last 15 minutes due to internal issues. When running curl commands, ensure that you use the last 15-minute UTC timestamp to fetch accurate data.

• Follow the steps in SDK App Debug GCLI Command Requests (Target API / SSH Command) and check for any errors during execution.

1. Use the following sample request to prepare the request payload:

   {
     "apiVersion": "debug/v1",
     "module": "Debug",
     "app": "hitachi-vsp-opscenter-detailview",
     "action": "Reachability",
     "payload": {
       "protocol": "<http (or) https>",
       "ipAddressOrHostName": "<ipAddressOrHostName>",
       "port": "<port>",
       "tokenApiport": "<port of the token API>",
       "accessToken": "<base64 decode of username and password>",
       "userName": "<Username>",
       "password": "<Password>",
       "requestBody": "<RequestBody mentioned in the table below>",
       "requestMethod": "<POST (or) GET mentioned in the table below>",
       "authenticationType": "<Access Token (or) Bearer>"
     }
   }
   

2. Encode the request payload to Base64 format.
3. Login to the gateway console and connect to the GCLI terminal using the following command:

gcli

4. Execute the command by replacing the <base64 encoded string> with the Base64-encoded request payload generated in Step 2:

sdkappdebug base64 encoded string

Refer to the following table for preparing the request payload for the REST API:

Native Type	Discovery	Monitoring
Hitachi VSP Storage Array	v1/cluster/me	internal/stats/runway_remaining internal/stats/system_storage internal/stats/physical_ingest/time_series internal/cluster/me/system_status v1/job_monitoring/summary_by_job_type?job_monitoring_state=Success v1/job_monitoring/summary_by_job_type?job_monitoring_state=Failure v1/job_monitoring/summary_by_job_type?job_monitoring_state=Canceled v1/job_monitoring/summary_by_job_type?job_monitoring_state=Active v1/host internal/cluster/me/io_stats?range=-5min internal/report?report_type=Canned&report_template=ProtectionTasksDetails
Hitachi VSP Parity Group		internal/cluster/me/node internal/node/{node_id}/io_stats?range=-5min
Hitachi VSP Pool		internal/cluster/me/disk
Event Polling	-	v1/event/latest?order_by_time=desc&before_date={from_date}&after_date={to_date}&event_series_status=Failure

For example, to verify the Hitachi VSP Storage Array Discovery, use the following payload:

json
{
  "apiVersion": "debug/v1",
  "module": "Debug",
  "app": "hitachi-vsp-opscenter-detailview",
  "action": "Reachability",
  "payload": {
    "protocol": "https",
    "ipAddressOrHostName": "192.168.180.211",
    "port": "443",
    "tokenApiport": "8443",
    "accessToken": "",
    "userName": "admin",
    "password": "test",
    "requestBody": "{\"query\":\"raidStorage[=serialNumber rx %s][=modelName rx .*][=vendorName rx .*]/raidAgentInstance[=instanceName rx .*][=hostName rx .*][=raHost rx .*]\",\"startTime\":\"20240503_100000\",\"endTime\":\"20240503_110000\"}",
    "requestMethod": "POST",
    "authenticationType": "Access Token"
  }
}

Version History