Learn how to customize a built-in integration and how to set up a custom integration.

Integrations are one easy way to get data from external systems into Tanzu Observability (formerly known as VMware Aria Operations for Applications). Use one of the built-in integrations and customize it as needed.

We update our integrations release notes frequently.

Starting July 3, 2023, Tanzu Observability is a service on the VMware Cloud services platform. After this date, we support two types of subscriptions: Tanzu Observability subscriptions onboarded to the VMware Cloud services platform and original subscriptions. Original subscriptions are the existing ones and they remain as is until they migrate to VMware Cloud services. For information about the subscription types and how they differ, see Subscription Types.

Watch a Video

In this video, Jason talks about the different integrations we have, and how you can use them to get your data into the product. You can also watch the video here video camera icon. Note that this video was created in 2017 and some of the information in it might have changed. It also uses the 2017 version of the UI.

Try an Integration!

Sign up for a trial version to try our integrations. Detailed setup steps for each integration are in the product UI.

When the integration setup requires a token for the proxy authentication, the setup instructions of some integrations (such as all integrations for Linux distributions, Windows host integration, MacOS integration, Prometheus, and so on) vary depending on whether your service is onboarded to VMware Cloud services or not. For details, see Integrations Supported for Onboarded Subscriptions. For the latest and most recent instructions on how to set up an integration, see the steps on the Setup tab of the integration that you’re interested in.

  • If your Tanzu Observability service is onboarded to VMware Cloud services, you have two choices:

    • Use OAuth App authentication (recommended):

      You must use the credentials (client ID and client secret) of an existing server to server app which has the Proxies service role assigned and is added to the VMware Cloud organization running the service. You must also provide the ID of the VMware Cloud organization running the service.

      If you don’t have a server to server app already, you can create one in the VMware Cloud Services Console. For details, see How to use OAuth 2.0 for server to server apps in the VMware Cloud services documentation.

    • Use API Token authentication:

      The API token must be generated in the VMware Cloud Services Console by an active user account. It also must have the Proxies service role assigned. For more information, see How do I generate API tokens.

  • If your Tanzu Observability service is not onboarded to VMware Cloud services, generate the API token in the Tanzu Observability UI. It is recommended that you use a service account API token. For more information, see Manage API tokens.

Here’s a sample of what you see when you select one of our integrations:

  • The Overview tab explains how the integration works and what’s included, often a sample dashboard with commonly used charts.
  • The Setup tab has the instructions for configuring the integration.
  • The Metrics and Dashboard tabs are preconfigured to show your metrics after you’ve set up the integration. You can clone and customize our dashboards.
  • The Alerts tab is an optional one. It contains a list of preconfigured integration alerts.

Here’s a screenshot that shows the different tabs of the Apache Solr integration.

An image of the Apache Solr integration showing the Overview, Setup, Metrics, and Dashboards tabs.

Note Even if we don’t have an integration for you data source, you can send your data directly to the Wavefront proxy in one of the supported data formats.

Built-In and Custom Integrations

Tanzu Observability lets you set up many integrations directly from the product. For other integrations, we give step-by-step instructions – or you can send your data in other ways, for example, using the Telegraf output plug-in.

  • Built-in integrations provide assisted installation and configuration. Many integrations also install a dashboard for you. Access the integration by clicking Integrations on the toolbar and clicking the Setup tab.

  • Customizable built-in integrations provide a built-in integration for the initial connection, with additional customization information in this documentation.

  • Custom integrations provide installation and configuration instructions in this documentation.

This table provides links to the documentation pages for many of the custom and customizable integrations:

Customizable built-in integrations AWS Metrics Integration, Amazon Web Services ECS, AWS Lambda Functions, Log Data – FileBeat and TCP
Custom integrations - collectd Apache collectd, Cassandra collectd, MySQL collectd, NGINX collectd, Redis collectd, ZooKeeper collectd

External (Open-Source) Integrations

Our customers have started to make open-source integrations available on GitHub.

