You are viewing documentation for a previous version of GKE On-Prem. View the latest documentation.

Logging and monitoring

GKE On-Prem includes multiple options for cluster logging and monitoring, including cloud-based managed services, open source tools, and validated compatibility with third-party commercial solutions. This page explains these options and provides some basic guidance on selecting the proper solution for your environment.

Overview

You have several logging and monitoring options for your GKE On-Prem clusters:

  • Cloud Logging and Cloud Monitoring, enabled by in-cluster agents deployed with GKE On-Prem.
  • Prometheus and Grafana, enabled by default in new clusters.
  • Validated configurations with third-party solutions.

Cloud Logging and Monitoring

Stackdriver is the built-in observability solution for Google Cloud. It offers a fully managed logging solution, metrics collection, monitoring, dashboarding, and alerting. Stackdriver monitors GKE On-Prem clusters in a similar way as cloud-based GKE clusters.

The Stackdriver agents can be configured with two different levels of logging and monitoring:

  • System components only (the default).
  • Stackdriver disabled (prior to disabling, see the support page for how Stackdriver is used for support purposes).

Stackdriver is an ideal solution for customers wanting a single, easy to configure, powerful cloud-based observability solution. Stackdriver is highly recommended when running workloads only on GKE On-Prem, or workloads on GKE and GKE On-Prem. For applications with components running on GKE On-Prem and traditional on-premises infrastructure, you might consider other solutions for an end-to-end view those applications.

  • See the Stackdriver section for details on architecture, configuration, and what data is replicated to your Google Cloud project by default for GKE On-Prem.
  • See the Cloud Logging and Cloud Monitoring sections for more details on those services.

Prometheus and Grafana

Prometheus and Grafana are two popular open source monitoring products:

  • Prometheus collects application and system metrics.
  • Alertmanager handles sending alerts out with several different alerting mechanisms.
  • Grafana is a dashboarding tool.

Prometheus and Grafana runs on each admin cluster and user cluster by default. Prometheus and Grafana is recommended for application teams with prior experience with those products, or for operational teams who prefer to retain application metrics within the cluster and for troubleshooting issues when network connectivity is lost.

Third-party solutions

Google has worked with several third-party logging and monitoring solution providers to help their products work well with GKE On-Prem. These include Datadog, Elastic, and Splunk. Additional validated third parties will be added in the future.

The following solution guides are available for using third party solutions with GKE On-Prem:

How Stackdriver for GKE On-Prem works

Cloud Logging and Cloud Monitoring is installed and activated in each cluster when you create a new admin or user cluster.

The Stackdriver agents include several components on each cluster:

  • Stackdriver Operator (stackdriver-operator-*), which manages the lifecycle for all other Stackdriver agents deployed onto the cluster.
  • Stackdriver Custom Resource that is automatically created as part of the GKE On-Prem installation process; users can change the custom resource to update values such as project ID, cluster name, and cluster location at any time.
  • Stackdriver Log Aggregator (stackdriver-log-aggregator-*), a Fluentd StatefulSet that sends logs to the Cloud Logging API.
  • Stackdriver Log Forwarder (stackdriver-log-forwarder-*), a Fluentbit daemonset that forwards logs from each machine to the Stackdriver Log Aggregator.
  • Stackdriver Metrics Collector (stackdriver-prometheus-k8s-), a Prometheus and Stackdriver Prometheus Sidecar StatefulSet that sends Prometheus metrics to the Cloud Logging API.
  • Stackdriver Metadata Collector (stackdriver-metadata-agent-), a deployment that sends metadata for Kubernetes resources such as pods, deployments, nodes, etc. to the Stackdriver Resource Metadata API; this data is used to enrich metric queries by enabling you to query by deployment name, node name, or even Kubernetes service name.

You can see all of the agents installed by Stackdriver by running the following command:

  kubectl -n kube-system get pods | grep stackdriver

The output of this command is similar to the following:

stackdriver-log-aggregator-0                  1/1     Running   0   4h31m
stackdriver-log-aggregator-1                  1/1     Running   0   4h28m
stackdriver-log-forwarder-bpf8g               1/1     Running   0   4h31m
stackdriver-log-forwarder-cht4m               1/1     Running   0   4h31m
stackdriver-log-forwarder-fth5s               1/1     Running   0   4h31m
stackdriver-log-forwarder-kw4j2               1/1     Running   0   4h29m
stackdriver-metadata-agent-cluster-level...   1/1     Running   0   4h31m
stackdriver-operator-76ddb64d57-4tcj9         1/1     Running   0   4h37m
stackdriver-prometheus-k8s-0                  2/2     Running   0   4h31m

