Accessing Logs and Metrics on Pivotal Platform
Page last updated:
This topic describes how to access logs and metrics for VMs and app containers on your Pivotal Platform deployment. It includes information about the available logs and metrics for the Pivotal Application Service (PAS) and Enterprise Pivotal Container Service (Enterprise PKS) runtimes.
Overview
There are different methods for accessing logs and metrics for VMs and app containers depending on if you use the PAS or Enterprise PKS app runtime for your deployment.
There are also different permissions required to access logs and metrics on PAS and Enterprise PKS. The sections in this topic explain how to access logs and metrics on your PAS or Enterprise PKS deployment based on your user role permissions.
Access Platform Director VM Logs
Platform Director logs include logs from the Ops Manager and BOSH Director VMs.
For both PAS and Enterprise PKS, operators can access platform director VM logs by configuring a syslog drain in the Ops Manager tile. For more information, see Settings Page in Using the Ops Manager Interface.
The format for the BOSH Director VM logs is Syslog RFC 5424. For more information, see RFC 5424 - The Syslog Protocol in the Internet Engineering Task Force (IETF) documentation.
The format for the Ops Manager VM logs is Syslog RFC 3164. For more information, see The BSD Syslog Protocol in the IETF documentation.
Access VM Logs
This section describes how to access logs for PAS and Enterprise PKS VMs.
The format for VM logs is Syslog RFC 5424. For more information, see RFC 5424 - The Syslog Protocol in the IETF documentation.
See one of the following sections below:
Access VM Logs on PAS
PAS VM logs include logs for runtime component VMs and service tile VMs.
The following table describes how to access VM logs on foundations with PAS based on user role and permissions:
Title | PAS Role | Procedure | Notes |
---|---|---|---|
Operator | Admin |
Configure system logging in PAS. For more information, see Configure System Logging in Configuring PAS. | To access logs for service instances, you must also configure syslog in each service tile for which you want logs. For more information, see the documentation for the service tile. |
Developer | Space Developer |
Not applicable. |
Access VM Logs on Enterprise PKS
The following table describes how to access VM logs on foundations with Enterprise PKS based on user role and permissions:
Title | Role | Procedure | Notes |
---|---|---|---|
Operator | Admin |
Enable system logging in Enterprise PKS. For more information, see the Host Monitoring section in the Enterprise PKS installation topic for your IaaS: | |
Cluster Admin/Developer | Not applicable. | Not applicable. |
Access VM Metrics
This section describes how to access metrics for PAS VMs and Enterprise PKS VMs.
See one of the following sections below:
Access VM Metrics on PAS
For PAS deployments, VM metrics include PAS component and service tile VM metrics.
The following table describes how to access VM metrics on foundations with PAS based on user role and permissions:
Title | PAS Role | Procedure | Notes |
---|---|---|---|
Operator | Admin |
No additional configuration is required. PAS emits VM metrics through the Loggregator Firehose. For more information, see Loggregator Architecture. | The Firehose emits metrics as a gauge or counter Loggregator envelope type. For more information, see the loggregator-api repository on GitHub. |
Developer | Space Developer |
Not allowed. |
Access VM Metrics on Enterprise PKS
For Enterprise PKS deployments, VM metrics include metrics for the master and worker nodes.
Note: VM metrics are available on Enterprise PKS v1.5 and later.
The following table describes how to access VM metrics on foundations with Enterprise PKS based on user role and permissions.
Title | Role | Procedure | Notes |
---|---|---|---|
Operator | Admin |
Configure an output plugin in the Enterprise PKS tile. For more information, see Creating Sink Resources in the Enterprise PKS documentation. | Component VM Metrics include the master node only. |
Cluster Admin | The operator defines the role-based access policy for accessing VM metrics. | Configure a ClusterMetricSink in the cluster. For more information, see Creating Sink Resources in the Enterprise PKS documentation. |
|
Developer | The operator defines the role-based access policy for accessing VM metrics. |
Access App Container Logs
This section describes how to access app logs on Pivotal Platform.
See one of the following sections below:
Access App Container Logs on PAS
App container logs for PAS deployments include logs for apps and service instances.
The following table describes how to access app logs on foundations with PAS based on user role and permissions.
Title | PAS Role | Procedure | Notes |
---|---|---|---|
Operator | Admin |
Access logs with one of the following methods:
|
|
Developer | Space Developer |
Access logs with one of the following methods:
|
|
Access App Container Logs on Enterprise PKS
The following table describes how to access app container logs on foundations with Enterprise PKS based on user role and permissions:
Title | Role | Procedure | Notes |
---|---|---|---|
Operator | Admin |
Configure a ClusterSink in the cluster. For more information, see Creating Sink Resources in the Enterprise PKS documentation. |
|
Cluster Admin | The operator defines the role-based access policy for accessing app logs. | Configure a ClusterSink in the cluster. For more information, see Creating Sink Resources in the Enterprise PKS documentation. |
|
Developer | The operator defines the role-based access policy for accessing app logs. | Configure a Sink in the Enterprise PKS tile for a cluster namespace. For more information, see Creating Sink Resources in the Enterprise PKS documentation. |
|
Access App Container Metrics
This section describes how to access app container metrics on Pivotal Platform.
See one of the following sections below:
Access App Container Metrics on PAS
App container metrics on PAS include app metrics and service instance metrics. App container metrics on PAS do not include task metrics. This is because Diego does not emit task metrics.
The following table describes how to access app container metrics on foundations with PAS based on user role and permissions:
Title | PAS Role | Procedure | Notes |
---|---|---|---|
Operator | Admin |
Access metrics with one of the following methods:
|
|
Developer | Space Developer |
Access metrics with one of the following methods:
|
Access App Container Metrics on Enterprise PKS
The following table describes how to access app container metrics on foundations with Enterprise PKS based on user role and permissions:
Title | Role | Procedure | Notes |
---|---|---|---|
Operator | Admin |
Configure a ClusterMetricSink in the cluster. For more information, see Creating Sink Resources in the Enterprise PKS documentation. |
|
Cluster Admin | The operator defines the role-based access policy for accessing app metrics. | Configure a ClusterMetricSink in the cluster. For more information, see Creating Sink Resources in the Enterprise PKS documentation. |
|
Developer | The operator defines the role-based access policy for accessing app metrics. | Configure a MetricSink in the Enterprise PKS tile for a cluster namespace. For more information, see Creating Sink Resources in the Enterprise PKS documentation.
|
|