Our first external integration sends AlertSite monitoring results to Tanzu Observability and is available at https://github.com/secureworks/AlertSite2Wavefront.

We’re excited about this contribution and hope to see more soon!

Installing and Uninstalling Integration Dashboards

You can install and uninstall the system integration dashboards.

  1. Click Integrations on the toolbar.
  2. Click an integration tile.
  3. Click the Dashboards tab.
  4. Click [Install | Uninstall] Dashboards.

Cloning and Customizing Dashboards

You cannot modify the system dashboards. Instead, you must clone the dashboards.

  1. Open an integration dashboard:
    1. Click Integrations on the toolbar.
    2. Click an integration tile.
    3. Click the Dashboards tab.
    4. Click the dashboard that you want to clone and edit.
  2. Click the ellipsis icon in the top right corner of the dashboard.
  3. Select Clone.
  4. Provide a URL string that’s just the name (e.g., mydashboard or dashboard-name-clone) and not the URL (e.g., http://mydashboard).
  5. Customize the clone to suit your needs.

Installing and Uninstalling Integration Alerts

Some integrations contain system alerts. You can preview the system alerts even before setting up an integration by clicking Preview. In Preview mode, you cannot do any customizations to these alerts. You can also install and uninstall the predefined integration alerts to explore them further. After you install the system alerts, you edit some of their settings.

To install the system alerts:

  1. Click Integrations on the toolbar.
  2. Click an integration tile.
  3. Click the Alerts tab.
  4. Click [Install All| Uninstall All].

Editing and Cloning the Integration Alerts

To edit the targets of the integration alerts, you must have the Alerts permission. If you edit the system integration alerts and then reinstall them, all of the changes that you’ve made are reverted back to their original state.

By default, when integration alerts are installed, you can edit the following alert settings:

  • Tags – You can add additional tags, as necessary.
  • Alert Condition threshold values – You can edit the threshold values but NOT the operator.
  • Recipients – Specify the email address, PagerDuty key, or alert targets that will receive alert notifications
  • Runbook, Triage Dashboard(s), and Additional Information settings – Allow you to add runbook URLs and specify other information that can help with alert resolution.

Clone the alert before making any customizations so that you don’t lose your changes.

To clone an integration alert:

  1. Click Integrations on the toolbar.
  2. Click an integration tile.
  3. Click the Alerts tab.
  4. Click Edit next to the alert that you want to clone. The alert opens in Edit mode.
  5. Click the Clone button in the top right corner of the alert.

    Example screenshot that shows the clone button

  6. Enter a name of the new alert and click Clone.

    The new alert opens in edit mode.

  7. Customize the clone to suit your needs and click Save.

After you clone an alert, snooze the original system integration alert to avoid running a duplicate version of the alert. For more information about editing alerts, see Manage Alerts.

Integration States

The Integrations page reports integration states depending on two factors:

  • Whether metrics ever reported and whether they reported in the last 2 hours or in the last 7 days.
  • The state of content installation, such as installed, never installed, or uninstalled.

Supported States

The supported states are:

  • Active - integrations whose metrics are reporting and user has installed or uninstalled content.
  • Available - integrations whose metrics never reported and content has been never installed or integrations that don’t have metrics.
  • Warning - integrations whose metrics never reported and have no installed content.
  • Error - integrations whose metrics reported within the last 7 days but have stop reporting for 2 hours and have installed content.
  • Pending - integrations whose metrics are yet to start reporting.
  • Alias - integrations that are supported by another integration.

You can also filter integrations with the following saved searches:

  • New Integrations - integrations that have metrics reporting for at most two hours and have installed content.
  • Installed Integrations - integrations in the Active, Warning, or Error state. An integration can be in one of these states even if content has been uninstalled.

State Indicators

When you hover over an integration, the integration border in the UI changes and you see indicators based on the current state. For example, the following integration is in the Warning state because metrics have stopped reporting in the past month and content is installed.

Windows integration state with a Warning sign next to metrics

More Info