Skip to main content
Sumo Logic

Install the Kubernetes Control Plane App and view the Dashboards

This page provides instructions for installing the Kubernetes Control Plane App, as well as descriptions and examples for each of the dashboards. The app installation process consists of the following tasks:

  • Determining custom data filters for source categories
  • Installing the app

Step 1: Determine custom data filters for source categories

When you install the FluentD plugin and Prometheus, you supply custom data filters that match the source categories that the FluentD plugin generated for your Kubernetes logs and metrics. The plugin generates the source categories dynamically, and they can vary by environment.

To determine custom data filters for source categories, do the following:

  1. Run a query similar to the following in Sumo Logic to determine the source categories the plugin created. Use the hosted <Collector Name> you configured for Kubernetes.

_collector="<Collector Name>"

| count by _sourceCategory

You should see results similar to the following:

K8s_ControlPlane_source-categories.png

  1. Determine the custom data filters and source categories. The following table lists the sources created by the plugin in the left column. The Source Category column contains the source category you should configure for the sources when you install the app, or the source category that matches your environment based on the output of the query (from the previous step).
Source Source Category
Kube Control Manager Log Source *kube/controller/manager*
Kube-System Namespace Log Source *kube/system*
Kube etcd Log Source *etcd*
Kube API Server Log Source *kube/apiserver*

Step 2. Install the App

Now that you have set up collection for Kubernetes Control Plane, you can install the App and use the pre-configured searches and dashboards that provide insight into your data.

To install the App, do the following:

  1. Locate and install the app from the App Catalog. If you want to see a preview of the dashboards included with the app before installing, click Preview Dashboards.
  2. From the App Catalog, search for Kubernetes Control Plane and select the app.

  3. To install the app, click Add to Library. 

  4. Complete the following fields.

    1. App Name. You can retain the existing name, or enter a name of your choice for the app.


    2. Data Source.  For each the sources listed, enter a Custom Data Filter or Source Category, as follows:

    • For Kube Control Manager Log Source leave Source Category selected, and enter the following source category: *kube/controller/manager* or one that matches the source categories in your environment. 

    • For Kube-System Namespace Log Source leave Source Category selected, and enter the following source category: *kube/system* or one that matches the source categories in your environment.

    • For etcd Log Source leave Source Category selected, and enter the following source category: *etcd* or one that matches the source categories in your environment. 

    • For Kube API Server Log Source leave Source Category selected, and enter the following source category: *kube/apiserver* or one that matches the source categories in your environment.
    • For Container Log Source leave Source Category selected, and enter the following source category: *falco* or one that matches the source categories in your environment.
    1. Advanced. Select the location in the library (the default is the Personal folder in the library), or click New Folder to add a new folder.

  1. Click Add to Library.

Filter with template variables   

Template variables provide dynamic dashboards that can rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you view dynamic changes to the data for a quicker resolution to the root cause. For more information, see the Filter with template variables help page.

Kubernetes - Health Check Dashboard

The Kubernetes - Health Check dashboard displays collection status from all the components in the Kubernetes cluster.

Use this dashboard to:

  • Monitor the overall health of the integration of the master and worker nodes.
  • Monitor the endpoints for each of the components.
  • Check the active status and details of jobs.

K8s_CP_Health_Check.png

Kubernetes - API Server Dashboard

The Kubernetes - API Server dashboard displays information on the API server logs, which is the control plane component that exposes the Kubernetes API. Panels show details on the API server errors, warnings, and activities.

Use this dashboard to:

  • Monitor the health and performance of the API server.
  • Review server request rates.
  • Review server success and failure request rates.
  • Review client activity.
  • Review server errors for troubleshooting insights.

K8s_CP_API_Server.png

Kubernetes - Controller Manager Dashboard

The Kubernetes - Controller Manager dashboard displays information on the controller manager, providing visibility into the core control loops for Kubernetes.

Use this dashboard to:

  • Assess the overall status of the controller manager, along with pod and job creations and deletions, and cloud provider requests.
  • Review the details of scaling operations to monitor controller manager health.
  • Review the trends in event severities to assist with troubleshooting.
  • Get an overview of the number and types of errors, then dive deeper into their causes with the information provided in the error log stream.

 K8s_CP_Controller_Manager.png

Kubernetes - etcd Dashboard

The Kubernetes - etcd dashboard provides information on the health of etcd, the backing store for cluster data.

Use this dashboard to:

  • Get a high-level view of the health and performance of the etcd backing store for the cluster.
  • Review performance data for cache insertions and deletions, to determine if there any potential problems and proactively troubleshoot root cause solutions.

K8s_CP_etcd.png

Kubernetes  - Kube System Dashboard

The Kubernetes - Kube System dashboard provides insights into the health of the kube system, including details on resource utilization.

Use this dashboard to:

  • Get an overview of message breakdowns for system, container, and errors.
  • Review the details for the pods and containers in the kube system.
  • Analyze the details of the error stream to determine high severity problems and proactively troubleshoot root cause solutions.

K8s_CP_Kube_System.png

Kubernetes  - Scheduler Dashboard

The Kubernetes - Scheduler dashboard provides insights into the health of the scheduler.

Use this dashboard to:

  • Get an overview of scheduler health and status.
  • Review scheduler latency details.

 K8s_CP_Scheduler.png

Kubernetes  - Security Audit Events Dashboard

The Kubernetes - Security Audit Events dashboard provides insights into Kubernetes audit events collected by Falco.

Use this dashboard to:

  • Monitor Kubernetes audit events.
  • Identify and investigate unexpected or anomalous activity. 

K8s_CP_Security_Audit_Events.png