Configuring Telegraf in Enterprise PKS

Page last updated:

Warning: VMware Enterprise PKS v1.6 is no longer supported because it has reached the End of General Support (EOGS) phase as defined by the Support Lifecycle Policy. To stay up to date with the latest software and security updates, upgrade to a supported version.

This topic describes how to configure Telegraf in VMware Enterprise PKS (Enterprise PKS).


You can configure Telegraf to collect metrics from master node and worker node VMs and send the metrics to a monitoring service, such as Wavefront or Datadog.

For more information about these metrics, see Metrics: Telegraf in Monitoring Enterprise PKS and PKS-Provisioned Clusters.

Collect Metrics Using Telegraf

To collect metrics using Telegraf:

  1. Create a configuration file for your output plugin. See Create a Configuration File below.
  2. Configure Telegraf in the Enterprise PKS tile. See Configure Telegraf in the Tile below.

Create a Configuration File

To connect a monitoring service to Enterprise PKS, you must create a configuration file for the service. The configuration file is written in a TOML format and consists of key-value pairs. After you create your configuration file, you can enter the file into the Enterprise PKS tile to connect the service.

To create a configuration file for your monitoring service:

  1. Locate the required format for your monitoring service in the file for your service in telegraf in GitHub. For example, if you want to collect metrics from etcd, the etcd documentation recommends using the open-source Prometheus monitoring service.

  2. Create your configuration file using the required format of your monitoring service. For example, if you want to create a configuration file for an HTTP output plugin, create a file similar to the following:

        director = "bosh-director-1"

    Note: You can add tags to your configuration file to label etcd metrics. For example, the above code snippet adds a bosh-director-1 tag to the etcd metrics. If you have multiple BOSH Directors, Pivotal recommends adding tags to filter your metrics in your monitoring service.

Configure Telegraf in the Tile

To configure Enterprise PKS to use Telegraf for metric collection:

  1. Navigate to the Enterprise PKS tile > Settings > Host Monitoring.
  2. Select one or more of the following checkboxes:
    • Include etcd metrics: This includes etcd server and debug metrics.
    • Enable node exporter on master: This enables Node Exporter on localhost of each master node VM.
    • Include kubelet metrics: This includes all workload metrics across your Kubernetes clusters. Enabling Include kubelet metrics generates a high volume of metrics.
  3. In Setup Telegraf Outputs, replace the default value [[outputs.discard]] with the contents of the configuration file that you created in Create a Configuration File above.
  4. Click Save.

  5. To deploy the Enterprise PKS tile, return to the Ops Manager Installation Dashboard and click Review Pending Changes > Apply Changes.

Troubleshoot etcd

Pivotal recommends working with Pivotal or VMware Support to troubleshoot master/etcd node VMs. The monitoring and metrics data you retrieve from the master/etcd node VMs can help the Support team diagnose and troubleshoot errors.

Please send any feedback you have to