VMware Tanzu integration

Our VMware Tanzu integration ​helps you understand the health and performance of your PCF environment. Query data from different Tanzu instances and cloud providers, and go from high level views down to the most granular data, such as the last duration of the garbage collector pause.

newrelicone-dashboards-vmware-tanzu.png
VMware Tanzu data visualized in a New Relic One dashboard.

The integration uses Loggregator to collect metrics and events generated by all Tanzu platform components and applications that run on cells. It connects to our platform by instrumenting the VMware Tanzu Application Service (TAS) and the Cloud Foundry Application Runtime (CFAR).

To collect data from VMware PKS, use the New Relic Cluster Monitoring integration.

Features

With the New Relic VMware Tanzu integration you can:

  • Monitor the health of your deployments using our extensive collection of charts and dashboards.

  • Set alerts based on any metrics collected from Firehose.

  • Retrieve logs and metrics related to user apps deployed on the platform.

  • Stream metrics from platform components and health metrics from BOSH-deployed VMs.

  • Filter logs and metrics by configuring the nozzle during and after the installation.

  • Scale the number of instances of the nozzle to support different volumes of data.

  • Use the data retrieved to monitor Key Performance and Key Capacity Scaling indicators.

  • Instrument and monitor multiple VMware Tanzu instances using the same account.

Compatibility and requirements

Our integration is compatible with VMware Tanzu (Pivotal Platform) version 2.4 or higher, and Ops Manager version 2.4 or higher. BOSH stemcells must be based on Ubuntu Xenial.

Before installing the integration, make sure that you meet the following requirements:

  • New Relic Infrastructure Pro subscription or trial
  • VMware Tanzu account.

This integration sends custom events. If you find you are reaching the custom event data collection and data retention limits of your subscription, please reach out to your New Relic representative.

Install and activate

The quickest way to install the VMware Tanzu integration is by importing the nr-firehose-nozzle tile into Ops Manager. For more information, see the VMware Tanzu documentation.

You can also deploy the nozzle as a standard application, edit the manifest, and run cf push from the command line; see how to build and deploy the integration in our GitHub repository.

Find and use data

Once you install and activate the VMware Tanzu integration, you can find the data and predefined charts in infrastructure.newrelic.com > Third-party services > VMware Tanzu dashboard. You can query the data to create custom charts and dashboards, and add them to your account.

If you collect data from multiple Tanzu environments, use pcf.domain and pcf.IP metrics with WHERE or FACET to discriminate between events from different Tanzu deployments.

Tanzu metrics are aggregated in order to reduce memory and network consumption. However, you can increase the number of samples acting on the drain interval in the configuration.

Many prebuilt dashboards and charts displaying VMware Tanzu data are available upon request. Contact your New Relic representative to get them added to your New Relic account.

Set up an alert

VMware Tanzu provides a list of indicators on key performance and key capacity scaling, together with warning and critical values that you can monitor using NRQL alert conditions.

Here is a sample NRQL query that sets up an alert on memory consumption related to the system space:

SELECT average(app.memory.used) FROM PCFContainerMetric WHERE metric.name = 'app.memory' AND app.space.name = 'system' FACET app.instance.uid

Here is the resulting chart in New Relic One:

VMWare Tanzu NRQL alert chart

For more information on NRQL queries and how to set up different notification channels for alerts, see Create alert conditions for NRQL queries.

Creating alert conditions from Infrastructure > Settings is currently not supported for this integration.

Metric data

The VMware Tanzu integration provides the following metric data:

PCFCapacity

Contains all the shared Aggregation and Decoration fields.

Name Description

metric.source.remaining

Type of remaining capacity (for example, integer)

metric.source.remaining.value

Value of total remaining capacity

metric.source.total

Type of total capacity (for example, integer)

metric.source.total.value

Value of total capacity

PCFContainerMetric

Resource usage of an app in a container. Contains all the shared Aggregation, App, and Decoration fields.

