ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
    • ScyllaDB Open Source
    • ScyllaDB Enterprise
    • ScyllaDB Alternator
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu
ScyllaDB Docs ScyllaDB Cloud Monitoring Extract Cluster Metrics in Prometheus Format

Extract Cluster Metrics in Prometheus Format¶

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:

  • ScyllaDB Monitoring Support Matrix

  • Calculating Prometheus Minimal Disk Space Requirement

Extracting ScyllaDB Cluster Metrics¶

  1. Install the latest version of ScyllaDB Monitoring Stack locally or on a remote machine.

  2. Start ScyllaDB Monitoring Stack and validate it was installed successfully.

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

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

You can disable cluster metrics by choosing Actions> Disable Cluster Metrics from the drop-down navigation bar in your cluster’s view.

Related Information¶

  • ScyllaDB Monitoring Stack

  • Troubleshooting Guide for ScyllaDB Monitoring Stack

PREVIOUS
Monitoring
NEXT
ScyllaDB Cloud Security
ScyllaDB Cloud
  • New to ScyllaDB? Start here!
  • Quick Start Guide to ScyllaDB Cloud
  • About ScyllaDB Cloud as a Service
    • Benefits
    • Backups
    • Best Practices
    • Managing ScyllaDB Versions
    • Support, Alerts, and SLA Commitments
    • Costs
  • Deployment
    • Cloud Providers
    • Deploy ScyllaDB Cloud to Your Own AWS Account
    • AWS Virtual Private Network (VPC) Peering Setup Guide
    • GCP Virtual Private Network (VPC) Peering Setup Guide
    • Run Managed ScyllaDB Cloud Clusters on AWS Outposts
  • Managing Clusters
    • Maintenence Windows
    • Scaling a Cluster
    • Deleting a Cluster
  • Using ScyllaDB
    • Apache Cassandra Query Language (CQL)
    • ScyllaDB Drivers
    • Tracing
    • Role Based Access Control (RBAC)
    • ScyllaDB Integrations
  • Monitoring
    • Extracting Cluster Metrics
  • Security
    • ScyllaDB Cloud Security Best Practices
    • ScyllaDB Cloud Compliance
    • ScyllaDB Cloud Security Concepts
  • Serverless
  • Free Trial
  • Tutorials
  • API Documentation
    • Get Started with the ScyllaDB Cloud API
    • API Reference (BETA)
  • Terraform Provider
  • Getting Help
    • ScyllaDB Cloud FAQ
  • Create an issue

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 Forum Icon
© 2023, ScyllaDB. All rights reserved.
Last updated on 21 Mar 2023.
Powered by Sphinx 4.3.2 & ScyllaDB Theme 1.4.2