Menu
Grafana Cloud

Configure Kubernetes Monitoring with Grafana Kubernetes Monitoring Helm chart

Note

Configuration with the Grafana Kubernetes Monitoring Helm chart is recommended for use. However, you can also configure manually with Grafana Agent or Grafana Agent Operator.

To learn how the Helm chart configuration works, refer to Helm chart overview.

Before you begin

To deploy Kubernetes Monitoring with Grafana Kubernetes Monitoring Helm chart, you need:

  • The Admin role to install alerts
  • A Kubernetes Cluster, environment, or fleet you want to monitor
  • The kubectl and Helm command-line tools
  • Appropriate versions of items related to:
    • kube-state-metrics: Uses client-go to communicate with Clusters. For Kubernetes client-go version compatibility and any other related details, refer to kube-state-metrics.
    • OpenCost: Requires Kubernetes 1.8+ clusters.

Configuration process

Configuration of the Grafana Kubernetes Monitoring Helm chart includes the steps shown in the following diagram:

Steps of configuration process
Steps of configuration process

Send data from your account

Accessing your account to send data
Accessing your account to send data
  1. Go to your Grafana Cloud account, and click My Account.
  2. Select your stack.
  3. Click Details next to the name of your stack.
  4. At your stack page, click Launch to open Kubernetes Monitoring.
  5. Click Start sending data.

Kubernetes Monitoring displays the Settings tab of the Cluster configuration page.

Connect data sources

In the Data sources section of the Settings tab, select the data sources you want for Kubernetes Monitoring.

Data sources menu
Data sources menu

Install alert and recording rules

Scroll down to the Backend installation section, and click Install to install the preconfigured alerting and recording rules.

Follow the configuration process steps

Click the Cluster configuration tab, and complete each section of the instructions.

Prerequisites

Make sure you have met the prerequisites required for these configuration steps.

Select features and enter cluster information

  1. In the Cluster name box, enter the name of your Cluster.

  2. In the Namespace box, replace default with the namespace where you want to deploy your monitoring infrastructure.

  3. Select the platform you are using (for example, Kubernetes, OpenShift, EKS on Fargate, and so on).

    Section of quick configuration to select features, including platform and what to collect
    Options for platforms and data

  4. Switch on or off the data you want to collect, including:

    • Metrics
    • Cost metrics
    • Cluster events
    • Pod logs
    • OTLP receivers
    • Zipkin receiver
  5. Switch on or off whether you want to enable Application Observability for your Cluster.

    Caution

    If you enable Application Observability, this may affect your billing rate. Refer to Pricing for more details.
    Switch for enabling Application Observability
    Switch for enabling Application Observability

Use a Grafana.com Access Policy Token

You can create a new access policy token or use an existing token. Refer to Grafana Cloud Access Policies for more information.

To use an existing token:

  1. Click Use an existing token.

  2. Paste the token into the Access policy token name box.

To create a new token:

  1. Click Create a new token.

  2. In the box for Access Policy Token name, enter the name of your token.

  3. In the expiration date box, select an option for the expiration date.

    The permission scope for the token appears.

    Options for configuration, including expiration date
    Options for configuration, including expiration date

  4. Click Create token.

    The token generates and appears in the token box. This token is automatically copied into the ConfigMap file.

  5. Click the copy icon in the token box to copy the token. Make sure to save it in a secure place. It will not be shown again.

Deploy monitoring resources on the Cluster

Deploy the configuration using either the Helm client or Terraform.

Helm client

To use the Helm client to deploy the Kubernetes Monitoring Helm chart to the Cluster:

  1. Copy the command.

  2. Paste and run it in your terminal.

Terraform

To use Terraform to deploy the Kubernetes Monitoring Helm chart to the Cluster:

  1. Copy, modify, and save the following files to your Terraform system set up using Terraform:

    • provider.tf
    • grafana-k8s-monitoring.tf
    • vars.tf
  2. Deploy by using the commandsterraform init and terraform apply.

Configure application instrumentation

If you chose to include receivers in the Select features and enter cluster information section, a list of endpoints appear. In your application that generates metrics, logs, or traces, enter the appropriate OTLP or Zipkin address.

Endpoints available for configuration
Endpoints available for configuration

Check metrics status

Click the Metrics status tab to view the status of data collection. Your data becomes populated as the system components begin scraping and sending data to Grafana Cloud. This view shows the health of the different sources of metrics, Pod logs, and Cluster events, as well as any applicable version numbers.

Install any integrations

You can use Grafana integrations to monitor the health and status of services and applications running in your Kubernetes clusters.

To install a Kubernetes integration to begin scraping metrics:

  1. Click the Integrations tab.

  2. Select the integration for the service you want to monitor.

  3. Select your preferred deployment method (Helm Chart, Agent, or Agent Operator).

  4. Add the provided code snippet to the ConfigMap, or deploy the provided Operator Object. Make sure to replace any template fields with values specific to your service.

  5. Click Install integration. Installed integrations display a green checkmark on their tile.

If you want to use an integration not currently listed on the page, you can use embedded Agent exporters and integrations by configuring them manually. To learn how, refer to integrations_config.

Redeploy the configuration

After installing an integration, redeploy the configuration using the method you originally used.

Retrieve Helm values

If you installed Kubernetes Monitoring with the Helm CLI, you can retrieve the values for your configuration by using the helm get values command.