tc Server Tanzu Observability by Wavefront Listener Template

About this Template

VMware tc Server Template for Tanzu Observability by Wavefront uses a Tomcat listener to collect and report metrics to a Wavefront Proxy or directly to an Wavefront Instance. This template has no external dependencies and does not require jolokia or telegraf. This template reports metrics with a prefix of tcserver and reports on the same metrics as the Tomcat wavefront integration.

Prerequisites

  • You must have an existing Wavefront Instance to which to send the metrics. An optional Wavefront proxy is also supported.
  • You must be using a tc Runtime instance with a JVM equal or greater than 8.

Installation

There are two methods to install this template.

Via the tc Server Template Repository

tcserver get-template tanzu-observability

Via Tanzu Network

This template may be installed into VMware tc Server by downloading from Tanzu Network and then installing it in the tc Server templates directory.

tcserver get-template tanzu-observability-template.zip

In the above example, use the location of the downloaded .zip file from Tanzu Network.

Usage

This template may be added during tc Runtime instance creation or to an existing instance. The template requires the following properties to be set:

  • tanzu-observability.url - This is either the URL to the instance or to a wavefront proxy
  • tanzu-observability.token - This is the token used to authenticate to the wavefront instance. It is not required when using a proxy.

These properties may be set using the -p option to tcserver or via a properties file.

An example of adding this template to an existing instance called prod-web is below. This example sends metrics directly to your Wavefront Instance.

tcserver apply-template prod-web -t tanzu-observability -p tanzu-observability.url=https://example.wavefront.com -p tanzu-observability.token=1234566790

An example of adding this template to an existing instance called prod-web is below. This example sends metrics to a proxy named myproxy.mynetwork.example.com.

tcserver apply-template prod-web -t tanzu-observability -p tanzu-observability.url=http://myproxy.mynetwork.example.com:2878

Template Configuration Properties

The following is a list of all accepted properties, default values, and a short description.

Reminder: When setting a template property the property name must be prefixed with the template name (tanzu-observability) such as tanzu-observability.url

Property Name Default Value Description
url not set This is either the URL to the instance or to a wavefront proxy
token not set This is the token used to authenticate to the wavefront instance. It is not required when using a proxy.
collectionInterval 1000 The interval for which metrics are collected.
source <hostname> The value of the source attributed used when reporting metrics. This is automatically determined by default, however this property is provided to allow for customization.
instanceName tc Runtime Instance name This is the instance name reported to Tanzu Observability. The default value is the name of the tc Runtime Instance and generally does not need to be set manually.
prefix tcserver This is the prefix used for all metrics. Changing this value will have an impact on the dashboard.
messageSizeBytes 200 This is value passed to the WavefrontClient.Builder.setMessageSizeBytes() call. See Wavefront SDK Java docs
maxQueueSize 100000 This is value passed to the WavefrontClient.Builder.setMaxQueueSize() call. See Wavefront SDK Java docs
batchSize 20000 This is value passed to the WavefrontClient.Builder.setBatchSize() call. See Wavefront SDK Java docs
flushIntervalSeconds 2 This is value passed to the WavefrontClient.Builder.setFlushIntervalSeconds() call. See Wavefront SDK Java docs

VMware tc Server Tanzu Observability Dashboard

The appropriate dashboard to use with this template is called VMware tc Server the tc Server dashboard is the older dashboard for metrics collected via telegraf.

The following image shows an example of the VMware tc Server dashboard.

From the dashboard you are able to select the Environment and Instance.