ScyllaDB Monitoring overview¶

Architecture¶

ScyllaDB exposes its metrics in the Prometheus format. Scylla Operator provides the ScyllaDBMonitoring custom resource that allows you to set up a complete monitoring stack for your ScyllaDB clusters based on the following components:

• Prometheus for metrics collection and alerting (along with scraping and alerting rules targeting ScyllaDB instances).

• Grafana for metrics visualization (with pre-configured dashboards for ScyllaDB).

        flowchart BT

%% Styles
classDef scyllaVibe fill:#57d1e5,stroke:#4f5d75,color:#000;
classDef prometheusVibe fill:#e6512d,stroke:#ff9800,color:#fff;
classDef grafanaVibe fill:#f5a612,stroke:#ff9800,color:#fff;

%% Nodes
SC[ScyllaCluster]
class SC scyllaVibe

SDM[ScyllaDBMonitoring]
class SDM scyllaVibe

Prometheus
class Prometheus prometheusVibe

GrafanaDeployment
class GrafanaDeployment grafanaVibe

ServiceMonitor
class ServiceMonitor prometheusVibe

PrometheusRule
class PrometheusRule prometheusVibe

OtherGrafanaResources
class OtherGrafanaResources grafanaVibe

PrometheusOperator(Prometheus Operator)
class PrometheusOperator prometheusVibe

Operator(👷 Human Operator)

%% Grouping
subgraph K8sCluster[Kubernetes Cluster]
direction TB
MS
SC
PrometheusOperator
Prometheus
end
subgraph MS[Monitoring Stack]
SDM
subgraph PrometheusStack[Prometheus]
ServiceMonitor
PrometheusRule
end

subgraph GrafanaStack[Grafana]
direction LR
GrafanaDeployment[Deployment]
OtherGrafanaResources["`_Other objects..._`"]
end
end

%% Relationships between nodes
SDM -->|selects| SC
SDM -->|creates| PrometheusStack
SDM -->|creates| GrafanaStack
Prometheus -->|scrapes| SC

Operator -->|creates| Prometheus
Operator -->|creates| SDM

PrometheusOperator -->|reconciles| PrometheusStack
PrometheusOperator -->|reconciles| Prometheus
    

Prometheus¶

For deploying and/or configuring Prometheus, Scylla Operator relies on Prometheus Operator.

Scylla Operator supports two modes of operation for ScyllaDBMonitoring regarding Prometheus deployment: Managed and External. You can choose the mode that best fits your needs by setting the spec.components.prometheus.mode field in the ScyllaDBMonitoring resource.

Depending on the mode chosen, Scylla Operator may deploy and manage a Prometheus instance for you, or it can be configured to use an existing Prometheus instance (managed by the Prometheus Operator) in your cluster.

The following Prometheus Operator resources are created by Scylla Operator when you deploy a ScyllaDBMonitoring resource:

• Prometheus - the Prometheus instance itself (it may be omitted in External mode).

• ServiceMonitor - the resource that defines how to scrape metrics from ScyllaDB nodes.

• PrometheusRule - the resource that defines alerting rules for Prometheus.

The Prometheus version used in the deployment is tied to the version of Scylla Operator. You can find the exact version used in the config.yaml file under operator.prometheusVersion key.

Grafana¶

For deploying Grafana, Scylla Operator doesn’t use any third-party operator. Instead, it manages the Grafana deployment directly. It preconfigures Grafana with dashboards from scylla-monitoring.

The Grafana image used in the deployment is tied to the version of Scylla Operator. You can find the exact image used in the config.yaml file under operator.grafanaImage key.