If the value of metric.name is app.disk, two additional fields are available:

Name Description

app.disk.quota

Total available disk in bytes

app.disk.used

Disk currently used in percentage

If the value of metric.name is app.memory, two additional fields are available:

Name Description

app.memory.quota

Total available memory in bytes

app.memory.used

Memory currently used as percentage

PCFCounterEvent

Increment of a counter. Contains all the shared Aggregation and Decoration fields.

Name Description

total.reported

Current value of the counter

PCFHttpStartStop

The whole lifecycle of an HTTP request. Contains all the shared Decoration fields.

Name Description

http.content.length

Length of response (in bytes)

http.duration

Duration of the HTTP request (in milliseconds)

http.method

Method of the request

http.peer.type

Role of the emitting process in the request cycle (server or client)

http.remote.address

Remote address of the request. For a server, this should be the origin of the request

http.request.id

ID for tracking the lifecycle of the request

http.start.timestamp

UNIX timestamp (in nanoseconds) when the request was sent (by a client) or received (by a server)

http.status

Status code returned with the response to the request

http.stop.timestamp

UNIX timestamp (in nanoseconds) when the request was received

http.uri

Destination of the request

http.user.agent

Contents of the UserAgent header on the request

PCFLogMessage

Log lines and associated metadata. Contains all the shared Aggregation, App, and Decoration fields.

Name Description

log.app.id

Application that emitted the message (or to which the application is related)

log.message

Log message

log.message.type

Type of the message (OUT or ERR)

log.source.instance

Instance that emitted the message

log.source.type

Source of the message. For Cloud Foundry, this can be APP, RTR, DEA, STG, etc.

log.timestamp

UNIX timestamp (in nanoseconds) when the log was written

PCFValueMetric

A flat list of key-value pairs fetched from Loggregator. For an extensive list, see the official documentation.

Contains all the shared Aggregation and Decoration fields.

Fields shared across metric data

VMWare Tanzu metrics contain shared data fields in the following categories:

Aggregation fields

Fields generated by the aggregation process.

Shared by PCFCounterEvent, PCFContainerMetric, and PCFValueMetric.

Name Description

metric.max

Maximum value of the metric recorded by the nozzle from the last aggregated metric sent

metric.min

Minimum value of the metric recorded by the nozzle from the last aggregated metric sent

metric.name

Name of the reported metric

Note: the field may contain hundreds of different values

metric.sample.last.value

Last received value of the metric

metric.samples.count

Number of samples of the metric received by the nozzle since the last aggregated metric sent

metric.sum

Sum of all the metric values recorded by the nozzle from the last aggregated metric sent

metric.type

Metric type (for example, integer)

metric.unit

Metric unit. For example, delta, seconds, or bytes

App fields

Fields that describe the source of the data.

Shared by PCFContainerMetric and PCFLogMessage.

Name Description

app.instance.state

Status of the application

app.instance.uid

Id of the application instance

app.instances.desired

Number of instances required

app.name

Name of the application

app.org.name

Organization the application belongs to

app.space.name

Space where the application is running

Decoration fields

Fields that contain information related to the agent, the PCF environment, and a timestamp.

Shared by all data types.

Name Description

agent.instance

Nozzle ID

agent.ip

Nozzle IP address

agent.subscription

Agent subscription ID, registered at the firehose

agent.version

Version of the nozzle

bosh.domain

API URL of your Tanzu environment

pcf.IP

IP address (used to uniquely identify source)

pcf.deployment

Deployment name (used to uniquely identify source)

pcf.domain

API URL of your Tanzu environment

pcf.index

Index of job (used to uniquely identify the source)

pcf.job

Job name (used to uniquely identify the source)

pcf.origin

Unique description of the origin of the event

timestamp

UNIX timestamp (in milliseconds) of the event.

Example: 1582023990236

pcf.envelope.type

Type of wrapped event

nr.customEventSource

source of the custom event

For more help