Collecting database summary diagnostics

You can enable collecting database summary diagnostics using the DataStax Enterprise Performance Service.

These database summary diagnostic tables collect statistics at a database level:

node_table_snapshot

Per node lifetime table metrics broken down by keyspace and table.

table_snapshot

Cluster-wide lifetime table metrics broken down by keyspace and table (aggregates node_table_snapshot from each node in the cluster).

keyspace_snapshot

Cluster-wide lifetime table metrics, aggregated at the keyspace level (rolls up the data in table_snapshot).

Where is the dse.yaml file?

The location of the dse.yaml file depends on the type of installation:

Installation Type Location

Package installations + Installer-Services installations

/etc/dse/dse.yaml

Tarball installations + Installer-No Services installations

<installation_location>/resources/dse/conf/dse.yaml

Examples

These example commands make temporary changes only. Changes made with performance object subcommands do not persist between restarts and are useful only for short-term diagnostics.

To enable the collection of database-level statistics data:

shell
dsetool perf clustersummary enable

To disable the collection of database-level statistics data:

shell
dsetool perf clustersummary disable

To keep slow queries in-memory only:

shell
dsetool perf cqlslowlog skip_writing_to_db

To set the number of slow queries to keep in-memory:

shell
dsetool perf cqlslowlog set_num_slowest_queries 5

To write slow queries to the database:

shell
dsetool perf cqlslowlog write_to_db

To disable collecting information on slow queries:

shell
dsetool perf cqlslowlog disable

To change the threshold to collect information on 5% of the slowest queries:

shell
dsetool perf cqlslowlog 95.0

To enable collecting information to identify slow search queries:

shell
dsetool perf solrslowlog enable

Procedure

To permanently enable the collection of database-level statistics data:

  1. Edit the dse.yaml file.

  2. In the dse.yaml file, set the enabled option for db_summary_stats_options to true.

    no-highlight
    # Database summary stats options
    db_summary_stats_options:
        enabled: true
        refresh_rate_ms: 10000
  3. Optional: To control how often the statistics are refreshed, increase or decrease the refresh_rate_ms parameter.

    The refresh_rate_ms specifies the length of the sampling period, that is, the frequency with which this data is updated.

Example

To temporarily enable the collection of database-level statistics data:

shell
dsetool perf clustersummary enable

To temporarily disable the collection of database-level statistics data:

shell
dsetool perf clustersummary disable

Was this helpful?

Give Feedback

How can we improve the documentation?

© 2025 DataStax | Privacy policy | Terms of use | Manage Privacy Choices

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: +1 (650) 389-6000, info@datastax.com