Was this page helpful?
Extract Cluster Metrics in Prometheus Format¶
Available with the Professional plan and above
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.
Before You Begin¶
See the following documents before extracting your cluster metrics:
Extracting ScyllaDB 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.
Enable cluster metrics.
For a new cluster, enable the Extract cluster metrics option when creating your cluster.
For an existing cluster, choose Actions> Enable Cluster Metrics from the drop-down navigation bar or click Enable next to CLUSTER METRICS in your cluster’s view.
Click Setup next to CLUSTER METRICS to download the .yaml file with the cluster metrics. The content of the file may resemble the following:
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.comNavigate to the scylla-monitoring repository:
cd scylla-monitoring
Create a
scylla-cloud.yamlfile and add the Prometheus configuration file you received to it.Manually edit the
prometheus/prometheus.ymltemplate to add additional configuration settings from the scrape_configs ofscylla-cloud.yamlfile 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.
You can disable cluster metrics by choosing Actions> Disable Cluster Metrics from the drop-down navigation bar in your cluster’s view.