Monitoring Enterprise PKS and PKS-Provisioned Clusters

Page last updated:

This topic lists VMware Enterprise PKS (Enterprise PKS) components and integrations you can use to capture logs and metrics about Enterprise PKS and PKS-provisioned cluster VMs.

For information about monitoring Kubernetes workloads, see Monitoring Workers and Workloads.

Overview

To monitor Enterprise PKS and PKS-provisioned cluster VMs, you can enable one or more of the following components and integrations in the Enterprise PKS tile > Host Monitoring:

Name Link
Syslog See Syslog below.
VMware vRealize Log Insight See vRealize Log Insight (vSphere Only) below.
Telegraf (metrics) See Telegraf below.

These components and integrations are visible only to PKS admins. They are not visible to cluster users, such as developers.

Logs: Syslog and vRLI

You can configure Syslog or vRealize Log Insight (vRLI) to publish logs from the PKS control plane and PKS-provisioned cluster VMs.

You might need to inspect Syslog or vRLI logs when troubleshooting or auditing your Enterprise PKS environment. For information about key Enterprise PKS events and the log entries they generate, see Auditing Enterprise PKS Logs.

Syslog

Syslog sends log messages from all BOSH-deployed VMs in an Enterprise PKS environment to a syslog endpoint. To configure Syslog, see Syslog in the Installing topic for your IaaS.

If you do not use Syslog, you can retrieve logs from BOSH-deployed VMs by downloading them as described in Downloading Logs from VMs. However, retrieving these logs through Syslog is recommended.

vRealize Log Insight (vSphere Only)

The vRLI integration for PKS pulls logs from all BOSH jobs and containers running in the cluster, including node logs from core Kubernetes and BOSH processes, Kubernetes event logs, and pod stdout and stderr.

To configure the vRLI integration, see VMware vRealize Log Insight Integration in the Installing topic for vSphere with Flannel or vSphere with NSX-T.

For information about vRLI, see vRealize Log Insight.

Metrics: Telegraf

Telegraf sends metrics from PKS API, master node, and worker node VMs to a monitoring service, such as Wavefront or Datadog.

In the Enterprise PKS tile > Host Monitoring, you can configure Telegraf to collect metrics from one or more the following sources:

Source Includes metrics from…
PKS API
  • Node Exporter (Prometheus)
Master nodes
(not visible to cluster users)

One or more of the following:

  • Node Exporter (Prometheus)
  • Kubernetes API server
  • Kubernetes controller manager
  • etcd
Worker nodes

One or more of the following:

  • Node Exporter (Prometheus)
  • kubelet

To configure Telegraf, see Configuring Telegraf in Enterprise PKS.

For more information about Node Exporter, see About Node Exporter below.

About Node Exporter

Node Exporter exports hardware and operating system metrics in Prometheus format.

In the Host Monitoring pane of the Enterprise PKS, you can enable the Node Exporter BOSH job separately on master nodes, worker nodes, and the PKS API VM.

Node Exporter exposes metrics on localhost only. For a list of Node Exporter metrics, see the Node Exporter GitHub repository.


Please send any feedback you have to pks-feedback@pivotal.io.