Configuring Telegraf in Enterprise PKS

Page last updated:

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


You can configure Telegraf to collect metrics from PKS API, 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, VMware 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. Under Enable Telegraf Outputs?, select Yes.

  3. Configure the Telegraf checkboxes as described in the table below.

    Components you enable in this step will be visible to PKS admins only.

    Enable this checkbox… …to send these metrics to your monitoring service
    Enable node exporter on PKS API Node Exporter metrics from the PKS API VM
    Enable node exporter on master Node Exporter metrics from Kubernetes master nodes
    Include etcd metrics etcd server and debugging metrics
    Enable node exporter on worker Node Exporter metrics from Kubernetes worker nodes
    Include Kubernetes Controller Manager metrics Kubernetes controller manager metrics
    • These metrics provide information about the state of each cluster.
    Include Kubernetes API Server metrics Kubernetes API server metrics
    Include kubelet metrics kubelet metrics for all workloads running in all your Kubernetes clusters
    • If you enable Include kubelet metrics, be prepared for a high volume of metrics.

  4. In Set Up Telegraf Outputs, replace the default value [[outputs.discard]] with the contents of the configuration file that you created in Create a Configuration File above. See the following example for an HTTP output plugin:

        director = "bosh-director-1"
  5. Click Save.

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

Troubleshoot etcd

VMware recommends working with 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