Monitoring Master/etcd Node VMs

Page last updated:

Warning: Pivotal Container Service (PKS) v1.5 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 platform operators can monitor and retrieve metrics from master/etcd node VMs in Enterprise Pivotal Container Service (Enterprise PKS) deployments.


You can configure the Telegraf agent to collect metrics from master/etcd node VMs and send the metrics to a third-party monitoring service. The Telegraf agent can read metrics from the following:

  • the /metrics endpoint exposed by etcd
  • Node Exporter

Node Exporter provides additional infrastructure metrics on the localhost of the master node. For more information, see node_exporter in GitHub.

Collect Metrics Using Telegraf

To collect metrics using Telegraf, do the following:

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

Create a Configuration File

To connect a third-party 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 your monitoring service, do the following:

  1. Locate the required format for your monitoring service in the file for your service in telegraf in GitHub. The etcd documentation recommends using the open source Prometheus monitoring service.

    For more information about using Prometheus, see Overview in the Prometheus documentation.

  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 Telegraf in the Enterprise PKS tile, follow the instructions in the Installing topic for your IaaS. For example, if your are installing Enterprise PKS on vSphere, follow the instructions in the Telegraf section of Installing Enterprise PKS on vSphere.

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