LATEST VERSION: v1.2 - RELEASE NOTES
Pivotal Container Service v1.2

Telemetry

Page last updated:

This topic describes the metrics that the Pivotal Container Service (PKS) tile sends when you enable the VMware Customer Experience Improvement Program (CEIP) or the Pivotal Telemetry Program (Telemetry). You can opt in or opt out of either program in the Usage Data pane of the PKS tile.

For more information, see the Installing PKS topic for your IaaS:

Event Envelope Properties

When PKS sends metrics to CEIP or Telemetry, the tile packages the data with the following deployment information:

Property Name Property Description Example Data Added in PKS Version
event The type of event create_cluster v1.1
product_version PKS tile version 1.2.0-build.40 v1.1
cloud_provider Cloud provider for the PKS installation GCP v1.1
vcenter_id vCenter ID 00000a11-22bb-3333-4c4c-555566667777 v1.1

Cluster Events

PKS sends metrics for the cluster management events shown in the table below:

Event Name Event Description Property Name Property Description Added in PKS Version
create_cluster This event is generated when a user creates a cluster. user_id A hashed value of the username. v1.1
timestamp The time when the user created the cluster. v1.1
plan_name The name of the PKS plan that was used to create the cluster. v1.1
plan_id The ID of the PKS plan that was used to create the cluster. v1.1
cluster_name The name of the cluster. v1.1
cluster_id The ID of the cluster. v1.1
number_of_workers The number of worker node VMs in the cluster. v1.1
number_of_masters The number of master node VMs in the cluster. v1.2
resize_cluster This event is generated when a cluster is resized. user_id A hashed value of the username. v1.1
timestamp The time when the user created the cluster. v1.1
plan_name The name of the PKS plan that was used to create the cluster. v1.1
plan_id The ID of the PKS plan that was used to create the cluster. v1.1
cluster_name The name of the cluster. v1.1
cluster_id The ID of the cluster. v1.1
old_number_of_workers The number of worker node VMs in the cluster before the resize event. v1.1
new_number_of_workers The number of worker node VMs in the cluster after the resize event. v1.1
delete_cluster This event is generated when a user deletes a cluster. user_id A hashed value of the username. v1.1
timestamp The time when the user created the cluster. v1.1
plan_name The name of the PKS plan that was used to create the cluster. v1.1
plan_id The ID of the PKS plan that was used to create the cluster. v1.1
cluster_name The name of the cluster. v1.1
cluster_id The ID of the cluster. v1.1
api_started This event is generated when the PKS API is started.
authentication_mode The authentication mode used to access a Kubernetes cluster. v1.2
timestamp The time when the PKS API started. v1.2

Cluster Metrics

PKS sends both agent metrics and cluster pod metrics for each cluster.

The following table describes cluster agent metrics:

Agent Metric Name Agent Metric Description Example Added in PKS Version
agentid The unique BOSH-generated deployment name for the cluster. service-instance_00000a11-22bb-3333-4c4c-555566667777 v1.1
isvrlienabled If vRealize Log Insight (vRLI) is enabled, this value is true. If vRLI is disabled, this value if false. true v1.1
isvropsenabled If vRealize Operations (vROps) is enabled, this value is true. If vROps is disabled, this value is false. false v1.1
iswavefrontenabled If Wavefront is enabled, this value is true. If Wavefront is disabled, this value is false. true v1.1
vcenter_id This is your vCenter ID. 00000a11-22bb-3333-4c4c-555566667777 v1.1

The following table describes cluster pod metrics:

Cluster Pod Metric Name Cluster Pod Metric Description Example Added in PKS Version
collected_at This timestamp represents the metric collection time on the agent. 2018-05-31 21:45:27.681 UTC v1.1
cpu_used This value represents how much CPU was in use at the time when the event happened. 11412427 v1.1
memory_used This value represents how much memory was in use at the time when the event happened. 4816896 v1.1
pkst_kubernetesclusterinfo__fk This value is a foreign key that points to an entry in the pkst_kubernetesclusterinfo database. 77777a66-55bb-4444-3c3c-222211110000 v1.1

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

Create a pull request or raise an issue on the source for this page in GitHub