Monitor Your Kubernetes Cluster

Note

Studio’s monitoring capabilities have been superseded by this enhanced cluster monitoring solution.

Studio is not intended as a comprehensive monitoring solution and therefore lacks the features of similar third-party tools. SingleStore recommends exploring these supported third-party tools, which have been tested by SingleStore and are likely familiar to developers. These tools offer advanced features, improved performance, and specialized capabilities for managing complex database operations, and can provide increased efficiency and a smoother workflow.

Should you encounter any issues with these tools, or require further assistance, please contact SingleStore Support.

Overview

SingleStore’s native monitoring solution is designed to capture and reveal SingleStore cluster events over time. By analyzing this event data, you can identify trends and, if necessary, take action to remediate issues.

Terminology

Throughout this guide, the cluster that is being monitored is referred to as the Source cluster, and the cluster that stores the monitoring data is referred to as the Metrics cluster. The database that stores monitoring data is referred to as the metrics database.

High-Level Architecture

Cluster monitoring architecture graphic.

In SingleStore’s native monitoring solution, the Metrics cluster utilizes a SingleStore pipeline to pull the data from the exporter process on the Source cluster and store it in a database named metrics. Note that this metrics database can either reside within the same cluster as the Source cluster, or within a dedicated cluster.

When these event data is then analyzed through the provided Grafana dashboards, trends can be identified and, if necessary, actions taken to remediate issues.

The provided Grafana dashboards include:

Dashboard

Description

Cluster View

Provides a “bird's-eye view” of a single SingleStore cluster.

Detailed Cluster View by Node

Provides a view into resource utilization by node.

Historical Workload Monitoring

Statistics for parameterized query execution including run count, time spent, and resource utilization.

Memory Usage

Granular breakdown of memory use for a node.

Prerequisites

  • A SingleStore 7.3 or later cluster deployed via Kubernetes Operator to monitor (the Source cluster); SingleStore 8.5 or later to collect trace events.

  • Optional: A separate SingleStore 7.3 or later cluster deployed via a Kubernetes Operator used to collect monitoring data (the Metrics cluster); SingleStore 8.5 or later to collect trace events.

Monitoring License

If the size of the cluster that is hosting the monitoring data is 4 units or under, it can use a free tier license. If the size of the cluster is over 4 units, an enterprise license is required. Refer to the SingleStore Free Tier License Agreement for more information.

In this section

Last modified: November 7, 2024

Was this article helpful?