Scylla Documentation Logo Documentation
  • Server
    • Scylla Open Source
    • Scylla Enterprise
    • Scylla Alternator
  • Cloud
    • Scylla Cloud
    • Scylla Cloud Docs
  • Tools
    • Scylla Manager
    • Scylla Monitoring Stack
    • Scylla Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu
Scylla Cloud Getting Started with Scylla Cloud Get Started with Scylla Cloud on AWS Extract Cluster Metrics in Prometheus Format

Extract Cluster Metrics in Prometheus Format¶

ScyllaDB clusters collect and report metrics regarding their workloads and health. By default, the metrics are sent to the ScyllaDB Cloud Prometheus server, where they are monitored by the ScyllaDB Cloud team. The most important subset of these metrics is available on the ScyllaDB Cloud monitoring page in the ScyllaDB Cloud web UI.

In addition, you can use a Prometheus proxy to access your cluster metrics outside of the ScyllaDB Cloud service and monitor them with another tool. A Prometheus proxy allows you to extract data to an external third-party tool that reads the Prometheus format, such as Datadog.

This guide explains how to extract your cluster metrics and monitor them via the Scylla Monitoring 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. Instructions on transferring the metrics to Datadog are available in the following blog post.

Before You Begin¶

See the following documents before extracting your cluster metrics:

  • Scylla Monitoring Support Matrix

  • Calculating Prometheus Minimal Disk Space requirement

Extracting ScyllaDB Cluster Metrics¶

  1. Install the latest version of Scylla Monitor locally or on a remote machine.

  2. Start Scylla Monitor and validate it was installed successfully.

  3. 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.

  4. 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
    
  5. Navigate to the scylla-monitoring repository:

    cd scylla-monitoring
    
  6. Create a scylla-cloud.yaml file and add the Prometheus configuration file you received to it.

  7. 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
    
  8. Restart the scylla-monitoring service.

  9. Point your browser to the URL indicated to view your cluster metrics in Grafana.

Related Information¶

  • Scylla Monitor

  • Troubleshoot Scylla Monitor

PREVIOUS
Deploy Scylla Cloud - Bring Your Own Account
NEXT
AWS Virtual Private Network (VPC) Peering Setup Guide
  • About Scylla Cloud
  • Getting Started
    • Get Started with Scylla Cloud on AWS
      • Quick Start Guide to ScyllaDB Cloud on AWS
      • Deploy Scylla Cloud with Bring Your Own Account
      • Extract Cluster Metrics in Prometheus Format
      • Virtual Private Network (VPC) Peering Setup Guide
      • Run Managed Scylla Cloud Clusters on AWS Outposts
    • Get Started with Scylla Cloud on GCP
      • Quick Start Guide to ScyllaDB Cloud on GCP
      • VCP Peering Setup Guide
      • Extract Cluster Metrics in Prometheus format
    • ScyllaDB Cloud Best Practices
    • ScyllaDB Cloud Deployment Alternatives
    • ScyllaDB Cloud Sizing and Autoscale
    • Scylla Cloud Backups
    • Managing ScyllaDB Versions
    • Support, Alerts, and SLA Commitments
    • Costs
  • Using ScyllaDB
    • Apache Cassandra Query Language (CQL)
    • Scylla Drivers
    • Tracing
    • Role Based Access Control (RBAC)
    • Scylla Integrations
  • Scylla Cloud Security
    • Scylla Cloud Security Best Practice
    • Scylla Cloud Compliance
    • Scylla Cloud Security Concepts
  • Scylla Cloud Evaluation
  • Tutorials
  • Getting Help
    • ScyllaDB Cloud FAQ
  • Create an issue
  • Edit this page

On this page

  • Extract Cluster Metrics in Prometheus Format
    • Before You Begin
    • Extracting ScyllaDB Cluster Metrics
    • Related Information
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon
© 2022, ScyllaDB. All rights reserved.
Last updated on 13 May 2022.
Powered by Sphinx 4.3.2 & ScyllaDB Theme 1.2.1