Understand the setup and the vRealize Operations Cloud integration v1 limitations and caveats

VMware vRealize Operations Cloud delivers intelligent operations management with application-to-storage visibility across physical, virtual, and cloud infrastructures. Using policy-based automation, operations teams automate key processes and improve the IT efficiency.

The vRealize Operations Cloud integration is a full-featured native integration that offers agentless data ingestion of vRealize Operations Cloud metric data, as well as a predefined dashboard.

How to Register a vRealize Operations Cloud Integration

To register a new vRealize Operations Cloud instance, you need a Cloud Services console API token and a vRealize Operations Cloud endpoint URL.

Obtain an API Token

The API token will give read-only access to vRealize Operations Cloud and enable Tanzu Observability by Wavefront to continually load metrics from various resource categories. The minimum role required for the integration is the vROps ReadOnly role. Make sure that the role assigned to the API token is also assigned to the user generating the API token.

  1. Navigate to the VMware Cloud Services Console page.
  2. Click your user name on the right of the toolbar, and select My Account.
  3. Click the API Tokens tab.
  4. Click the Generate a New API Token button.
  5. Enter a meaningful API token name, for example, wavefront-integration.
  6. Choose to generate a never expiring API Token by selecting never expiring from the drop-down menu showing the Token TTL units of time.

    If you select to generate an API token that will expire after certain period of time, when the API token expires, you will have to configure the service again.

  7. Define the role of the token.

    1. Under Organization Roles, select Organization Member.
    2. Under Service Roles, scroll down, expand VMware vRealize Operations Cloud, and select the vROps ReadOnly role.

      Note: The same vROps ReadOnly role must be also assigned to your user account.

  8. Click the Generate button.
  9. Click the Copy button and copy the generated token.

Set Up the vRealize Operations Cloud Integration

  1. Log in to your Wavefront cluster: https://your-wavefront-cluster.wavefront.com.
  2. Click Integrations on the toolbar.
  3. In the VMware section, click the VMware vRealize Operations Cloud tile.
  4. Click Add Integration.
  5. Provide a meaningful name of the integration.
  6. Paste the API token that you generated in the API Token text box.
  7. Select the resources to fetch.

    Currently we fetch only vCenter Server adapter resources, such as Cluster Compute Resource and Datastore.

  8. In the Metric Allow List text box, add metrics to an allow list by specifying a regular expression.

    For example, to fetch only cost metrics, enter ^vrops.vmware.(datastore|clustercomputeresource).cost.*$.

  9. In the Service Refresh Rate text box, enter the number of minutes between requesting metrics. Default is 5 minutes.
  10. In the vROps URL text box, enter the vRealize Operations Cloud Endpoint URL.
  11. Click Register.

Metrics for vRealize Operations Cloud

With this initial, v1 release of the vRealize Operations Cloud integration, we collect the following high-level list of metrics. For the complete list and descriptions of the metrics that we collect for cluster compute resources and datastores, see Cluster Compute Resource Metrics and Datastore Metrics.

Metric Name Description
vrops.vmware.clustercomputeresource.* Metrics for cluster compute resources, such as:
  - Overall score metrics that show the cluster compute resource state, such as compliance, efficiency, health, risk, and workload.
  - Cluster services metrics that provide information about cluster services.
  - Configuration metrics that provide information about configuration settings.
  - Cost metrics that provide information about the cost.
  - CPU usage metrics provide information about CPU usage.
  and so on
vrops.vmware.datastore.* Metrics for datastores, such as:
  - Capacity metrics that provide information about datastore capacity.
  - Device metrics that provide information about device performance.
  - Datastore metrics that provide information about the datastore usage.
  and so on

You can see the full list of the collected metrics on the Metrics Browser page.

  1. In your Wavefront cluster, click Browse > Metrics.
  2. On the Metrics Browser page, in the Metrics text box, enter vrops.vmware..
  3. Click the folder icons to drill down to the individual metrics.

vRealize Operations Cloud Integration Known Issues and Limitations

This initial release of the VMware vRealize Operations Cloud integration has the following known issues and limitations:

  • For supermetrics, such as Cost Drivers - Facilities (US $/Month), Total Server Purchase Cost, and so on, the metric names are not fetched and in the Tanzu Observability UI, these metrics are displayed with the super metric ID.
  • The vRealize Operations Cloud metrics have a point tag, which represents the organization ID. This is the UUIF of the organization. Currently, Tanzu Observability collects the Organization ID as a point tag, instead of the Organization name.
  • Along with the summary for a resource, in vRealize Operations Cloud there might be other properties. In Tanzu Observability, currently we do not collect such properties. The vRealize Operations Cloud integration only collets properties under the summary section as point tags.
  • In this release, you will see all the vCenter Server instances that you have configured in vRealize Operations Cloud. To shortlist the vCenter Server instances you want to monitor, apply a filter by using the REST API.
    1. In your Wavefront cluster, click the gear icon on top right, and select API Documentation.
    2. Expand Cloud Integration and click the GET /api/v2/cloudintegration request.

      You will see the list of the cloud integrations in the Response Body in JSON format.

    3. Search for the vRealize Operations Cloud integration that you want to update.
    4. Copy the value of the id parameter of the vRealize Operations Cloud integration and keep it handy.
    5. In a JSON file replace all the values in the below structure with the values that you got from step 4, and filter out the vCenter Server instances.

       {
          "name":"<integration-name>",
          "service":"VROPS",
          "vrops": {
                  "baseURL": "<vrealize-operations-cloud-base-URL>",
                  "metricFilterRegex": "<metric-filter-regex>",
                  "categoriesToFetch": <categories-to-fetch>,
                  "vropsAPIToken": "<vrealize-operations-API-Token>",
                  "organizationID": "<organization-ID>",
                  "adapterNames":{"VMWARE":["vCenter Server name 1","vCenter Server name 2",...]}
                },
            "serviceRefreshRateInMins":<service-refresh-rate-in-minutes>
        }
      

      Here the adapterNames are the names of your vCenter Server instances.

      Leave only the names of the vCenter Server instances that you want to monitor.

    6. After you create the JSON file, click the PUT /api/v2/cloudintegration/{id} request.
    7. In the id text box, enter the ID of the integration that you copied in Step 5.
    8. In the Edit Value text box, enter the contents of the JSON file that you created in Step 6.
    9. Click Execute.

    You get a 200 response and in the Tanzu Observability by Wavefront UI, you can see that the vCenter Server instances are filtered out.