Configuring Stackdriver agents for GKE On-Prem

The Stackdriver agents installed with GKE On-Prem collect data about system components, subject to your settings and configuration, for the purposes of maintaining and troubleshooting issues with your GKE On-Prem clusters, in one of the following modes:

System Components Only (Default Mode)

Upon installation, Stackdriver agents are configured by default to collect logs and metrics, including performance details (for example, CPU and memory utilization), and similar metadata, for Google-provided system components including, all workloads in the admin cluster, and, for user clusters, workloads in the kube-system, gke-system, gke-connect, istio-system, and config-management-system namespaces.

Stackdriver Disabled

Stackdriver agents can be disabled completely by deleting the Stackdriver custom resource. Before you disable Stackdriver, see the support page for details on how this affects Google Cloud Support's SLAs.

To disable Stackdriver for GKE On-Prem:

kubectl -n kube-system delete Stackdriver stackdriver

Stackdriver agents capture data stored locally, subject to your storage and retention configuration. The data is replicated to the Google Cloud project specified at installation using a service account that is authorized to write data to that project. Stackdriver agents can be disabled at anytime, as described above, and data collected by Stackdriver agents can be managed and deleted like any other metric and log data, as described in Stackdriver documentation.

Configuration requirements for Stackdriver

There are several configuration requirements to enable Stackdriver with GKE On-Prem. These steps are included in the installation guide, and listed below.

  1. A Cloud Logging Workspace must created within the Google Cloud project. This is accomplished by clicking Monitoring in Cloud Console and following the workflow.
  2. You need to enable the following Stackdriver APIs:
    1. Stackdriver API
    2. Cloud Monitoring API
    3. Cloud Logging API
  3. You need to assign the following IAM roles to the service account used by the Stackdriver agents:
    1. logging.logWriter
    2. monitoring.metricWriter
    3. stackdriver.resourceMetadata.writer

Pricing

Anthos includes additional Cloud Logging free allotment above the standard Cloud Logging free allotment.

For more information, and to learn about credit for Cloud Logging metrics, please contact sales for pricing.

How Prometheus and Grafana for GKE On-Prem work

Each GKE On-Prem cluster is created with a Prometheus and Grafana instance deployed by default.

The Prometheus Server is set up in a highly-available configuration with two replicas running on two separate nodes. Resource requirements are adjusted to support clusters running up to five nodes, with each handling up to 30 Pods that serve custom metrics. Prometheus has a dedicated PersistentVolume with disk space preallocated to fit data for a retention period of four days plus an added safety buffer.

The admin control plane and each user cluster has a dedicated monitoring stack that you can configure independently. Each admin and user cluster includes a monitoring stack which delivers a full set of features: Prometheus Server for monitoring, Grafana for observability, and Prometheus Alertmanager for alerting.

All monitoring endpoints, transferred metric data, and monitoring APIs are secured with Istio components using mTLS and RBAC rules. Access to monitoring data is restricted only to cluster administrators.

Metrics collected by Prometheus

Prometheus collects the following metrics and metadata from the admin control plane and user clusters:

  • Resource usage, such as CPU utilization on Pods and nodes.
  • Kubernetes control plane metrics.
  • Metrics from add-ons and Kubernetes system components running on nodes, such as kubelet.
  • Cluster state, such as health of Pods in a Deployment.
  • Application metrics.
  • Machine metrics, such as network, entropy, and inodes.

Multi-cluster monitoring

The Prometheus and Grafana instance installed on the admin cluster is specially configured to provide insight across the entire GKE On-Prem instance, including the admin cluster and each user cluster. This enables you to:

  • Use a Grafana dashboard to access metrics from all user clusters and admin clusters.
  • View metrics from individual user clusters on Grafana dashboards; the metrics are available for direct queries in full resolution.
  • Access user clusters' node-level and workload metrics for aggregated queries, dashboards and alerting (workload metrics are limited to workloads running in the kube-system namespace).
  • Configure alerts for specific clusters.