This guide explains how to extract your cluster metrics and monitor them via the ScyllaDB Monitoring Stack tool, which includes the Prometheus server in its stack. To use the metrics outside of ScyllaDB Cloud, you need to install the Prometheus server or use a third-party party tool that can read Prometheus output files. This blog post shows instructions on transferring the metrics to Datadog.
See the following documents before extracting your cluster metrics:
Install the latest version of ScyllaDB Monitoring Stack locally or on a remote machine.
Start ScyllaDB Monitoring Stack and validate it was installed successfully.
Send a request to enable extracting cluster metrics (the option is only available for production clusters). You can do this in one of the following ways:
When creating a new cluster, enable the Extract Cluster Metrics option.
When your cluster is already created, choose Actions> Extract Cluster Metrics in your cluster’s view.
In response to your request, you will receive a Prometheus configuration file. For example:
scrape_configs:
- job_name: scylla_cloud_cluster_2
scrape_interval: 15s
honor_labels: true
metrics_path: /api/v1/cluster/2/proxy/federate
params:
match[]:
- '{job=~".+"}'
bearer_token: SECRET_TOKEN
static_configs:
- targets:
- api.cloud.example.com
Navigate to the scylla-monitoring repository:
cd scylla-monitoring
Create a scylla-cloud.yaml file and add the Prometheus configuration file you received to it.
Manually edit the prometheus/prometheus.yml template to add additional configuration settings from the scrape_configs of scylla-cloud.yaml file you just saved.
Alternatively, use the yq tool to merge the two files using the following command:
yq merge -i -a prometheus/prometheus.yml.template ../scylla-cloud.yaml
Restart the scylla-monitoring service.
Point your browser to the URL indicated to view your cluster metrics in Grafana.